From fe0778d2763ab650452abdaa3c7a32aa80c24a63 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Wed, 30 Aug 2023 18:19:10 +0000 Subject: [PATCH] Update API model --- codegen/sdk-codegen/aws-models/appflow.json | 424 +- codegen/sdk-codegen/aws-models/apprunner.json | 356 +- .../sdk-codegen/aws-models/auditmanager.json | 428 +- .../sdk-codegen/aws-models/cleanrooms.json | 391 +- codegen/sdk-codegen/aws-models/datasync.json | 299 +- .../sdk-codegen/aws-models/neptunedata.json | 8032 +++++++++++++++++ .../aws-models/network-firewall.json | 374 +- .../aws-models/pca-connector-ad.json | 5686 ++++++++++++ codegen/sdk-codegen/aws-models/sagemaker.json | 63 +- 9 files changed, 15089 insertions(+), 964 deletions(-) create mode 100644 codegen/sdk-codegen/aws-models/neptunedata.json create mode 100644 codegen/sdk-codegen/aws-models/pca-connector-ad.json diff --git a/codegen/sdk-codegen/aws-models/appflow.json b/codegen/sdk-codegen/aws-models/appflow.json index 89a6e95c9a7..bdcabf08313 100644 --- a/codegen/sdk-codegen/aws-models/appflow.json +++ b/codegen/sdk-codegen/aws-models/appflow.json @@ -2193,6 +2193,9 @@ "target": "com.amazonaws.appflow#CreateFlowResponse" }, "errors": [ + { + "target": "com.amazonaws.appflow#AccessDeniedException" + }, { "target": "com.amazonaws.appflow#ConflictException" }, @@ -4155,6 +4158,18 @@ "traits": { "smithy.api#documentation": "

The number of records processed in the flow run.

" } + }, + "numParallelProcesses": { + "target": "com.amazonaws.appflow#Long", + "traits": { + "smithy.api#documentation": "

The number of processes that Amazon AppFlow ran at the same time when it retrieved\n your data.

" + } + }, + "maxPageSize": { + "target": "com.amazonaws.appflow#Long", + "traits": { + "smithy.api#documentation": "

The maximum number of records that Amazon AppFlow receives in each page of the\n response from your SAP application.

" + } } }, "traits": { @@ -7594,7 +7609,7 @@ "target": "com.amazonaws.appflow#Boolean", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "

If you set this parameter to true, Amazon AppFlow bypasses the single\n sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance.

\n

Whether you need this option depends on the types of credentials that you applied to \n your SAP OData connection profile. If your profile uses basic authentication credentials, SAP SSO\n can prevent Amazon AppFlow from connecting to your account with your username and\n password. In this case, bypassing SSO makes it possible for Amazon AppFlow to connect\n successfully. However, if your profile uses OAuth credentials, this parameter has no\n affect.

" + "smithy.api#documentation": "

If you set this parameter to true, Amazon AppFlow bypasses the single\n sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance.

\n

Whether you need this option depends on the types of credentials that you applied to your\n SAP OData connection profile. If your profile uses basic authentication credentials, SAP SSO\n can prevent Amazon AppFlow from connecting to your account with your username and\n password. In this case, bypassing SSO makes it possible for Amazon AppFlow to connect\n successfully. However, if your profile uses OAuth credentials, this parameter has no\n affect.

" } } }, @@ -7632,6 +7647,24 @@ "smithy.api#documentation": "

The properties that are applied when using SAPOData as a flow destination

" } }, + "com.amazonaws.appflow#SAPODataMaxPageSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.appflow#SAPODataMaxParallelism": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, "com.amazonaws.appflow#SAPODataMetadata": { "type": "structure", "members": {}, @@ -7639,6 +7672,36 @@ "smithy.api#documentation": "

The connector metadata specific to SAPOData.

" } }, + "com.amazonaws.appflow#SAPODataPaginationConfig": { + "type": "structure", + "members": { + "maxPageSize": { + "target": "com.amazonaws.appflow#SAPODataMaxPageSize", + "traits": { + "smithy.api#documentation": "

The maximum number of records that Amazon AppFlow receives in each page of the\n response from your SAP application. For transfers of OData records, the maximum page size is\n 3,000. For transfers of data that comes from an ODP provider, the maximum page size\n is 10,000.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Sets the page size for each concurrent process that transfers OData\n records from your SAP instance. A concurrent process is query that retrieves a batch of\n records as part of a flow run. Amazon AppFlow can run multiple concurrent processes in\n parallel to transfer data faster.

" + } + }, + "com.amazonaws.appflow#SAPODataParallelismConfig": { + "type": "structure", + "members": { + "maxParallelism": { + "target": "com.amazonaws.appflow#SAPODataMaxParallelism", + "traits": { + "smithy.api#documentation": "

The maximum number of processes that Amazon AppFlow runs at the same time when it\n retrieves your data from your SAP application.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Sets the number of concurrent processes that transfer OData records\n from your SAP instance. A concurrent process is query that retrieves a batch of records as\n part of a flow run. Amazon AppFlow can run multiple concurrent processes in parallel to\n transfer data faster.

" + } + }, "com.amazonaws.appflow#SAPODataSourceProperties": { "type": "structure", "members": { @@ -7647,6 +7710,18 @@ "traits": { "smithy.api#documentation": "

The object path specified in the SAPOData flow source.

" } + }, + "parallelismConfig": { + "target": "com.amazonaws.appflow#SAPODataParallelismConfig", + "traits": { + "smithy.api#documentation": "

Sets the number of concurrent processes that transfers OData records from your SAP\n instance.

" + } + }, + "paginationConfig": { + "target": "com.amazonaws.appflow#SAPODataPaginationConfig", + "traits": { + "smithy.api#documentation": "

Sets the page size for each concurrent process that transfers OData records from your SAP\n instance.

" + } } }, "traits": { @@ -8139,52 +8214,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -8192,13 +8271,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -8208,224 +8296,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://appflow-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://appflow-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://appflow-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://appflow-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://appflow.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://appflow.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://appflow.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://appflow.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -10964,6 +11003,9 @@ "target": "com.amazonaws.appflow#UpdateFlowResponse" }, "errors": [ + { + "target": "com.amazonaws.appflow#AccessDeniedException" + }, { "target": "com.amazonaws.appflow#ConflictException" }, diff --git a/codegen/sdk-codegen/aws-models/apprunner.json b/codegen/sdk-codegen/aws-models/apprunner.json index b9bc006621f..f5d51a34138 100644 --- a/codegen/sdk-codegen/aws-models/apprunner.json +++ b/codegen/sdk-codegen/aws-models/apprunner.json @@ -242,52 +242,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -295,13 +299,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -311,224 +324,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://apprunner-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://apprunner-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://apprunner-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://apprunner-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://apprunner.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://apprunner.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://apprunner.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://apprunner.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -1589,7 +1553,7 @@ } ], "traits": { - "smithy.api#documentation": "

Create an App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from\n certain third-party providers. You can share a connection across multiple services.

\n

A connection resource is needed to access GitHub repositories. GitHub requires a user interface approval process through the App Runner console before you\n can use the connection.

" + "smithy.api#documentation": "

Create an App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from\n certain third-party providers. You can share a connection across multiple services.

\n

A connection resource is needed to access GitHub and Bitbucket repositories. Both require\n a user interface approval process through the App Runner console before you can use the\n connection.

" } }, "com.amazonaws.apprunner#CreateConnectionRequest": { @@ -4208,6 +4172,12 @@ "traits": { "smithy.api#enumValue": "GITHUB" } + }, + "BITBUCKET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BITBUCKET" + } } } }, @@ -4478,7 +4448,7 @@ "Status": { "target": "com.amazonaws.apprunner#ServiceStatus", "traits": { - "smithy.api#documentation": "

The current state of the App Runner service. These particular values mean the following.

\n ", + "smithy.api#documentation": "

The current state of the App Runner service. These particular values mean the following.

\n ", "smithy.api#required": {} } }, @@ -4684,7 +4654,7 @@ "Status": { "target": "com.amazonaws.apprunner#ServiceStatus", "traits": { - "smithy.api#documentation": "

The current state of the App Runner service. These particular values mean the following.

\n " + "smithy.api#documentation": "

The current state of the App Runner service. These particular values mean the following.

\n " } } }, diff --git a/codegen/sdk-codegen/aws-models/auditmanager.json b/codegen/sdk-codegen/aws-models/auditmanager.json index 8a355823644..e6c1e11c66f 100644 --- a/codegen/sdk-codegen/aws-models/auditmanager.json +++ b/codegen/sdk-codegen/aws-models/auditmanager.json @@ -59,6 +59,9 @@ "type": "list", "member": { "target": "com.amazonaws.auditmanager#AWSAccount" + }, + "traits": { + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#AWSService": { @@ -210,7 +213,8 @@ "min": 0, "max": 1000 }, - "smithy.api#pattern": "^[\\w\\W\\s\\S]*$" + "smithy.api#pattern": "^[\\w\\W\\s\\S]*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#ActionPlanTitle": { @@ -220,7 +224,8 @@ "min": 0, "max": 300 }, - "smithy.api#pattern": "^[\\w\\W\\s\\S]*$" + "smithy.api#pattern": "^[\\w\\W\\s\\S]*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#Assessment": { @@ -402,7 +407,8 @@ "min": 0, "max": 1000 }, - "smithy.api#pattern": "^[\\w\\W\\s\\S]*$" + "smithy.api#pattern": "^[\\w\\W\\s\\S]*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#AssessmentEvidenceFolder": { @@ -572,7 +578,8 @@ } }, "traits": { - "smithy.api#documentation": "

The file used to structure and automate Audit Manager assessments for a given\n compliance standard.

" + "smithy.api#documentation": "

The file used to structure and automate Audit Manager assessments for a given\n compliance standard.

", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#AssessmentFrameworkDescription": { @@ -902,7 +909,8 @@ "min": 1, "max": 300 }, - "smithy.api#pattern": "^[^\\\\]*$" + "smithy.api#pattern": "^[^\\\\]*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#AssessmentReport": { @@ -974,7 +982,8 @@ "min": 0, "max": 1000 }, - "smithy.api#pattern": "^[\\w\\W\\s\\S]*$" + "smithy.api#pattern": "^[\\w\\W\\s\\S]*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#AssessmentReportDestinationType": { @@ -1126,7 +1135,8 @@ } }, "traits": { - "smithy.api#documentation": "

The location where Audit Manager saves assessment reports for the given\n assessment.

" + "smithy.api#documentation": "

The location where Audit Manager saves assessment reports for the given\n assessment.

", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#AssessmentReportsMetadata": { @@ -1365,6 +1375,9 @@ "type": "list", "member": { "target": "com.amazonaws.auditmanager#BatchCreateDelegationByAssessmentError" + }, + "traits": { + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#BatchCreateDelegationByAssessmentRequest": { @@ -1471,6 +1484,9 @@ "type": "list", "member": { "target": "com.amazonaws.auditmanager#BatchDeleteDelegationByAssessmentError" + }, + "traits": { + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#BatchDeleteDelegationByAssessmentRequest": { @@ -1975,52 +1991,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -2028,13 +2048,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -2044,224 +2073,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://auditmanager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://auditmanager-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://auditmanager-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://auditmanager-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://auditmanager.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://auditmanager.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://auditmanager.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://auditmanager.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -2788,7 +2768,8 @@ "min": 0, "max": 100 }, - "smithy.api#pattern": "^[\\w\\W\\s\\S]*$" + "smithy.api#pattern": "^[\\w\\W\\s\\S]*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#Control": { @@ -2922,7 +2903,8 @@ "min": 0, "max": 500 }, - "smithy.api#pattern": "^[\\w\\W\\s\\S]*$" + "smithy.api#pattern": "^[\\w\\W\\s\\S]*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#ControlComments": { @@ -3303,7 +3285,8 @@ "traits": { "smithy.api#length": { "min": 1 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#ControlSetsCount": { @@ -3903,7 +3886,8 @@ "smithy.api#length": { "min": 1, "max": 50 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#CreatedBy": { @@ -3913,7 +3897,8 @@ "min": 1, "max": 100 }, - "smithy.api#pattern": "^[a-zA-Z0-9\\s-_()\\[\\]]+$" + "smithy.api#pattern": "^[a-zA-Z0-9\\s-_()\\[\\]]+$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#DefaultExportDestination": { @@ -4007,7 +3992,8 @@ } }, "traits": { - "smithy.api#documentation": "

The assignment of a control set to a delegate for review.

" + "smithy.api#documentation": "

The assignment of a control set to a delegate for review.

", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#DelegationComment": { @@ -4017,7 +4003,8 @@ "min": 0, "max": 350 }, - "smithy.api#pattern": "^[\\w\\W\\s\\S]*$" + "smithy.api#pattern": "^[\\w\\W\\s\\S]*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#DelegationIds": { @@ -4606,7 +4593,8 @@ "min": 1, "max": 320 }, - "smithy.api#pattern": "^.*@.*$" + "smithy.api#pattern": "^.*@.*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#ErrorCode": { @@ -5762,7 +5750,8 @@ } }, "traits": { - "smithy.api#output": {} + "smithy.api#output": {}, + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#GetEvidenceFolder": { @@ -6545,7 +6534,8 @@ "min": 1, "max": 100 }, - "smithy.api#pattern": "^[a-zA-Z0-9\\s-_()\\[\\]]+$" + "smithy.api#pattern": "^[a-zA-Z0-9\\s-_()\\[\\]]+$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#ListAssessmentControlInsightsByControlDomain": { @@ -7565,7 +7555,8 @@ "min": 1, "max": 300 }, - "smithy.api#pattern": "^[^\\/]*$" + "smithy.api#pattern": "^[^\\/]*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#ManualEvidenceTextResponse": { @@ -7575,7 +7566,8 @@ "min": 1, "max": 1000 }, - "smithy.api#pattern": "^[\\w\\W\\s\\S]*$" + "smithy.api#pattern": "^[\\w\\W\\s\\S]*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#MaxResults": { @@ -7953,6 +7945,9 @@ "type": "list", "member": { "target": "com.amazonaws.auditmanager#Role" + }, + "traits": { + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#S3Url": { @@ -7972,7 +7967,8 @@ "min": 1, "max": 255 }, - "smithy.api#pattern": "^[a-zA-Z0-9-_\\(\\)\\[\\]]+$" + "smithy.api#pattern": "^[a-zA-Z0-9-_\\(\\)\\[\\]]+$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#Scope": { @@ -7992,7 +7988,8 @@ } }, "traits": { - "smithy.api#documentation": "

The wrapper that contains the Amazon Web Services accounts and services that are in\n scope for the assessment.

" + "smithy.api#documentation": "

The wrapper that contains the Amazon Web Services accounts and services that are in\n scope for the assessment.

", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#ServiceMetadata": { @@ -8588,7 +8585,8 @@ "min": 0, "max": 1000 }, - "smithy.api#pattern": "^[\\w\\W\\s\\S]*$" + "smithy.api#pattern": "^[\\w\\W\\s\\S]*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#ThrottlingException": { @@ -8637,7 +8635,8 @@ "min": 0, "max": 1000 }, - "smithy.api#pattern": "^[\\w\\W\\s\\S]*$" + "smithy.api#pattern": "^[\\w\\W\\s\\S]*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#URL": { @@ -9476,7 +9475,8 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "^[a-zA-Z0-9-_()\\s\\+=,.@]+$" + "smithy.api#pattern": "^[a-zA-Z0-9-_()\\s\\+=,.@]+$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#ValidateAssessmentReportIntegrity": { diff --git a/codegen/sdk-codegen/aws-models/cleanrooms.json b/codegen/sdk-codegen/aws-models/cleanrooms.json index dec49448b2c..cb3aac82da8 100644 --- a/codegen/sdk-codegen/aws-models/cleanrooms.json +++ b/codegen/sdk-codegen/aws-models/cleanrooms.json @@ -64,7 +64,7 @@ ], "maxAge": 86400 }, - "smithy.api#documentation": "

Welcome to the Clean Rooms API Reference.

\n

Clean Rooms is an Amazon Web Services service that helps multiple parties to join their data\n together in a secure collaboration workspace. In the collaboration, members who can query\n and receive results can get insights into the collective datasets without either party getting\n access to the other party's raw data.

\n

To learn more about Clean Rooms concepts, procedures, and best practices, see the\n Clean Rooms User Guide.

", + "smithy.api#documentation": "

Welcome to the Clean Rooms API Reference.

\n

Clean Rooms is an Amazon Web Services service that helps multiple parties to join\n their data together in a secure collaboration workspace. In the collaboration, members who\n can query and receive results can get insights into the collective datasets without either\n party getting access to the other party's raw data.

\n

To learn more about Clean Rooms concepts, procedures, and best practices, see the\n Clean Rooms User Guide.

\n

To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the\n Clean Rooms SQL Reference.

", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -424,53 +424,53 @@ "smithy.rules#endpointTests": { "testCases": [ { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://cleanrooms-fips.us-gov-east-1.api.aws" + "url": "https://cleanrooms-fips.us-east-1.api.aws" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cleanrooms-fips.us-gov-east-1.amazonaws.com" + "url": "https://cleanrooms-fips.us-east-1.amazonaws.com" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://cleanrooms.us-gov-east-1.api.aws" + "url": "https://cleanrooms.us-east-1.api.aws" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cleanrooms.us-gov-east-1.amazonaws.com" + "url": "https://cleanrooms.us-east-1.amazonaws.com" } }, "params": { - "Region": "us-gov-east-1", + "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } @@ -528,101 +528,101 @@ } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://cleanrooms-fips.us-gov-east-1.api.aws" + } }, "params": { - "Region": "us-iso-east-1", + "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cleanrooms-fips.us-iso-east-1.c2s.ic.gov" + "url": "https://cleanrooms-fips.us-gov-east-1.amazonaws.com" } }, "params": { - "Region": "us-iso-east-1", + "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" + "endpoint": { + "url": "https://cleanrooms.us-gov-east-1.api.aws" + } }, "params": { - "Region": "us-iso-east-1", + "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cleanrooms.us-iso-east-1.c2s.ic.gov" + "url": "https://cleanrooms.us-gov-east-1.amazonaws.com" } }, "params": { - "Region": "us-iso-east-1", + "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://cleanrooms-fips.us-east-1.api.aws" - } + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" }, "params": { - "Region": "us-east-1", + "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cleanrooms-fips.us-east-1.amazonaws.com" + "url": "https://cleanrooms-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "Region": "us-east-1", + "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", "expect": { - "endpoint": { - "url": "https://cleanrooms.us-east-1.api.aws" - } + "error": "DualStack is enabled but this partition does not support DualStack" }, "params": { - "Region": "us-east-1", + "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://cleanrooms.us-east-1.amazonaws.com" + "url": "https://cleanrooms.us-iso-east-1.c2s.ic.gov" } }, "params": { - "Region": "us-east-1", + "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } @@ -676,7 +676,7 @@ } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" @@ -689,6 +689,19 @@ "Endpoint": "https://example.com" } }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { @@ -712,6 +725,12 @@ "UseDualStack": true, "Endpoint": "https://example.com" } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } ], "version": "1.0" @@ -822,7 +841,7 @@ "columnName": { "target": "com.amazonaws.cleanrooms#AnalysisRuleColumnName", "traits": { - "smithy.api#documentation": "

Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.

", + "smithy.api#documentation": "

Column in aggregation constraint for which there must be a minimum number of distinct\n values in an output row for it to be in the query output.

", "smithy.api#required": {} } }, @@ -846,7 +865,7 @@ } }, "traits": { - "smithy.api#documentation": "

Constraint on query output removing output rows that do not meet a minimum number of distinct values of a specified column.

" + "smithy.api#documentation": "

Constraint on query output removing output rows that do not meet a minimum number of\n distinct values of a specified column.

" } }, "com.amazonaws.cleanrooms#AggregationConstraints": { @@ -891,7 +910,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 100 + "max": 225 } } }, @@ -923,7 +942,7 @@ "name": { "target": "com.amazonaws.cleanrooms#ParameterName", "traits": { - "smithy.api#documentation": "

The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-)\n characters but cannot start or end with a hyphen.

", + "smithy.api#documentation": "

The name of the parameter. The name must use only alphanumeric, underscore (_), or\n hyphen (-) characters but cannot start or end with a hyphen.

", "smithy.api#required": {} } }, @@ -1050,20 +1069,20 @@ "scalarFunctions": { "target": "com.amazonaws.cleanrooms#ScalarFunctionsList", "traits": { - "smithy.api#documentation": "

Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.

", + "smithy.api#documentation": "

Set of scalar functions that are allowed to be used on dimension columns and the output\n of aggregation of metrics.

", "smithy.api#required": {} } }, "outputConstraints": { "target": "com.amazonaws.cleanrooms#AggregationConstraints", "traits": { - "smithy.api#documentation": "

Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.

", + "smithy.api#documentation": "

Columns that must meet a specific threshold value (after an aggregation function is\n applied to it) for each output row to be returned.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A type of analysis rule that enables query structure and specified queries that produce aggregate statistics.

" + "smithy.api#documentation": "

A type of analysis rule that enables query structure and specified queries that produce\n aggregate statistics.

" } }, "com.amazonaws.cleanrooms#AnalysisRuleColumnList": { @@ -1112,7 +1131,7 @@ } }, "traits": { - "smithy.api#documentation": "

A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables.

" + "smithy.api#documentation": "

A type of analysis rule that enables the table owner to approve custom SQL queries on\n their configured tables.

" } }, "com.amazonaws.cleanrooms#AnalysisRuleList": { @@ -1121,7 +1140,7 @@ "joinColumns": { "target": "com.amazonaws.cleanrooms#AnalysisRuleColumnList", "traits": { - "smithy.api#documentation": "

Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.

", + "smithy.api#documentation": "

Columns that can be used to join a configured table with the table of the member who can\n query and other members' configured tables.

", "smithy.api#length": { "min": 1 }, @@ -1487,7 +1506,7 @@ "collaborationId": { "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis template summary belongs to.\n Currently accepts collaboration ID.

", "smithy.api#required": {} } }, @@ -1544,7 +1563,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to view details of multiple analysis tempaltes within a collaboration", - "smithy.api#documentation": "

Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).

", + "smithy.api#documentation": "

Retrieves multiple analysis templates within a collaboration by their Amazon Resource\n Names (ARNs).

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1579,7 +1598,7 @@ } }, "traits": { - "smithy.api#documentation": "

Details of errors thrown by the call to retrieve multiple analysis templates within a collaboration by their identifiers.

" + "smithy.api#documentation": "

Details of errors thrown by the call to retrieve multiple analysis templates within a\n collaboration by their identifiers.

" } }, "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateErrorList": { @@ -1599,7 +1618,7 @@ "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" @@ -1608,7 +1627,7 @@ "analysisTemplateArns": { "target": "com.amazonaws.cleanrooms#AnalysisTemplateArnList", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a\n collaboration.

", "smithy.api#required": {} } } @@ -1627,7 +1646,7 @@ "errors": { "target": "com.amazonaws.cleanrooms#BatchGetCollaborationAnalysisTemplateErrorList", "traits": { - "smithy.api#documentation": "

Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.

", + "smithy.api#documentation": "

Error reasons for collaboration analysis templates that could not be retrieved. One\n error is returned for every collaboration analysis template that could not be\n retrieved.

", "smithy.api#required": {} } } @@ -1779,7 +1798,7 @@ "name": { "target": "com.amazonaws.cleanrooms#CollaborationName", "traits": { - "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not unique.

", + "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not\n unique.

", "smithy.api#required": {} } }, @@ -1792,7 +1811,7 @@ "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -1851,7 +1870,7 @@ } }, "traits": { - "smithy.api#documentation": "

The multi-party data share environment. The collaboration contains metadata about its purpose and participants.

" + "smithy.api#documentation": "

The multi-party data share environment. The collaboration contains metadata about its\n purpose and participants.

" } }, "com.amazonaws.cleanrooms#CollaborationAnalysisTemplate": { @@ -1875,7 +1894,7 @@ "collaborationId": { "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.

", "smithy.api#required": {} } }, @@ -1895,7 +1914,7 @@ "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -1976,7 +1995,7 @@ "createTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time that the summary of the analysis template in a collaboration was created.

", + "smithy.api#documentation": "

The time that the summary of the analysis template in a collaboration was\n created.

", "smithy.api#required": {} } }, @@ -1997,7 +2016,7 @@ "updateTime": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "

The time that the summary of the analysis template in the collaboration was last updated.

", + "smithy.api#documentation": "

The time that the summary of the analysis template in the collaboration was last\n updated.

", "smithy.api#required": {} } }, @@ -2011,14 +2030,14 @@ "collaborationId": { "target": "com.amazonaws.cleanrooms#UUID", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.

", "smithy.api#required": {} } }, "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -2176,14 +2195,14 @@ "name": { "target": "com.amazonaws.cleanrooms#CollaborationName", "traits": { - "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not unique.

", + "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not\n unique.

", "smithy.api#required": {} } }, "creatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -2257,7 +2276,7 @@ } }, "traits": { - "smithy.api#documentation": "

A column within a schema relation, derived from the underlying Glue table.

" + "smithy.api#documentation": "

A column within a schema relation, derived from the underlying Glue\n table.

" } }, "com.amazonaws.cleanrooms#ColumnList": { @@ -2339,14 +2358,14 @@ "analysisRuleTypes": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleTypeList", "traits": { - "smithy.api#documentation": "

The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.

", + "smithy.api#documentation": "

The types of analysis rules associated with this configured table. Currently, only one\n analysis rule may be associated with a configured table.

", "smithy.api#required": {} } }, "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "

The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`.

", + "smithy.api#documentation": "

The analysis method for the configured table. The only valid value is currently\n `DIRECT_QUERY`.

", "smithy.api#required": {} } }, @@ -2410,7 +2429,7 @@ } }, "traits": { - "smithy.api#documentation": "

A configured table analysis rule, which limits how data for this table can be used.

" + "smithy.api#documentation": "

A configured table analysis rule, which limits how data for this table can be\n used.

" } }, "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRulePolicy": { @@ -2545,7 +2564,7 @@ "name": { "target": "com.amazonaws.cleanrooms#TableAlias", "traits": { - "smithy.api#documentation": "

The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.

", + "smithy.api#documentation": "

The name of the configured table association, in lowercase. The table is identified by\n this name when running protected queries against the underlying data.

", "smithy.api#required": {} } }, @@ -2657,7 +2676,7 @@ "name": { "target": "com.amazonaws.cleanrooms#TableAlias", "traits": { - "smithy.api#documentation": "

The name of the configured table association. The table is identified by this name when running Protected Queries against the underlying data.

", + "smithy.api#documentation": "

The name of the configured table association. The table is identified by this name when\n running Protected Queries against the underlying data.

", "smithy.api#required": {} } }, @@ -2807,7 +2826,7 @@ "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "

The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.

", + "smithy.api#documentation": "

The analysis method for the configured tables. The only valid value is currently\n `DIRECT_QUERY`.

", "smithy.api#required": {} } } @@ -2958,7 +2977,7 @@ "tags": { "target": "com.amazonaws.cleanrooms#TagMap", "traits": { - "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

" + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" } }, "analysisParameters": { @@ -3057,7 +3076,7 @@ "dataEncryptionMetadata": { "target": "com.amazonaws.cleanrooms#DataEncryptionMetadata", "traits": { - "smithy.api#documentation": "

The settings for client-side encryption with Cryptographic Computing for Clean Rooms.

" + "smithy.api#documentation": "

The settings for client-side encryption with Cryptographic Computing for Clean\n Rooms.

" } }, "queryLogStatus": { @@ -3070,7 +3089,7 @@ "tags": { "target": "com.amazonaws.cleanrooms#TagMap", "traits": { - "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access to this\n resource.

" + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" } } } @@ -3174,7 +3193,7 @@ "configuredTableIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID.

", + "smithy.api#documentation": "

The identifier for the configured table to create the analysis rule for. Currently\n accepts the configured table ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableId" @@ -3294,7 +3313,7 @@ "tags": { "target": "com.amazonaws.cleanrooms#TagMap", "traits": { - "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access to this\n resource.

" + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" } } } @@ -3337,21 +3356,21 @@ "allowedColumns": { "target": "com.amazonaws.cleanrooms#AllowedColumnList", "traits": { - "smithy.api#documentation": "

The columns of the underlying table that can be used by collaborations or analysis rules.

", + "smithy.api#documentation": "

The columns of the underlying table that can be used by collaborations or analysis\n rules.

", "smithy.api#required": {} } }, "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "

The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.

", + "smithy.api#documentation": "

The analysis method for the configured tables. The only valid value is currently\n `DIRECT_QUERY`.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.cleanrooms#TagMap", "traits": { - "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access to this\n resource.

" + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" } } } @@ -3429,7 +3448,13 @@ "tags": { "target": "com.amazonaws.cleanrooms#TagMap", "traits": { - "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access to this\n resource.

" + "smithy.api#documentation": "

An optional label that you can assign to a resource when you create it. Each tag\n consists of a key and an optional value, both of which you define. When you use tagging,\n you can also use tag-based access control in IAM policies to control access\n to this resource.

" + } + }, + "defaultResultConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration", + "traits": { + "smithy.api#documentation": "

The default\n protected query result configuration as specified by the member who can receive\n results.

" } } } @@ -3452,28 +3477,28 @@ "allowCleartext": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether encrypted tables can contain cleartext data (true) or are to cryptographically process every column (false).

", + "smithy.api#documentation": "

Indicates whether encrypted tables can contain cleartext data (true) or are to\n cryptographically process every column (false).

", "smithy.api#required": {} } }, "allowDuplicates": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether Fingerprint columns can contain duplicate entries (true) or are to contain only non-repeated values (false).

", + "smithy.api#documentation": "

Indicates whether Fingerprint columns can contain duplicate entries (true) or are to\n contain only non-repeated values (false).

", "smithy.api#required": {} } }, "allowJoinsOnColumnsWithDifferentNames": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (true) or can only be joined on Fingerprint columns of the same name (false).

", + "smithy.api#documentation": "

Indicates whether Fingerprint columns can be joined on any other Fingerprint column with\n a different name (true) or can only be joined on Fingerprint columns of the same name\n (false).

", "smithy.api#required": {} } }, "preserveNulls": { "target": "smithy.api#Boolean", "traits": { - "smithy.api#documentation": "

Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or cryptographically processed (false).

", + "smithy.api#documentation": "

Indicates whether NULL values are to be copied as NULL to encrypted tables (true) or\n cryptographically processed (false).

", "smithy.api#required": {} } } @@ -3689,7 +3714,7 @@ "analysisRuleType": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", "traits": { - "smithy.api#documentation": "

The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.

", + "smithy.api#documentation": "

The analysis rule type to be deleted. Configured table analysis rules are uniquely\n identified by their configured table identifier and analysis rule type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3748,7 +3773,7 @@ "configuredTableAssociationIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", "traits": { - "smithy.api#documentation": "

The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.

", + "smithy.api#documentation": "

The unique ID for the configured table association to be deleted. Currently accepts the\n configured table ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" @@ -4083,7 +4108,7 @@ "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" @@ -4092,7 +4117,7 @@ "analysisTemplateArn": { "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a\n collaboration.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "AnalysisTemplateArn" @@ -4216,7 +4241,7 @@ "configuredTableIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier for the configured table to retrieve. Currently accepts the configured table ID.

", + "smithy.api#documentation": "

The unique identifier for the configured table to retrieve. Currently accepts the\n configured table ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableId" @@ -4225,7 +4250,7 @@ "analysisRuleType": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", "traits": { - "smithy.api#documentation": "

The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.

", + "smithy.api#documentation": "

The analysis rule to be retrieved. Configured table analysis rules are uniquely\n identified by their configured table identifier and analysis rule type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4286,7 +4311,7 @@ "configuredTableAssociationIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", "traits": { - "smithy.api#documentation": "

The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.

", + "smithy.api#documentation": "

The unique ID for the configured table association to retrieve. Currently accepts the\n configured table ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" @@ -4568,7 +4593,7 @@ "type": { "target": "com.amazonaws.cleanrooms#AnalysisRuleType", "traits": { - "smithy.api#documentation": "

The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.

", + "smithy.api#documentation": "

The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely\n identified by a combination of the collaboration, the schema name, and their type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4714,7 +4739,11 @@ "com.amazonaws.cleanrooms#KeyPrefix": { "type": "string", "traits": { - "smithy.api#pattern": "^[\\w!.*/-]*$" + "smithy.api#length": { + "min": 0, + "max": 512 + }, + "smithy.api#pattern": "^[\\w!.=*/-]*$" } }, "com.amazonaws.cleanrooms#ListAnalysisTemplates": { @@ -4770,7 +4799,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4789,7 +4818,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, "analysisTemplateSummaries": { @@ -4846,7 +4875,7 @@ "collaborationIdentifier": { "target": "com.amazonaws.cleanrooms#CollaborationIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

", + "smithy.api#documentation": "

A unique identifier for the collaboration that the analysis templates belong to.\n Currently accepts collaboration ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "CollaborationId" @@ -4855,7 +4884,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4874,7 +4903,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, "collaborationAnalysisTemplateSummaries": { @@ -4928,7 +4957,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4954,7 +4983,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, "collaborationList": { @@ -5011,7 +5040,7 @@ "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID.

", + "smithy.api#documentation": "

A unique identifier for the membership to list configured table associations for.\n Currently accepts the membership ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5019,7 +5048,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -5045,7 +5074,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } } } @@ -5092,7 +5121,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -5118,7 +5147,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } } } @@ -5177,7 +5206,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -5196,7 +5225,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, "memberSummaries": { @@ -5250,7 +5279,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -5276,7 +5305,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, "membershipSummaries": { @@ -5351,7 +5380,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -5370,7 +5399,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } }, "protectedQueries": { @@ -5436,14 +5465,14 @@ "schemaType": { "target": "com.amazonaws.cleanrooms#SchemaType", "traits": { - "smithy.api#documentation": "

If present, filter schemas by schema type. The only valid schema type is currently `TABLE`.

", + "smithy.api#documentation": "

If present, filter schemas by schema type. The only valid schema type is currently\n `TABLE`.

", "smithy.api#httpQuery": "schemaType" } }, "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

", + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

", "smithy.api#httpQuery": "nextToken" } }, @@ -5469,7 +5498,7 @@ "nextToken": { "target": "com.amazonaws.cleanrooms#PaginationToken", "traits": { - "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of results.

" + "smithy.api#documentation": "

The token value retrieved from a previous call to access the next page of\n results.

" } } } @@ -5506,7 +5535,7 @@ "resourceArn": { "target": "com.amazonaws.cleanrooms#CleanroomsArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the resource you want to list tags on.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the resource you want to list tags\n on.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5582,7 +5611,7 @@ "accountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -5634,7 +5663,7 @@ "accountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {}, "smithy.api#resourceIdentifier": "AccountId" } @@ -5642,7 +5671,7 @@ "status": { "target": "com.amazonaws.cleanrooms#MemberStatus", "traits": { - "smithy.api#documentation": "

The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and `REMOVED`.

", + "smithy.api#documentation": "

The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and\n `REMOVED`.

", "smithy.api#required": {} } }, @@ -5732,7 +5761,7 @@ "collaborationCreatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier used to reference members of the collaboration. Currently only supports\n Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -5767,7 +5796,7 @@ "status": { "target": "com.amazonaws.cleanrooms#MembershipStatus", "traits": { - "smithy.api#documentation": "

The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.

", + "smithy.api#documentation": "

The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and\n `COLLABORATION_DELETED`.

", "smithy.api#required": {} } }, @@ -5784,6 +5813,12 @@ "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n collaboration.

", "smithy.api#required": {} } + }, + "defaultResultConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration", + "traits": { + "smithy.api#documentation": "

The default\n protected query result configuration as specified by the member who can receive\n results.

" + } } }, "traits": { @@ -5809,6 +5844,38 @@ "smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" } }, + "com.amazonaws.cleanrooms#MembershipProtectedQueryOutputConfiguration": { + "type": "union", + "members": { + "s3": { + "target": "com.amazonaws.cleanrooms#ProtectedQueryS3OutputConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

Contains\n configurations for protected query results.

" + } + }, + "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration": { + "type": "structure", + "members": { + "outputConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryOutputConfiguration", + "traits": { + "smithy.api#documentation": "

Configuration for\n protected query results.

", + "smithy.api#required": {} + } + }, + "roleArn": { + "target": "com.amazonaws.cleanrooms#RoleArn", + "traits": { + "smithy.api#documentation": "

The unique ARN for\n an IAM role that is used by Clean Rooms to write protected query results to the\n result location, given by the member who can receive results.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains\n configurations for protected query results.

" + } + }, "com.amazonaws.cleanrooms#MembershipQueryLogStatus": { "type": "string", "traits": { @@ -5925,7 +5992,7 @@ "collaborationCreatorAccountId": { "target": "com.amazonaws.cleanrooms#AccountId", "traits": { - "smithy.api#documentation": "

The identifier of the Amazon Web Services principal that created the collaboration. Currently only supports Amazon Web Services account ID.

", + "smithy.api#documentation": "

The identifier of the Amazon Web Services principal that created the collaboration. Currently only\n supports Amazon Web Services account ID.

", "smithy.api#required": {} } }, @@ -5960,7 +6027,7 @@ "status": { "target": "com.amazonaws.cleanrooms#MembershipStatus", "traits": { - "smithy.api#documentation": "

The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.

", + "smithy.api#documentation": "

The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and\n `COLLABORATION_DELETED`.

", "smithy.api#required": {} } }, @@ -6148,8 +6215,7 @@ "sqlParameters": { "target": "com.amazonaws.cleanrooms#ProtectedQuerySQLParameters", "traits": { - "smithy.api#documentation": "

The protected query SQL parameters.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The protected query SQL parameters.

" } }, "status": { @@ -6162,8 +6228,7 @@ "resultConfiguration": { "target": "com.amazonaws.cleanrooms#ProtectedQueryResultConfiguration", "traits": { - "smithy.api#documentation": "

Contains any details needed to write the query results.

", - "smithy.api#required": {} + "smithy.api#documentation": "

Contains any details needed to write the query results.

" } }, "statistics": { @@ -6186,7 +6251,7 @@ } }, "traits": { - "smithy.api#documentation": "

The parameters for an Clean Rooms protected query.

" + "smithy.api#documentation": "

The parameters for an Clean Rooms protected query.

" } }, "com.amazonaws.cleanrooms#ProtectedQueryError": { @@ -6221,6 +6286,12 @@ "smithy.api#pattern": "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" } }, + "com.amazonaws.cleanrooms#ProtectedQueryMemberOutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.cleanrooms#ProtectedQuerySingleMemberOutput" + } + }, "com.amazonaws.cleanrooms#ProtectedQueryOutput": { "type": "union", "members": { @@ -6229,6 +6300,12 @@ "traits": { "smithy.api#documentation": "

If present, the output for a protected query with an `S3` output type.

" } + }, + "memberList": { + "target": "com.amazonaws.cleanrooms#ProtectedQueryMemberOutputList", + "traits": { + "smithy.api#documentation": "

The list of member\n Amazon Web Services account(s) that received the results of the query.

" + } } }, "traits": { @@ -6342,7 +6419,7 @@ "analysisTemplateArn": { "target": "com.amazonaws.cleanrooms#AnalysisTemplateArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the analysis template within a\n collaboration.

" } }, "parameters": { @@ -6357,6 +6434,21 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.cleanrooms#ProtectedQuerySingleMemberOutput": { + "type": "structure", + "members": { + "accountId": { + "target": "com.amazonaws.cleanrooms#AccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account\n ID of the member in the collaboration who can receive results for the\n query.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Details about the\n member who received the query result.

" + } + }, "com.amazonaws.cleanrooms#ProtectedQueryStatistics": { "type": "structure", "members": { @@ -6441,7 +6533,7 @@ "status": { "target": "com.amazonaws.cleanrooms#ProtectedQueryStatus", "traits": { - "smithy.api#documentation": "

The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`, `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.

", + "smithy.api#documentation": "

The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`,\n `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.

", "smithy.api#required": {} } } @@ -6654,7 +6746,7 @@ "analysisRuleTypes": { "target": "com.amazonaws.cleanrooms#AnalysisRuleTypeList", "traits": { - "smithy.api#documentation": "

The analysis rule types associated with the schema. Currently, only one entry is present.

", + "smithy.api#documentation": "

The analysis rule types associated with the schema. Currently, only one entry is\n present.

", "smithy.api#required": {} } }, @@ -6674,7 +6766,7 @@ "name": { "target": "com.amazonaws.cleanrooms#TableAlias", "traits": { - "smithy.api#documentation": "

A name for the schema. The schema relation is referred to by this name when queried by a protected query.

", + "smithy.api#documentation": "

A name for the schema. The schema relation is referred to by this name when queried by a\n protected query.

", "smithy.api#required": {} } }, @@ -6799,7 +6891,7 @@ "analysisMethod": { "target": "com.amazonaws.cleanrooms#AnalysisMethod", "traits": { - "smithy.api#documentation": "

The analysis method for the associated schema. The only valid value is currently `DIRECT_QUERY`.

" + "smithy.api#documentation": "

The analysis method for the associated schema. The only valid value is currently\n `DIRECT_QUERY`.

" } } }, @@ -6884,7 +6976,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to start protected queries", - "smithy.api#documentation": "

Creates a protected query that is started by Clean Rooms .

", + "smithy.api#documentation": "

Creates a protected query that is started by Clean Rooms.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -6905,7 +6997,7 @@ "membershipIdentifier": { "target": "com.amazonaws.cleanrooms#MembershipIdentifier", "traits": { - "smithy.api#documentation": "

A unique identifier for the membership to run this query against. Currently accepts a membership ID.

", + "smithy.api#documentation": "

A unique identifier for the membership to run this query against. Currently accepts a\n membership ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "MembershipId" @@ -6921,8 +7013,7 @@ "resultConfiguration": { "target": "com.amazonaws.cleanrooms#ProtectedQueryResultConfiguration", "traits": { - "smithy.api#documentation": "

The details needed to write the query results.

", - "smithy.api#required": {} + "smithy.api#documentation": "

The details needed to write the query results.

" } } } @@ -6980,7 +7071,7 @@ } }, "traits": { - "smithy.api#documentation": "

A pointer to the dataset that underlies this table. Currently, this can only be an Glue table.

" + "smithy.api#documentation": "

A pointer to the dataset that underlies this table. Currently, this can only be an Glue\n table.

" } }, "com.amazonaws.cleanrooms#TagKey": { @@ -7150,7 +7241,7 @@ "resourceArn": { "target": "com.amazonaws.cleanrooms#CleanroomsArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.

", + "smithy.api#documentation": "

The Amazon Resource Name (ARN) associated with the resource you want to remove the tag\n from.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7298,7 +7389,7 @@ "name": { "target": "com.amazonaws.cleanrooms#CollaborationName", "traits": { - "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not unique.

" + "smithy.api#documentation": "

A human-readable identifier provided by the collaboration owner. Display names are not\n unique.

" } }, "description": { @@ -7412,7 +7503,7 @@ "analysisRuleType": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAnalysisRuleType", "traits": { - "smithy.api#documentation": "

The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.

", + "smithy.api#documentation": "

The analysis rule type to be updated. Configured table analysis rules are uniquely\n identified by their configured table identifier and analysis rule type.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7485,7 +7576,7 @@ "configuredTableAssociationIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableAssociationIdentifier", "traits": { - "smithy.api#documentation": "

The unique identifier for the configured table association to update. Currently accepts the configured table association ID.

", + "smithy.api#documentation": "

The unique identifier for the configured table association to update. Currently accepts\n the configured table association ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableAssociationId" @@ -7532,7 +7623,7 @@ "configuredTableIdentifier": { "target": "com.amazonaws.cleanrooms#ConfiguredTableIdentifier", "traits": { - "smithy.api#documentation": "

The identifier for the configured table to update. Currently accepts the configured table ID.

", + "smithy.api#documentation": "

The identifier for the configured table to update. Currently accepts the configured\n table ID.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "ConfiguredTableId" @@ -7619,6 +7710,12 @@ "traits": { "smithy.api#documentation": "

An indicator as to whether query logging has been enabled or disabled for the\n collaboration.

" } + }, + "defaultResultConfiguration": { + "target": "com.amazonaws.cleanrooms#MembershipProtectedQueryResultConfiguration", + "traits": { + "smithy.api#documentation": "

The default\n protected query result configuration as specified by the member who can receive\n results.

" + } } } }, @@ -7695,7 +7792,7 @@ "targetStatus": { "target": "com.amazonaws.cleanrooms#TargetProtectedQueryStatus", "traits": { - "smithy.api#documentation": "

The target status of a query. Used to update the execution status of a currently running query.

", + "smithy.api#documentation": "

The target status of a query. Used to update the execution status of a currently running\n query.

", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/datasync.json b/codegen/sdk-codegen/aws-models/datasync.json index d054e08b252..2cde9b70a89 100644 --- a/codegen/sdk-codegen/aws-models/datasync.json +++ b/codegen/sdk-codegen/aws-models/datasync.json @@ -277,7 +277,7 @@ "Token": { "target": "com.amazonaws.datasync#AzureBlobSasToken", "traits": { - "smithy.api#documentation": "

Specifies a SAS token that provides permissions at the Azure storage account, container,\n or folder level.

\n

The token is part of the SAS URI string that comes after the storage resource URI and a question mark. A token looks something like this:

\n

\n sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D\n

", + "smithy.api#documentation": "

Specifies a SAS token that provides permissions to access your Azure Blob Storage.

\n

The token is part of the SAS URI string that comes after the storage resource URI and a question mark. A token looks something like this:

\n

\n sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D\n

", "smithy.api#required": {} } } @@ -1479,7 +1479,7 @@ } ], "traits": { - "smithy.api#documentation": "

Configures a task, which defines where and how DataSync transfers your\n data.

\n

A task includes a source location, a destination location, and the preferences for how and\n when you want to transfer your data (such as bandwidth limits, scheduling, among other\n options).

\n \n

If you're planning to transfer data to or from an Amazon S3 location, review\n how\n DataSync can affect your S3 request charges and the DataSync pricing page before\n you begin.

\n " + "smithy.api#documentation": "

Configures a transfer task, which defines where and how DataSync moves your\n data.

\n

A task includes a source location, destination location, and the options for how and\n when you want to transfer your data (such as bandwidth limits, scheduling, among other\n options).

\n \n

If you're planning to transfer data to or from an Amazon S3 location, review\n how\n DataSync can affect your S3 request charges and the DataSync pricing page before\n you begin.

\n " } }, "com.amazonaws.datasync#CreateTaskRequest": { @@ -1540,6 +1540,12 @@ "traits": { "smithy.api#documentation": "

Specifies a list of filter rules that include specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.

" } + }, + "TaskReportConfig": { + "target": "com.amazonaws.datasync#TaskReportConfig", + "traits": { + "smithy.api#documentation": "

Specifies how you want to configure a task report, which provides detailed information\n about for your DataSync transfer.

" + } } }, "traits": { @@ -1687,7 +1693,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an DataSync task.

" + "smithy.api#documentation": "

Deletes an DataSync transfer task.

" } }, "com.amazonaws.datasync#DeleteTaskRequest": { @@ -3136,7 +3142,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides information about an DataSync transfer task that's\n running.

" + "smithy.api#documentation": "

Provides information about an execution of your DataSync task. You can\n use this operation to help monitor the progress of an ongoing transfer or check the results of\n the transfer.

" } }, "com.amazonaws.datasync#DescribeTaskExecutionRequest": { @@ -3145,7 +3151,7 @@ "TaskExecutionArn": { "target": "com.amazonaws.datasync#TaskExecutionArn", "traits": { - "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the transfer task that's running.

", + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the task execution that you want\n information about.

", "smithy.api#required": {} } } @@ -3161,13 +3167,13 @@ "TaskExecutionArn": { "target": "com.amazonaws.datasync#TaskExecutionArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the task execution that was described.\n TaskExecutionArn is hierarchical and includes TaskArn for the task\n that was executed.

\n

For example, a TaskExecution value with the ARN\n arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b\n executed the task with the ARN\n arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

" + "smithy.api#documentation": "

The ARN of the task execution that you wanted information about.\n TaskExecutionArn is hierarchical and includes TaskArn for the task\n that was executed.

\n

For example, a TaskExecution value with the ARN\n arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b\n executed the task with the ARN\n arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

" } }, "Status": { "target": "com.amazonaws.datasync#TaskExecutionStatus", "traits": { - "smithy.api#documentation": "

The status of the task execution.

\n

For detailed information about task execution statuses, see Understanding\n Task Statuses in the DataSync User Guide.\n

" + "smithy.api#documentation": "

The status of the task execution.

" } }, "Options": { @@ -3188,35 +3194,35 @@ "StartTime": { "target": "com.amazonaws.datasync#Time", "traits": { - "smithy.api#documentation": "

The time that the task execution was started.

" + "smithy.api#documentation": "

The time when the task execution started.

" } }, "EstimatedFilesToTransfer": { "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The expected number of files that is to be transferred over the network. This value is\n calculated during the PREPARING phase before the TRANSFERRING phase\n of the task execution. This value is the expected number of files to be transferred. It's\n calculated based on comparing the content of the source and destination locations and finding\n the delta that needs to be transferred.

" + "smithy.api#documentation": "

The expected number of files, objects, and directories that DataSync will\n transfer over the network. This value is calculated during the task execution's\n PREPARING phase before the TRANSFERRING phase. The calculation is\n based on comparing the content of the source and destination locations and finding the\n difference that needs to be transferred.

" } }, "EstimatedBytesToTransfer": { "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The estimated physical number of bytes that is to be transferred over the\n network.

" + "smithy.api#documentation": "

The estimated physical number of bytes that will transfer over the network.

" } }, "FilesTransferred": { "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The actual number of files that was transferred over the network. This value is\n calculated and updated on an ongoing basis during the TRANSFERRING phase of the\n task execution. It's updated periodically when each file is read from the source and sent over\n the network.

\n

If failures occur during a transfer, this value can be less than\n EstimatedFilesToTransfer. In some cases, this value can also be greater than\n EstimatedFilesToTransfer. This element is implementation-specific for some\n location types, so don't use it as an indicator for a correct file number or to monitor your\n task execution.

" + "smithy.api#documentation": "

The actual number of files, objects, and directories that DataSync\n transferred over the network. This value is updated periodically during the task execution's\n TRANSFERRING phase when something is read from the source and sent over the\n network.

\n

If DataSync fails to transfer something, this value can be less than\n EstimatedFilesToTransfer. In some cases, this value can also be greater than\n EstimatedFilesToTransfer. This element is implementation-specific for some\n location types, so don't use it as an exact indication of what transferred or to monitor your task execution.

" } }, "BytesWritten": { "target": "com.amazonaws.datasync#long", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The number of logical bytes written to the destination Amazon Web Services storage\n resource.

" + "smithy.api#documentation": "

The number of logical bytes written to the destination location.

" } }, "BytesTransferred": { @@ -3238,6 +3244,46 @@ "smithy.api#default": 0, "smithy.api#documentation": "

The physical number of bytes transferred over the network after compression was applied.\n In most cases, this number is less than BytesTransferred unless the data isn't\n compressible.

" } + }, + "TaskReportConfig": { + "target": "com.amazonaws.datasync#TaskReportConfig", + "traits": { + "smithy.api#documentation": "

The configuration of your task report, which provides detailed information about for your DataSync transfer.

" + } + }, + "FilesDeleted": { + "target": "com.amazonaws.datasync#long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of files, objects, and directories that DataSync deleted in your\n destination location. If you don't configure your task to\n delete data in the destination that isn't in the source, the value is always\n 0.

" + } + }, + "FilesSkipped": { + "target": "com.amazonaws.datasync#long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of files, objects, and directories that DataSync skipped during your\n transfer.

" + } + }, + "FilesVerified": { + "target": "com.amazonaws.datasync#long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of files, objects, and directories that DataSync verified during your\n transfer.

" + } + }, + "ReportResult": { + "target": "com.amazonaws.datasync#ReportResult", + "traits": { + "smithy.api#documentation": "

Indicates whether DataSync generated a complete task report for your\n transfer.

" + } + }, + "EstimatedFilesToDelete": { + "target": "com.amazonaws.datasync#long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The expected number of files, objects, and directories that DataSync will delete\n in your destination location. If you don't configure your task to\n delete data in the destination that isn't in the source, the value is always\n 0.

" + } } }, "traits": { @@ -3359,6 +3405,12 @@ "traits": { "smithy.api#documentation": "

A list of filter rules that include specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.

" } + }, + "TaskReportConfig": { + "target": "com.amazonaws.datasync#TaskReportConfig", + "traits": { + "smithy.api#documentation": "

The configuration of your task report. For more information, see Creating a task report.

" + } } }, "traits": { @@ -6733,6 +6785,23 @@ } } }, + "com.amazonaws.datasync#ObjectVersionIds": { + "type": "enum", + "members": { + "INCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUDE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, "com.amazonaws.datasync#OnPremConfig": { "type": "structure", "members": { @@ -6908,7 +6977,7 @@ } }, "traits": { - "smithy.api#documentation": "

Configures your DataSync task settings. These options include how DataSync handles files, objects, and their associated metadata. You also can specify how\n DataSync verifies data integrity, set bandwidth limits for your task, among other\n options.

\n

Each task setting has a default value. Unless you need to, you don't have to configure\n any of these Options before starting your task.

" + "smithy.api#documentation": "

Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You\n also can specify how to verify data integrity, set bandwidth limits for your task, among other\n options.

\n

Each option has a default value. Unless you need to, you don't have to configure any of\n these options before starting your task.

" } }, "com.amazonaws.datasync#OutputTagList": { @@ -7275,6 +7344,154 @@ "smithy.api#output": {} } }, + "com.amazonaws.datasync#ReportDestination": { + "type": "structure", + "members": { + "S3": { + "target": "com.amazonaws.datasync#ReportDestinationS3", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 bucket where DataSync uploads your task report.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies where DataSync uploads your task report.

" + } + }, + "com.amazonaws.datasync#ReportDestinationS3": { + "type": "structure", + "members": { + "Subdirectory": { + "target": "com.amazonaws.datasync#S3Subdirectory", + "traits": { + "smithy.api#documentation": "

Specifies a bucket prefix for your report.

" + } + }, + "S3BucketArn": { + "target": "com.amazonaws.datasync#S3BucketArn", + "traits": { + "smithy.api#documentation": "

Specifies the ARN of the S3 bucket where DataSync uploads your report.

", + "smithy.api#required": {} + } + }, + "BucketAccessRoleArn": { + "target": "com.amazonaws.datasync#IamRoleArn", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket. For more information, see Allowing DataSync to upload a task report to an Amazon S3 bucket.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 bucket where DataSync uploads your task report.

" + } + }, + "com.amazonaws.datasync#ReportLevel": { + "type": "enum", + "members": { + "ERRORS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERRORS_ONLY" + } + }, + "SUCCESSES_AND_ERRORS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESSES_AND_ERRORS" + } + } + } + }, + "com.amazonaws.datasync#ReportOutputType": { + "type": "enum", + "members": { + "SUMMARY_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUMMARY_ONLY" + } + }, + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + } + } + }, + "com.amazonaws.datasync#ReportOverride": { + "type": "structure", + "members": { + "ReportLevel": { + "target": "com.amazonaws.datasync#ReportLevel", + "traits": { + "smithy.api#documentation": "

Specifies whether your task report includes errors only or successes and errors.

\n

For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the level of detail for a particular aspect of your DataSync\n task\n report.

" + } + }, + "com.amazonaws.datasync#ReportOverrides": { + "type": "structure", + "members": { + "Transferred": { + "target": "com.amazonaws.datasync#ReportOverride", + "traits": { + "smithy.api#documentation": "

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer.

" + } + }, + "Verified": { + "target": "com.amazonaws.datasync#ReportOverride", + "traits": { + "smithy.api#documentation": "

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer. This only applies if you configure your task to verify data during and after the transfer (which DataSync does by default).

" + } + }, + "Deleted": { + "target": "com.amazonaws.datasync#ReportOverride", + "traits": { + "smithy.api#documentation": "

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.

" + } + }, + "Skipped": { + "target": "com.amazonaws.datasync#ReportOverride", + "traits": { + "smithy.api#documentation": "

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The level of detail included in each aspect of your DataSync\n task\n report.

" + } + }, + "com.amazonaws.datasync#ReportResult": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.datasync#PhaseStatus", + "traits": { + "smithy.api#documentation": "

Indicates whether DataSync is still working on your report, created a report, or\n can't create a complete report.

" + } + }, + "ErrorCode": { + "target": "com.amazonaws.datasync#string", + "traits": { + "smithy.api#documentation": "

Indicates the code associated with the error if DataSync can't create a complete\n report.

" + } + }, + "ErrorDetail": { + "target": "com.amazonaws.datasync#string", + "traits": { + "smithy.api#documentation": "

Provides details about issues creating a report.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Indicates whether DataSync created a complete task report for your\n transfer.

" + } + }, "com.amazonaws.datasync#ResourceDetails": { "type": "structure", "members": { @@ -7693,7 +7910,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts an DataSync task. For each task, you can only run one task execution\n at a time.

\n

There are several phases to a task execution. For more information, see Task execution statuses.

\n \n

If you're planning to transfer data to or from an Amazon S3 location, review\n how\n DataSync can affect your S3 request charges and the DataSync pricing page before\n you begin.

\n " + "smithy.api#documentation": "

Starts an DataSync transfer task. For each task, you can only run one task\n execution at a time.

\n

There are several phases to a task execution. For more information, see Task execution statuses.

\n \n

If you're planning to transfer data to or from an Amazon S3 location, review\n how\n DataSync can affect your S3 request charges and the DataSync pricing page before\n you begin.

\n " } }, "com.amazonaws.datasync#StartTaskExecutionRequest": { @@ -7726,6 +7943,12 @@ "traits": { "smithy.api#documentation": "

Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing\n the task execution.

\n

\n Tags are key-value pairs that help you manage, filter, and search for\n your DataSync resources.

" } + }, + "TaskReportConfig": { + "target": "com.amazonaws.datasync#TaskReportConfig", + "traits": { + "smithy.api#documentation": "

Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.

" + } } }, "traits": { @@ -8231,6 +8454,44 @@ } } }, + "com.amazonaws.datasync#TaskReportConfig": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.datasync#ReportDestination", + "traits": { + "smithy.api#documentation": "

Specifies the Amazon S3 bucket where DataSync uploads your task report. For more\n information, see Task reports.

" + } + }, + "OutputType": { + "target": "com.amazonaws.datasync#ReportOutputType", + "traits": { + "smithy.api#documentation": "

Specifies the type of task report that you want:

\n " + } + }, + "ReportLevel": { + "target": "com.amazonaws.datasync#ReportLevel", + "traits": { + "smithy.api#documentation": "

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

\n " + } + }, + "ObjectVersionIds": { + "target": "com.amazonaws.datasync#ObjectVersionIds", + "traits": { + "smithy.api#documentation": "

Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

" + } + }, + "Overrides": { + "target": "com.amazonaws.datasync#ReportOverrides", + "traits": { + "smithy.api#documentation": "

Customizes the reporting level for aspects of your task report. For example, your report\n might generally only include errors, but you could specify that you want a list of successes\n and errors just for the files that DataSync attempted to delete in your destination\n location.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.

\n

For more information, see Task\n reports.

" + } + }, "com.amazonaws.datasync#TaskSchedule": { "type": "structure", "members": { @@ -9013,7 +9274,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the metadata associated with a task.

" + "smithy.api#documentation": "

Updates the configuration of a DataSync transfer task.

" } }, "com.amazonaws.datasync#UpdateTaskExecution": { @@ -9033,7 +9294,7 @@ } ], "traits": { - "smithy.api#documentation": "

Modifies a running DataSync task.

\n \n

Currently, the only Option that you can modify with\n UpdateTaskExecution is \n BytesPerSecond\n , which throttles bandwidth for a running or queued\n task.

\n " + "smithy.api#documentation": "

Updates the configuration of a running DataSync task execution.

\n \n

Currently, the only Option that you can modify with\n UpdateTaskExecution is \n BytesPerSecond\n , which throttles bandwidth for a running or queued\n task execution.

\n " } }, "com.amazonaws.datasync#UpdateTaskExecutionRequest": { @@ -9106,6 +9367,12 @@ "traits": { "smithy.api#documentation": "

Specifies a list of filter rules that include specific data during your transfer. For more\n information and examples, see Filtering data transferred by DataSync.

" } + }, + "TaskReportConfig": { + "target": "com.amazonaws.datasync#TaskReportConfig", + "traits": { + "smithy.api#documentation": "

Specifies how you want to configure a task report, which provides detailed information about for your DataSync transfer.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/neptunedata.json b/codegen/sdk-codegen/aws-models/neptunedata.json new file mode 100644 index 00000000000..8b73ccb6e20 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/neptunedata.json @@ -0,0 +1,8032 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.neptunedata#AccessDeniedException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised in case of an authentication or authorization failure.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.neptunedata#Action": { + "type": "enum", + "members": { + "INITIALIZE_RESET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "initiateDatabaseReset" + } + }, + "PERFORM_RESET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "performDatabaseReset" + } + } + } + }, + "com.amazonaws.neptunedata#AmazonNeptuneDataplane": { + "type": "service", + "version": "2023-08-01", + "operations": [ + { + "target": "com.amazonaws.neptunedata#CancelGremlinQuery" + }, + { + "target": "com.amazonaws.neptunedata#CancelLoaderJob" + }, + { + "target": "com.amazonaws.neptunedata#CancelMLDataProcessingJob" + }, + { + "target": "com.amazonaws.neptunedata#CancelMLModelTrainingJob" + }, + { + "target": "com.amazonaws.neptunedata#CancelMLModelTransformJob" + }, + { + "target": "com.amazonaws.neptunedata#CancelOpenCypherQuery" + }, + { + "target": "com.amazonaws.neptunedata#CreateMLEndpoint" + }, + { + "target": "com.amazonaws.neptunedata#DeleteMLEndpoint" + }, + { + "target": "com.amazonaws.neptunedata#DeletePropertygraphStatistics" + }, + { + "target": "com.amazonaws.neptunedata#DeleteSparqlStatistics" + }, + { + "target": "com.amazonaws.neptunedata#ExecuteFastReset" + }, + { + "target": "com.amazonaws.neptunedata#ExecuteGremlinExplainQuery" + }, + { + "target": "com.amazonaws.neptunedata#ExecuteGremlinProfileQuery" + }, + { + "target": "com.amazonaws.neptunedata#ExecuteGremlinQuery" + }, + { + "target": "com.amazonaws.neptunedata#ExecuteOpenCypherExplainQuery" + }, + { + "target": "com.amazonaws.neptunedata#ExecuteOpenCypherQuery" + }, + { + "target": "com.amazonaws.neptunedata#GetEngineStatus" + }, + { + "target": "com.amazonaws.neptunedata#GetGremlinQueryStatus" + }, + { + "target": "com.amazonaws.neptunedata#GetLoaderJobStatus" + }, + { + "target": "com.amazonaws.neptunedata#GetMLDataProcessingJob" + }, + { + "target": "com.amazonaws.neptunedata#GetMLEndpoint" + }, + { + "target": "com.amazonaws.neptunedata#GetMLModelTrainingJob" + }, + { + "target": "com.amazonaws.neptunedata#GetMLModelTransformJob" + }, + { + "target": "com.amazonaws.neptunedata#GetOpenCypherQueryStatus" + }, + { + "target": "com.amazonaws.neptunedata#GetPropertygraphStatistics" + }, + { + "target": "com.amazonaws.neptunedata#GetPropertygraphStream" + }, + { + "target": "com.amazonaws.neptunedata#GetPropertygraphSummary" + }, + { + "target": "com.amazonaws.neptunedata#GetRDFGraphSummary" + }, + { + "target": "com.amazonaws.neptunedata#GetSparqlStatistics" + }, + { + "target": "com.amazonaws.neptunedata#GetSparqlStream" + }, + { + "target": "com.amazonaws.neptunedata#ListGremlinQueries" + }, + { + "target": "com.amazonaws.neptunedata#ListLoaderJobs" + }, + { + "target": "com.amazonaws.neptunedata#ListMLDataProcessingJobs" + }, + { + "target": "com.amazonaws.neptunedata#ListMLEndpoints" + }, + { + "target": "com.amazonaws.neptunedata#ListMLModelTrainingJobs" + }, + { + "target": "com.amazonaws.neptunedata#ListMLModelTransformJobs" + }, + { + "target": "com.amazonaws.neptunedata#ListOpenCypherQueries" + }, + { + "target": "com.amazonaws.neptunedata#ManagePropertygraphStatistics" + }, + { + "target": "com.amazonaws.neptunedata#ManageSparqlStatistics" + }, + { + "target": "com.amazonaws.neptunedata#StartLoaderJob" + }, + { + "target": "com.amazonaws.neptunedata#StartMLDataProcessingJob" + }, + { + "target": "com.amazonaws.neptunedata#StartMLModelTrainingJob" + }, + { + "target": "com.amazonaws.neptunedata#StartMLModelTransformJob" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "neptunedata", + "arnNamespace": "neptune-db" + }, + "aws.auth#sigv4": { + "name": "neptune-db" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Neptune Data API\n

The Amazon Neptune data API provides SDK support for more than 40 of Neptune's data\n operations, including data loading, query execution, data inquiry, and machine learning.\n It supports all three Neptune query languages (Gremlin, openCypher and SPARQL), and is\n available in all SDK languages. It automatically signs API requests and greatly simplifies\n integrating Neptune into your applications.

", + "smithy.api#externalDocumentation": { + "API Reference": "https://docs.aws.amazon.com/neptune/latest/userguide/intro.html" + }, + "smithy.api#title": "Amazon NeptuneData", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://neptune-db-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://neptune-db-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://neptune-db.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://neptune-db.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://neptune-db-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://neptune-db-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://neptune-db.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://neptune-db.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://neptune-db-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://neptune-db-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://neptune-db.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://neptune-db.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://neptune-db-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://neptune-db-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://neptune-db.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://neptune-db.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://neptune-db-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://neptune-db.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://neptune-db-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://neptune-db.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.neptunedata#BadRequestException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the bad request.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a request is submitted that cannot be processed.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptunedata#BulkLoadIdNotFoundException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The bulk-load job ID that could not be found.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a specified bulk-load job ID cannot be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.neptunedata#CancelGremlinQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#CancelGremlinQueryInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#CancelGremlinQueryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#FailureByQueryException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#ParsingException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TimeLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a Gremlin query. See Gremlin\n query cancellation for more information.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/gremlin/status/{queryId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.neptunedata#CancelGremlinQueryInput": { + "type": "structure", + "members": { + "queryId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier that identifies the query to be canceled.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#CancelGremlinQueryOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status of the cancelation

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#CancelLoaderJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#CancelLoaderJobInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#CancelLoaderJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#BulkLoadIdNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InternalFailureException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#LoadUrlAccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a specified load job. This is an HTTP DELETE\n request.

\n

See Neptune\n Loader Get-Status API for more information.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/loader/{loadId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.neptunedata#CancelLoaderJobInput": { + "type": "structure", + "members": { + "loadId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the load job to be deleted.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#CancelLoaderJobOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The cancellation status.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#CancelMLDataProcessingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#CancelMLDataProcessingJobInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#CancelMLDataProcessingJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a Neptune ML data processing job. See The\n dataprocessing command.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/ml/dataprocessing/{id}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.neptunedata#CancelMLDataProcessingJobInput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the data-processing job.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#httpQuery": "neptuneIamRoleArn" + } + }, + "clean": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

If set to TRUE, this flag specifies that all\n Neptune ML S3 artifacts should be deleted when the job is stopped.\n The default is FALSE.

", + "smithy.api#httpQuery": "clean" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#CancelMLDataProcessingJobOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status of the cancellation request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#CancelMLModelTrainingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#CancelMLModelTrainingJobInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#CancelMLModelTrainingJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a Neptune ML model training job. See Model\n training using the modeltraining command.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/ml/modeltraining/{id}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.neptunedata#CancelMLModelTrainingJobInput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the model-training job to be canceled.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#httpQuery": "neptuneIamRoleArn" + } + }, + "clean": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

If set to TRUE, this flag specifies that all\n Amazon S3 artifacts should be deleted when the job is stopped.\n The default is FALSE.

", + "smithy.api#httpQuery": "clean" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#CancelMLModelTrainingJobOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status of the cancellation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#CancelMLModelTransformJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#CancelMLModelTransformJobInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#CancelMLModelTransformJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a specified model transform job. See Use\n a trained model to generate new model artifacts.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/ml/modeltransform/{id}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.neptunedata#CancelMLModelTransformJobInput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the model transform job to be canceled.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#httpQuery": "neptuneIamRoleArn" + } + }, + "clean": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

If this flag is set to TRUE, all Neptune ML S3 artifacts\n should be deleted when the job is stopped. The default is FALSE.

", + "smithy.api#httpQuery": "clean" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#CancelMLModelTransformJobOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

the status of the cancelation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#CancelOpenCypherQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#CancelOpenCypherQueryInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#CancelOpenCypherQueryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#FailureByQueryException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidNumericDataException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#ParsingException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TimeLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels a specified openCypher query. See Neptune\n openCypher status endpoint for more information.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/opencypher/status/{queryId}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.neptunedata#CancelOpenCypherQueryInput": { + "type": "structure", + "members": { + "queryId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the openCypher query to cancel.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "silent": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

If set to TRUE, causes the cancelation of the\n openCypher query to happen silently.

", + "smithy.api#httpQuery": "silent" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#CancelOpenCypherQueryOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The cancellation status of the openCypher query.

" + } + }, + "payload": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

The cancelation payload for the openCypher query.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#CancelledByUserException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a user cancelled a request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.neptunedata#Classes": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.neptunedata#ClientTimeoutException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a request timed out in the client.

", + "smithy.api#error": "client", + "smithy.api#httpError": 408, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.neptunedata#ConcurrentModificationException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a request attempts to modify data that is concurrently being\n modified by another process.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.neptunedata#ConstraintViolationException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a value in a request field did not satisfy required constraints.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.neptunedata#CreateMLEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#CreateMLEndpointInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#CreateMLEndpointOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new Neptune ML inference endpoint that lets you query\n one specific model that the model-training process constructed. See\n Managing\n inference endpoints using the endpoints command.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ml/endpoints", + "code": 200 + } + } + }, + "com.amazonaws.neptunedata#CreateMLEndpointInput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the new inference endpoint. The default\n is an autogenerated timestamped name.

" + } + }, + "mlModelTrainingJobId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The job Id of the completed model-training job that has created the\n model that the inference endpoint will point to. You must supply either\n the mlModelTrainingJobId or the mlModelTransformJobId.

" + } + }, + "mlModelTransformJobId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The job Id of the completed model-transform job. You must supply\n either the mlModelTrainingJobId or the mlModelTransformJobId.

" + } + }, + "update": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

If set to true, update indicates that this\n is an update request. The default is false. You must supply\n either the mlModelTrainingJobId or the mlModelTransformJobId.

" + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role providing Neptune access to SageMaker and\n Amazon S3 resources. This must be listed in your DB cluster parameter\n group or an error will be thrown.

" + } + }, + "modelName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Model type for training. By default the Neptune ML model is\n automatically based on the modelType used in data processing,\n but you can specify a different model type here. The default is\n rgcn for heterogeneous graphs and kge for\n knowledge graphs. The only valid value for heterogeneous graphs is\n rgcn. Valid values for knowledge graphs are: kge,\n transe, distmult, and rotate.

" + } + }, + "instanceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of Neptune ML instance to use for online servicing.\n The default is ml.m5.xlarge. Choosing the ML instance\n for an inference endpoint depends on the task type, the graph size,\n and your budget.

" + } + }, + "instanceCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The minimum number of Amazon EC2 instances to deploy to an endpoint\n for prediction. The default is 1

" + } + }, + "volumeEncryptionKMSKey": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses\n to encrypt data on the storage volume attached to the ML compute instances\n that run the training job. The default is None.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#CreateMLEndpointOutput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the new inference endpoint.

" + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN for the new inference endpoint.

" + } + }, + "creationTimeInMillis": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The endpoint creation time, in milliseconds.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#CustomModelTrainingParameters": { + "type": "structure", + "members": { + "sourceS3DirectoryPath": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The path to the Amazon S3 location where the Python module\n implementing your model is located. This must point to a valid\n existing Amazon S3 location that contains, at a minimum, a training\n script, a transform script, and a model-hpo-configuration.json\n file.

", + "smithy.api#required": {} + } + }, + "trainingEntryPointScript": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the entry point in your module of a script that performs\n model training and takes hyperparameters as command-line arguments,\n including fixed hyperparameters. The default is training.py.

" + } + }, + "transformEntryPointScript": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the entry point in your module of a script that should\n be run after the best model from the hyperparameter search has been\n identified, to compute the model artifacts necessary for model deployment.\n It should be able to run with no command-line arguments.The default is\n transform.py.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains custom model training parameters. See Custom\n models in Neptune ML.

" + } + }, + "com.amazonaws.neptunedata#CustomModelTransformParameters": { + "type": "structure", + "members": { + "sourceS3DirectoryPath": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The path to the Amazon S3 location where the Python module\n implementing your model is located. This must point to a valid\n existing Amazon S3 location that contains, at a minimum, a training\n script, a transform script, and a model-hpo-configuration.json\n file.

", + "smithy.api#required": {} + } + }, + "transformEntryPointScript": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of the entry point in your module of a script that should\n be run after the best model from the hyperparameter search has been\n identified, to compute the model artifacts necessary for model deployment.\n It should be able to run with no command-line arguments. The default\n is transform.py.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains custom model transform parameters. See Use\n a trained model to generate new model artifacts.

" + } + }, + "com.amazonaws.neptunedata#DeleteMLEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#DeleteMLEndpointInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#DeleteMLEndpointOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels the creation of a Neptune ML inference endpoint. See\n Managing\n inference endpoints using the endpoints command.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/ml/endpoints/{id}", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.neptunedata#DeleteMLEndpointInput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the inference endpoint.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role providing Neptune access to SageMaker and\n Amazon S3 resources. This must be listed in your DB cluster parameter\n group or an error will be thrown.

", + "smithy.api#httpQuery": "neptuneIamRoleArn" + } + }, + "clean": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

If this flag is set to TRUE, all Neptune ML S3 artifacts\n should be deleted when the job is stopped. The default is\n FALSE.

", + "smithy.api#httpQuery": "clean" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#DeleteMLEndpointOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status of the cancellation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#DeletePropertygraphStatistics": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.neptunedata#DeletePropertygraphStatisticsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#ReadOnlyViolationException" + }, + { + "target": "com.amazonaws.neptunedata#StatisticsNotAvailableException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes statistics for Gremlin and openCypher (property graph)\n data.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/propertygraph/statistics" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.neptunedata#DeletePropertygraphStatisticsOutput": { + "type": "structure", + "members": { + "statusCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The HTTP response code: 200 if the delete was successful, or\n 204 if there were no statistics to delete.

", + "smithy.api#httpResponseCode": {} + } + }, + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The cancel status.

" + } + }, + "payload": { + "target": "com.amazonaws.neptunedata#DeleteStatisticsValueMap", + "traits": { + "smithy.api#documentation": "

The deletion payload.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#DeleteSparqlStatistics": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.neptunedata#DeleteSparqlStatisticsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#ReadOnlyViolationException" + }, + { + "target": "com.amazonaws.neptunedata#StatisticsNotAvailableException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes SPARQL statistics

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/sparql/statistics" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.neptunedata#DeleteSparqlStatisticsOutput": { + "type": "structure", + "members": { + "statusCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The HTTP response code: 200 if the delete was successful, or\n 204 if there were no statistics to delete.

", + "smithy.api#httpResponseCode": {} + } + }, + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The cancel status.

" + } + }, + "payload": { + "target": "com.amazonaws.neptunedata#DeleteStatisticsValueMap", + "traits": { + "smithy.api#documentation": "

The deletion payload.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#DeleteStatisticsValueMap": { + "type": "structure", + "members": { + "active": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

The current status of the statistics.

" + } + }, + "statisticsId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the statistics generation run that is currently occurring.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The payload for DeleteStatistics.

" + } + }, + "com.amazonaws.neptunedata#DocumentValuedMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#Document" + } + }, + "com.amazonaws.neptunedata#EdgeLabels": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.neptunedata#EdgeProperties": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.neptunedata#EdgeStructure": { + "type": "structure", + "members": { + "count": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of edges that have this specific structure.

" + } + }, + "edgeProperties": { + "target": "com.amazonaws.neptunedata#EdgeProperties", + "traits": { + "smithy.api#documentation": "

A list of edge properties present in this specific structure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An edge structure.

" + } + }, + "com.amazonaws.neptunedata#EdgeStructures": { + "type": "list", + "member": { + "target": "com.amazonaws.neptunedata#EdgeStructure" + } + }, + "com.amazonaws.neptunedata#Encoding": { + "type": "enum", + "members": { + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "gzip" + } + } + } + }, + "com.amazonaws.neptunedata#ExecuteFastReset": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#ExecuteFastResetInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#ExecuteFastResetOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MethodNotAllowedException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#ReadOnlyViolationException" + }, + { + "target": "com.amazonaws.neptunedata#ServerShutdownException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

The fast reset REST API lets you reset a Neptune graph quicky\n and easily, removing all of its data.

\n

Neptune fast reset is a two-step process. First you call ExecuteFastReset\n with action set to initiateDatabaseReset. This returns a\n UUID token which you then include when calling ExecuteFastReset again\n with action set to performDatabaseReset. See Empty an Amazon Neptune\n DB cluster using the fast reset API.

", + "smithy.api#http": { + "method": "POST", + "uri": "/system", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.neptunedata#ExecuteFastResetInput": { + "type": "structure", + "members": { + "action": { + "target": "com.amazonaws.neptunedata#Action", + "traits": { + "smithy.api#documentation": "

The fast reset action. One of the following values:

\n ", + "smithy.api#required": {} + } + }, + "token": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The fast-reset token to initiate the reset.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#ExecuteFastResetOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status is only returned for the performDatabaseReset\n action, and indicates whether or not the fast reset rquest is accepted.

", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.neptunedata#FastResetToken", + "traits": { + "smithy.api#documentation": "

The payload is only returned by the initiateDatabaseReset\n action, and contains the unique token to use with the performDatabaseReset\n action to make the reset occur.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#ExecuteGremlinExplainQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#ExecuteGremlinExplainQueryInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#ExecuteGremlinExplainQueryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#CancelledByUserException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#FailureByQueryException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MalformedQueryException" + }, + { + "target": "com.amazonaws.neptunedata#MemoryLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#ParsingException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#QueryLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#QueryLimitException" + }, + { + "target": "com.amazonaws.neptunedata#QueryTooLargeException" + }, + { + "target": "com.amazonaws.neptunedata#TimeLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Executes a Gremlin Explain query.

\n

Amazon Neptune has added a Gremlin feature named explain\n that provides is a self-service tool for understanding the execution\n approach being taken by the Neptune engine for the query. You invoke\n it by adding an explain parameter to an HTTP call that\n submits a Gremlin query.

\n

The explain feature provides information about the logical structure\n of query execution plans. You can use this information to identify\n potential evaluation and execution bottlenecks and to tune your query,\n as explained in Tuning\n Gremlin queries. You can also use query hints to improve\n query execution plans.

", + "smithy.api#http": { + "method": "POST", + "uri": "/gremlin/explain", + "code": 200 + } + } + }, + "com.amazonaws.neptunedata#ExecuteGremlinExplainQueryInput": { + "type": "structure", + "members": { + "gremlinQuery": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Gremlin explain query string.

", + "smithy.api#jsonName": "gremlin", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#ExecuteGremlinExplainQueryOutput": { + "type": "structure", + "members": { + "output": { + "target": "com.amazonaws.neptunedata#ReportAsText", + "traits": { + "smithy.api#documentation": "

A text blob containing the Gremlin explain result, as described\n in Tuning\n Gremlin queries.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#ExecuteGremlinProfileQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#ExecuteGremlinProfileQueryInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#ExecuteGremlinProfileQueryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#CancelledByUserException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#FailureByQueryException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MalformedQueryException" + }, + { + "target": "com.amazonaws.neptunedata#MemoryLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#ParsingException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#QueryLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#QueryLimitException" + }, + { + "target": "com.amazonaws.neptunedata#QueryTooLargeException" + }, + { + "target": "com.amazonaws.neptunedata#TimeLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Executes a Gremlin Profile query, which runs a specified traversal,\n collects various metrics about the run, and produces a profile report\n as output. See Gremlin profile\n API in Neptune for details.

", + "smithy.api#http": { + "method": "POST", + "uri": "/gremlin/profile", + "code": 200 + } + } + }, + "com.amazonaws.neptunedata#ExecuteGremlinProfileQueryInput": { + "type": "structure", + "members": { + "gremlinQuery": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Gremlin query string to profile.

", + "smithy.api#jsonName": "gremlin", + "smithy.api#required": {} + } + }, + "results": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

If this flag is set to TRUE, the query results are\n gathered and displayed as part of the profile report.\n If FALSE, only the result count is displayed.

", + "smithy.api#jsonName": "profile.results" + } + }, + "chop": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

If non-zero, causes the results string to be truncated at that\n number of characters. If set to zero, the string contains all the results.

", + "smithy.api#jsonName": "profile.chop" + } + }, + "serializer": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

If non-null, the gathered results are returned in a serialized response\n message in the format specified by this parameter. See Gremlin profile\n API in Neptune for more information.

", + "smithy.api#jsonName": "profile.serializer" + } + }, + "indexOps": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

If this flag is set to TRUE, the results include a\n detailed report of all index operations that took place during query\n execution and serialization.

", + "smithy.api#jsonName": "profile.indexOps" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#ExecuteGremlinProfileQueryOutput": { + "type": "structure", + "members": { + "output": { + "target": "com.amazonaws.neptunedata#ReportAsText", + "traits": { + "smithy.api#documentation": "

A text blob containing the Gremlin Profile result. See\n Gremlin\n profile API in Neptune for details.

", + "smithy.api#httpPayload": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#ExecuteGremlinQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#ExecuteGremlinQueryInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#ExecuteGremlinQueryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#CancelledByUserException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#FailureByQueryException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MalformedQueryException" + }, + { + "target": "com.amazonaws.neptunedata#MemoryLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#ParsingException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#QueryLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#QueryLimitException" + }, + { + "target": "com.amazonaws.neptunedata#QueryTooLargeException" + }, + { + "target": "com.amazonaws.neptunedata#TimeLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

This commands executes a Gremlin query. Amazon Neptune is compatible\n with Apache TinkerPop3 and Gremlin, so you can use the Gremlin traversal\n language to query the graph, as described under The\n Graph in the Apache TinkerPop3 documentation.\n More details can also be found in Accessing a\n Neptune graph with Gremlin.

", + "smithy.api#http": { + "method": "POST", + "uri": "/gremlin", + "code": 200 + } + } + }, + "com.amazonaws.neptunedata#ExecuteGremlinQueryInput": { + "type": "structure", + "members": { + "gremlinQuery": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Using this API, you can run Gremlin queries in string format\n much as you can using the HTTP endpoint. The interface is\n compatible with whatever Gremlin version your DB cluster is using\n (see the Tinkerpop\n client section to determine which Gremlin releases your\n engine version supports).

", + "smithy.api#jsonName": "gremlin", + "smithy.api#required": {} + } + }, + "serializer": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

If non-null, the query results are returned in a serialized response\n message in the format specified by this parameter. See the GraphSON\n section in the TinkerPop documentation for a list of the formats that\n are currently supported.

", + "smithy.api#httpHeader": "accept" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#ExecuteGremlinQueryOutput": { + "type": "structure", + "members": { + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the Gremlin query.

" + } + }, + "status": { + "target": "com.amazonaws.neptunedata#GremlinQueryStatusAttributes", + "traits": { + "smithy.api#documentation": "

The status of the Gremlin query.

" + } + }, + "result": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

The Gremlin query output from the server.

" + } + }, + "meta": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

Metadata about the Gremlin query.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#ExecuteOpenCypherExplainQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#ExecuteOpenCypherExplainQueryInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#ExecuteOpenCypherExplainQueryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#CancelledByUserException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#FailureByQueryException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidNumericDataException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MalformedQueryException" + }, + { + "target": "com.amazonaws.neptunedata#MemoryLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#ParsingException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#QueryLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#QueryLimitException" + }, + { + "target": "com.amazonaws.neptunedata#QueryTooLargeException" + }, + { + "target": "com.amazonaws.neptunedata#TimeLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Executes an openCypher explain request. See\n The\n openCypher explain feature for more information.

", + "smithy.api#http": { + "method": "POST", + "uri": "/opencypher/explain", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#ExecuteOpenCypherExplainQueryInput": { + "type": "structure", + "members": { + "openCypherQuery": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The openCypher query string.

", + "smithy.api#jsonName": "query", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The openCypher query parameters.

" + } + }, + "explainMode": { + "target": "com.amazonaws.neptunedata#OpenCypherExplainMode", + "traits": { + "smithy.api#documentation": "

The openCypher explain mode. Can be one of:\n static, dynamic, or details.

", + "smithy.api#jsonName": "explain", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#ExecuteOpenCypherExplainQueryOutput": { + "type": "structure", + "members": { + "results": { + "target": "smithy.api#Blob", + "traits": { + "smithy.api#documentation": "

A text blob containing the openCypher explain results.

", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#ExecuteOpenCypherQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#ExecuteOpenCypherQueryInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#ExecuteOpenCypherQueryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#CancelledByUserException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#FailureByQueryException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidNumericDataException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MalformedQueryException" + }, + { + "target": "com.amazonaws.neptunedata#MemoryLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#ParsingException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#QueryLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#QueryLimitException" + }, + { + "target": "com.amazonaws.neptunedata#QueryTooLargeException" + }, + { + "target": "com.amazonaws.neptunedata#TimeLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Executes an openCypher query. See Accessing\n the Neptune Graph with openCypher for more information.

\n

Neptune supports building graph applications using openCypher,\n which is currently one of the most popular query languages among\n developers working with graph databases. Developers, business analysts,\n and data scientists like openCypher's declarative, SQL-inspired syntax\n because it provides a familiar structure in which to querying property\n graphs.

\n

The openCypher language was originally developed by Neo4j, then\n open-sourced in 2015 and contributed to the openCypher project under an Apache\n 2 open-source license.

", + "smithy.api#http": { + "method": "POST", + "uri": "/opencypher", + "code": 200 + } + } + }, + "com.amazonaws.neptunedata#ExecuteOpenCypherQueryInput": { + "type": "structure", + "members": { + "openCypherQuery": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The openCypher query string to be executed.

", + "smithy.api#jsonName": "query", + "smithy.api#required": {} + } + }, + "parameters": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The openCypher query parameters for query execution. \n See Examples\n of openCypher parameterized queries for more information.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#ExecuteOpenCypherQueryOutput": { + "type": "structure", + "members": { + "results": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

The openCypherquery results.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#ExpiredStreamException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a request attempts to access an stream that has expired.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptunedata#FailureByQueryException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a request fails.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.neptunedata#FastResetToken": { + "type": "structure", + "members": { + "token": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A UUID generated by the database in the initiateDatabaseReset action,\n and then consumed by the performDatabaseReset to reset the database.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure containing the fast reset token used to initiate\n a fast reset.

" + } + }, + "com.amazonaws.neptunedata#Format": { + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "csv" + } + }, + "OPENCYPHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "opencypher" + } + }, + "NTRIPLES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ntriples" + } + }, + "NQUADS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nquads" + } + }, + "RDFXML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "rdfxml" + } + }, + "TURTLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "turtle" + } + } + } + }, + "com.amazonaws.neptunedata#GetEngineStatus": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.neptunedata#GetEngineStatusOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InternalFailureException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Check the status of the graph database on the host.

", + "smithy.api#http": { + "method": "GET", + "uri": "/status", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#GetEngineStatusOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Set to healthy if the instance is not experiencing problems.\n If the instance is recovering from a crash or from being rebooted and there\n are active transactions running from the latest server shutdown, status is set\n to recovery.

" + } + }, + "startTime": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Set to the UTC time at which the current server process started.

" + } + }, + "dbEngineVersion": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Set to the Neptune engine version running on your DB cluster.\n If this engine version has been manually patched since it was released,\n the version number is prefixed by Patch-.

" + } + }, + "role": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Set to reader if the instance is a read-replica,\n or to writer if the instance is the primary instance.

" + } + }, + "dfeQueryEngine": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Set to enabled if the DFE engine is fully enabled,\n or to viaQueryHint (the default) if the DFE engine is\n only used with queries that have the useDFE query hint\n set to true.

" + } + }, + "gremlin": { + "target": "com.amazonaws.neptunedata#QueryLanguageVersion", + "traits": { + "smithy.api#documentation": "

Contains information about the Gremlin query language available\n on your cluster. Specifically, it contains a version field that specifies\n the current TinkerPop version being used by the engine.

" + } + }, + "sparql": { + "target": "com.amazonaws.neptunedata#QueryLanguageVersion", + "traits": { + "smithy.api#documentation": "

Contains information about the SPARQL query language available\n on your cluster. Specifically, it contains a version field that\n specifies the current SPARQL version being used by the engine.

" + } + }, + "opencypher": { + "target": "com.amazonaws.neptunedata#QueryLanguageVersion", + "traits": { + "smithy.api#documentation": "

Contains information about the openCypher query language available\n on your cluster. Specifically, it contains a version field that\n specifies the current operCypher version being used by the engine.

" + } + }, + "labMode": { + "target": "com.amazonaws.neptunedata#StringValuedMap", + "traits": { + "smithy.api#documentation": "

Contains Lab Mode settings being used by the engine.

" + } + }, + "rollingBackTrxCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

If there are transactions being rolled back, this field is set\n to the number of such transactions. If there are none, the field\n doesn't appear at all.

" + } + }, + "rollingBackTrxEarliestStartTime": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Set to the start time of the earliest transaction being rolled back.\n If no transactions are being rolled back, the field doesn't appear at all.

" + } + }, + "features": { + "target": "com.amazonaws.neptunedata#DocumentValuedMap", + "traits": { + "smithy.api#documentation": "

Contains status information about the features enabled on your DB cluster.

" + } + }, + "settings": { + "target": "com.amazonaws.neptunedata#StringValuedMap", + "traits": { + "smithy.api#documentation": "

Contains information about the current settings on your DB cluster.\n For example, contains the current cluster query timeout setting\n (clusterQueryTimeoutInMs).

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#GetGremlinQueryStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#GetGremlinQueryStatusInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#GetGremlinQueryStatusOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#FailureByQueryException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#ParsingException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#ReadOnlyViolationException" + }, + { + "target": "com.amazonaws.neptunedata#TimeLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets the status of a specified Gremlin query.

", + "smithy.api#http": { + "method": "GET", + "uri": "/gremlin/status/{queryId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#GetGremlinQueryStatusInput": { + "type": "structure", + "members": { + "queryId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier that identifies the Gremlin query.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#GetGremlinQueryStatusOutput": { + "type": "structure", + "members": { + "queryId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the query for which status is being returned.

" + } + }, + "queryString": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Gremlin query string.

" + } + }, + "queryEvalStats": { + "target": "com.amazonaws.neptunedata#QueryEvalStats", + "traits": { + "smithy.api#documentation": "

The evaluation status of the Gremlin query.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#GetLoaderJobStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#GetLoaderJobStatusInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#GetLoaderJobStatusOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#BulkLoadIdNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InternalFailureException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#LoadUrlAccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets status information about a specified load job.\n Neptune keeps track of the most recent 1,024 bulk load jobs,\n and stores the last 10,000 error details per job.

\n

See Neptune\n Loader Get-Status API for more information.

", + "smithy.api#http": { + "method": "GET", + "uri": "/loader/{loadId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#GetLoaderJobStatusInput": { + "type": "structure", + "members": { + "loadId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The load ID of the load job to get the status of.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "details": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Flag indicating whether or not to include details beyond the\n overall status (TRUE or FALSE; the default\n is FALSE).

", + "smithy.api#httpQuery": "details" + } + }, + "errors": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Flag indicating whether or not to include a list of errors\n encountered (TRUE or FALSE; the default\n is FALSE).

\n

The list of errors is paged. The page and errorsPerPage\n parameters allow you to page through all the errors.

", + "smithy.api#httpQuery": "errors" + } + }, + "page": { + "target": "com.amazonaws.neptunedata#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The error page number (a positive integer; the default is 1).\n Only valid when the errors parameter is set to\n TRUE.

", + "smithy.api#httpQuery": "page" + } + }, + "errorsPerPage": { + "target": "com.amazonaws.neptunedata#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The number of errors returned in each page (a positive integer; the\n default is 10). Only valid when the errors\n parameter set to TRUE.

", + "smithy.api#httpQuery": "errorsPerPage" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#GetLoaderJobStatusOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP response code for the request.

", + "smithy.api#required": {} + } + }, + "payload": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

Status information about the load job, in a layout\n that could look like this:

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#GetMLDataProcessingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#GetMLDataProcessingJobInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#GetMLDataProcessingJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about a specified data processing job. See The\n dataprocessing command.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ml/dataprocessing/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#GetMLDataProcessingJobInput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the data-processing job to be retrieved.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#httpQuery": "neptuneIamRoleArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#GetMLDataProcessingJobOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Status of the data processing job.

" + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of this data-processing job.

" + } + }, + "processingJob": { + "target": "com.amazonaws.neptunedata#MlResourceDefinition", + "traits": { + "smithy.api#documentation": "

Definition of the data processing job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#GetMLEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#GetMLEndpointInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#GetMLEndpointOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves details about an inference endpoint. See Managing\n inference endpoints using the endpoints command.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ml/endpoints/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#GetMLEndpointInput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the inference endpoint.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster parameter\n group or an error will occur.

", + "smithy.api#httpQuery": "neptuneIamRoleArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#GetMLEndpointOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status of the inference endpoint.

" + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the inference endpoint.

" + } + }, + "endpoint": { + "target": "com.amazonaws.neptunedata#MlResourceDefinition", + "traits": { + "smithy.api#documentation": "

The endpoint definition.

" + } + }, + "endpointConfig": { + "target": "com.amazonaws.neptunedata#MlConfigDefinition", + "traits": { + "smithy.api#documentation": "

The endpoint configuration

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#GetMLModelTrainingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#GetMLModelTrainingJobInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#GetMLModelTrainingJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves information about a Neptune ML model training job. See Model\n training using the modeltraining command.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ml/modeltraining/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#GetMLModelTrainingJobInput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the model-training job to retrieve.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#httpQuery": "neptuneIamRoleArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#GetMLModelTrainingJobOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status of the model training job.

" + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of this model-training job.

" + } + }, + "processingJob": { + "target": "com.amazonaws.neptunedata#MlResourceDefinition", + "traits": { + "smithy.api#documentation": "

The data processing job.

" + } + }, + "hpoJob": { + "target": "com.amazonaws.neptunedata#MlResourceDefinition", + "traits": { + "smithy.api#documentation": "

The HPO job.

" + } + }, + "modelTransformJob": { + "target": "com.amazonaws.neptunedata#MlResourceDefinition", + "traits": { + "smithy.api#documentation": "

The model transform job.

" + } + }, + "mlModels": { + "target": "com.amazonaws.neptunedata#MlModels", + "traits": { + "smithy.api#documentation": "

A list of the configurations of the ML models being used.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#GetMLModelTransformJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#GetMLModelTransformJobInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#GetMLModelTransformJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information about a specified model transform job. See Use\n a trained model to generate new model artifacts.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ml/modeltransform/{id}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#GetMLModelTransformJobInput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the model-transform job to be reetrieved.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#httpQuery": "neptuneIamRoleArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#GetMLModelTransformJobOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status of the model-transform job.

" + } + }, + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique identifier of the model-transform job to be retrieved.

" + } + }, + "baseProcessingJob": { + "target": "com.amazonaws.neptunedata#MlResourceDefinition", + "traits": { + "smithy.api#documentation": "

The base data processing job.

" + } + }, + "remoteModelTransformJob": { + "target": "com.amazonaws.neptunedata#MlResourceDefinition", + "traits": { + "smithy.api#documentation": "

The remote model transform job.

" + } + }, + "models": { + "target": "com.amazonaws.neptunedata#Models", + "traits": { + "smithy.api#documentation": "

A list of the configuration information for the models being used.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#GetOpenCypherQueryStatus": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#GetOpenCypherQueryStatusInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#GetOpenCypherQueryStatusOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#FailureByQueryException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidNumericDataException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#ParsingException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#ReadOnlyViolationException" + }, + { + "target": "com.amazonaws.neptunedata#TimeLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the status of a specified openCypher query.

", + "smithy.api#http": { + "method": "GET", + "uri": "/opencypher/status/{queryId}", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#GetOpenCypherQueryStatusInput": { + "type": "structure", + "members": { + "queryId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the openCypher query for which to retrieve\n the query status.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#GetOpenCypherQueryStatusOutput": { + "type": "structure", + "members": { + "queryId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the query for which status is being returned.

" + } + }, + "queryString": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The openCypher query string.

" + } + }, + "queryEvalStats": { + "target": "com.amazonaws.neptunedata#QueryEvalStats", + "traits": { + "smithy.api#documentation": "

The openCypher query evaluation status.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#GetPropertygraphStatistics": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.neptunedata#GetPropertygraphStatisticsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#ReadOnlyViolationException" + }, + { + "target": "com.amazonaws.neptunedata#StatisticsNotAvailableException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets property graph statistics (Gremlin and openCypher).

", + "smithy.api#http": { + "method": "GET", + "uri": "/propertygraph/statistics", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#GetPropertygraphStatisticsOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded,\n the code is 200. See Common\n error codes for DFE statistics request for a list of common errors.

", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.neptunedata#Statistics", + "traits": { + "smithy.api#documentation": "

Statistics for property-graph data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#GetPropertygraphStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#GetPropertygraphStreamInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#GetPropertygraphStreamOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#ExpiredStreamException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MemoryLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#StreamRecordsNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#ThrottlingException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a stream for a property graph.

\n

With the Neptune Streams feature, you can generate a complete\n sequence of change-log entries that record every change made to your\n graph data as it happens. GetPropertygraphStream lets\n you collect these change-log entries for a property graph.

\n

The Neptune streams feature needs to be enabled on your Neptune\n DBcluster. To enable streams, set the neptune_streams\n DB cluster parameter to 1.

\n

See Capturing\n graph changes in real time using Neptune streams.

", + "smithy.api#http": { + "method": "GET", + "uri": "/propertygraph/stream", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#GetPropertygraphStreamInput": { + "type": "structure", + "members": { + "limit": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

Specifies the maximum number of records to return. There\n is also a size limit of 10 MB on the response that can't be modified\n and that takes precedence over the number of records specified in\n the limit parameter. The response does include a\n threshold-breaching record if the 10 MB limit was reached.

\n

The range for limit is 1 to 100,000, with a\n default of 10.

", + "smithy.api#httpQuery": "limit", + "smithy.api#range": { + "min": 1, + "max": 100000 + } + } + }, + "iteratorType": { + "target": "com.amazonaws.neptunedata#IteratorType", + "traits": { + "smithy.api#documentation": "

Can be one of:

\n ", + "smithy.api#httpQuery": "iteratorType" + } + }, + "commitNum": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The commit number of the starting record to read from the\n change-log stream. This parameter is required when iteratorType\n isAT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER, and\n ignored when iteratorType is TRIM_HORIZON or\n LATEST.

", + "smithy.api#httpQuery": "commitNum" + } + }, + "opNum": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The operation sequence number within the specified commit to\n start reading from in the change-log stream data. The default is 1.

", + "smithy.api#httpQuery": "opNum" + } + }, + "encoding": { + "target": "com.amazonaws.neptunedata#Encoding", + "traits": { + "smithy.api#documentation": "

If set to TRUE, Neptune compresses the response using gzip encoding.

", + "smithy.api#httpHeader": "Accept-Encoding" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#GetPropertygraphStreamOutput": { + "type": "structure", + "members": { + "lastEventId": { + "target": "com.amazonaws.neptunedata#StringValuedMap", + "traits": { + "smithy.api#documentation": "

Sequence identifier of the last change in the stream response.

\n

An event ID is composed of two fields: a commitNum, which\n identifies a transaction that changed the graph, and an opNum,\n which identifies a specific operation within that transaction:

", + "smithy.api#required": {} + } + }, + "lastTrxTimestampInMillis": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The time at which the commit for the transaction was requested,\n in milliseconds from the Unix epoch.

", + "smithy.api#jsonName": "lastTrxTimestamp", + "smithy.api#required": {} + } + }, + "format": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Serialization format for the change records being returned.\n Currently, the only supported value is PG_JSON.

", + "smithy.api#required": {} + } + }, + "records": { + "target": "com.amazonaws.neptunedata#PropertygraphRecordsList", + "traits": { + "smithy.api#documentation": "

An array of serialized change-log stream records included in the response.

", + "smithy.api#required": {} + } + }, + "totalRecords": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The total number of records in the response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#GetPropertygraphSummary": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#GetPropertygraphSummaryInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#GetPropertygraphSummaryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#ReadOnlyViolationException" + }, + { + "target": "com.amazonaws.neptunedata#StatisticsNotAvailableException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a graph summary for a property graph.

", + "smithy.api#http": { + "method": "GET", + "uri": "/propertygraph/statistics/summary", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#GetPropertygraphSummaryInput": { + "type": "structure", + "members": { + "mode": { + "target": "com.amazonaws.neptunedata#GraphSummaryType", + "traits": { + "smithy.api#default": "basic", + "smithy.api#documentation": "

Mode can take one of two values: BASIC (the default),\n and DETAILED.

", + "smithy.api#httpQuery": "mode" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#GetPropertygraphSummaryOutput": { + "type": "structure", + "members": { + "statusCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded,\n the code is 200.

", + "smithy.api#httpResponseCode": {} + } + }, + "payload": { + "target": "com.amazonaws.neptunedata#PropertygraphSummaryValueMap", + "traits": { + "smithy.api#documentation": "

Payload containing the property graph summary response.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#GetRDFGraphSummary": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#GetRDFGraphSummaryInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#GetRDFGraphSummaryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#ReadOnlyViolationException" + }, + { + "target": "com.amazonaws.neptunedata#StatisticsNotAvailableException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a graph summary for an RDF graph.

", + "smithy.api#http": { + "method": "GET", + "uri": "/rdf/statistics/summary", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#GetRDFGraphSummaryInput": { + "type": "structure", + "members": { + "mode": { + "target": "com.amazonaws.neptunedata#GraphSummaryType", + "traits": { + "smithy.api#default": "basic", + "smithy.api#documentation": "

Mode can take one of two values: BASIC (the default),\n and DETAILED.

", + "smithy.api#httpQuery": "mode" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#GetRDFGraphSummaryOutput": { + "type": "structure", + "members": { + "statusCode": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded,\n the code is 200.

", + "smithy.api#httpResponseCode": {} + } + }, + "payload": { + "target": "com.amazonaws.neptunedata#RDFGraphSummaryValueMap", + "traits": { + "smithy.api#documentation": "

Payload for an RDF graph summary response

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#GetSparqlStatistics": { + "type": "operation", + "input": { + "target": "smithy.api#Unit" + }, + "output": { + "target": "com.amazonaws.neptunedata#GetSparqlStatisticsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#ReadOnlyViolationException" + }, + { + "target": "com.amazonaws.neptunedata#StatisticsNotAvailableException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets RDF statistics (SPARQL).

", + "smithy.api#http": { + "method": "GET", + "uri": "/sparql/statistics", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#GetSparqlStatisticsOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded,\n the code is 200. See Common\n error codes for DFE statistics request for a list of common errors.

", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.neptunedata#Statistics", + "traits": { + "smithy.api#documentation": "

Statistics for RDF data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#GetSparqlStream": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#GetSparqlStreamInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#GetSparqlStreamOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#ExpiredStreamException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MemoryLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#StreamRecordsNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#ThrottlingException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets a stream for an RDF graph.

\n

With the Neptune Streams feature, you can generate a complete\n sequence of change-log entries that record every change made to your\n graph data as it happens. GetSparqlStream lets\n you collect these change-log entries for an RDF graph.

\n

The Neptune streams feature needs to be enabled on your Neptune\n DBcluster. To enable streams, set the neptune_streams\n DB cluster parameter to 1.

\n

See Capturing\n graph changes in real time using Neptune streams.

", + "smithy.api#http": { + "method": "GET", + "uri": "/sparql/stream", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#GetSparqlStreamInput": { + "type": "structure", + "members": { + "limit": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

Specifies the maximum number of records to return. There\n is also a size limit of 10 MB on the response that can't be modified\n and that takes precedence over the number of records specified in\n the limit parameter. The response does include a\n threshold-breaching record if the 10 MB limit was reached.

\n

The range for limit is 1 to 100,000, with a\n default of 10.

", + "smithy.api#httpQuery": "limit", + "smithy.api#range": { + "min": 1, + "max": 100000 + } + } + }, + "iteratorType": { + "target": "com.amazonaws.neptunedata#IteratorType", + "traits": { + "smithy.api#documentation": "

Can be one of:

\n ", + "smithy.api#httpQuery": "iteratorType" + } + }, + "commitNum": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The commit number of the starting record to read from the\n change-log stream. This parameter is required when iteratorType\n isAT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER, and\n ignored when iteratorType is TRIM_HORIZON or\n LATEST.

", + "smithy.api#httpQuery": "commitNum" + } + }, + "opNum": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The operation sequence number within the specified commit to\n start reading from in the change-log stream data. The default is 1.

", + "smithy.api#httpQuery": "opNum" + } + }, + "encoding": { + "target": "com.amazonaws.neptunedata#Encoding", + "traits": { + "smithy.api#documentation": "

If set to TRUE, Neptune compresses the response using gzip encoding.

", + "smithy.api#httpHeader": "Accept-Encoding" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#GetSparqlStreamOutput": { + "type": "structure", + "members": { + "lastEventId": { + "target": "com.amazonaws.neptunedata#StringValuedMap", + "traits": { + "smithy.api#documentation": "

Sequence identifier of the last change in the stream response.

\n

An event ID is composed of two fields: a commitNum, which\n identifies a transaction that changed the graph, and an opNum,\n which identifies a specific operation within that transaction:

", + "smithy.api#required": {} + } + }, + "lastTrxTimestampInMillis": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The time at which the commit for the transaction was requested,\n in milliseconds from the Unix epoch.

", + "smithy.api#jsonName": "lastTrxTimestamp", + "smithy.api#required": {} + } + }, + "format": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Serialization format for the change records being returned.\n Currently, the only supported value is NQUADS.

", + "smithy.api#required": {} + } + }, + "records": { + "target": "com.amazonaws.neptunedata#SparqlRecordsList", + "traits": { + "smithy.api#documentation": "

An array of serialized change-log stream records included in the response.

", + "smithy.api#required": {} + } + }, + "totalRecords": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The total number of records in the response.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#GraphSummaryType": { + "type": "enum", + "members": { + "BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "basic" + } + }, + "DETAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "detailed" + } + } + } + }, + "com.amazonaws.neptunedata#GremlinQueries": { + "type": "list", + "member": { + "target": "com.amazonaws.neptunedata#GremlinQueryStatus" + } + }, + "com.amazonaws.neptunedata#GremlinQueryStatus": { + "type": "structure", + "members": { + "queryId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the Gremlin query.

" + } + }, + "queryString": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The query string of the Gremlin query.

" + } + }, + "queryEvalStats": { + "target": "com.amazonaws.neptunedata#QueryEvalStats", + "traits": { + "smithy.api#documentation": "

The query statistics of the Gremlin query.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Captures the status of a Gremlin query (see the Gremlin query\n status API page).

" + } + }, + "com.amazonaws.neptunedata#GremlinQueryStatusAttributes": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The status message.

" + } + }, + "code": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The HTTP response code returned fro the Gremlin query request..

" + } + }, + "attributes": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

Attributes of the Gremlin query status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains status components of a Gremlin query.

" + } + }, + "com.amazonaws.neptunedata#IllegalArgumentException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when an argument in a request is not supported.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptunedata#InternalFailureException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when the processing of the request failed unexpectedly.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.neptunedata#InvalidArgumentException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when an argument in a request has an invalid value.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptunedata#InvalidNumericDataException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when invalid numerical data is encountered when servicing a request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptunedata#InvalidParameterException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request that includes an invalid parameter.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a parameter value is not valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptunedata#IteratorType": { + "type": "enum", + "members": { + "AT_SEQUENCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AT_SEQUENCE_NUMBER" + } + }, + "AFTER_SEQUENCE_NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFTER_SEQUENCE_NUMBER" + } + }, + "TRIM_HORIZON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRIM_HORIZON" + } + }, + "LATEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LATEST" + } + } + } + }, + "com.amazonaws.neptunedata#ListGremlinQueries": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#ListGremlinQueriesInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#ListGremlinQueriesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#FailureByQueryException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#ParsingException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#ReadOnlyViolationException" + }, + { + "target": "com.amazonaws.neptunedata#TimeLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists active Gremlin queries. See Gremlin query\n status API for details about the output.

", + "smithy.api#http": { + "method": "GET", + "uri": "/gremlin/status", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#ListGremlinQueriesInput": { + "type": "structure", + "members": { + "includeWaiting": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

If set to TRUE, the list returned includes waiting\n queries. The default is FALSE;

", + "smithy.api#httpQuery": "includeWaiting" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#ListGremlinQueriesOutput": { + "type": "structure", + "members": { + "acceptedQueryCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of queries that have been accepted but not yet\n completed, including queries in the queue.

" + } + }, + "runningQueryCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of Gremlin queries currently running.

" + } + }, + "queries": { + "target": "com.amazonaws.neptunedata#GremlinQueries", + "traits": { + "smithy.api#documentation": "

A list of the current queries.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#ListLoaderJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#ListLoaderJobsInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#ListLoaderJobsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#BulkLoadIdNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InternalFailureException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#LoadUrlAccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a list of the loadIds for all active\n loader jobs.

", + "smithy.api#http": { + "method": "GET", + "uri": "/loader", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#ListLoaderJobsInput": { + "type": "structure", + "members": { + "limit": { + "target": "com.amazonaws.neptunedata#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The number of load IDs to list. Must be a positive integer\n greater than zero and not more than 100 (which is the default).

", + "smithy.api#httpQuery": "limit", + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "includeQueuedLoads": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

An optional parameter that can be used to exclude the load\n IDs of queued load requests when requesting a list of load IDs by\n setting the parameter to FALSE. The default value\n is TRUE.

", + "smithy.api#httpQuery": "includeQueuedLoads" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#ListLoaderJobsOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Returns the status of the job list request.

", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.neptunedata#LoaderIdResult", + "traits": { + "smithy.api#documentation": "

The requested list of job IDs.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#ListMLDataProcessingJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#ListMLDataProcessingJobsInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#ListMLDataProcessingJobsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of Neptune ML data processing jobs. See Listing\n active data-processing jobs using the Neptune ML dataprocessing command.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ml/dataprocessing", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#ListMLDataProcessingJobsInput": { + "type": "structure", + "members": { + "maxItems": { + "target": "com.amazonaws.neptunedata#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return (from 1 to 1024; the default is 10).

", + "smithy.api#httpQuery": "maxItems", + "smithy.api#range": { + "min": 1, + "max": 1024 + } + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#httpQuery": "neptuneIamRoleArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#ListMLDataProcessingJobsOutput": { + "type": "structure", + "members": { + "ids": { + "target": "com.amazonaws.neptunedata#StringList", + "traits": { + "smithy.api#documentation": "

A page listing data processing job IDs.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#ListMLEndpoints": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#ListMLEndpointsInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#ListMLEndpointsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists existing inference endpoints. See Managing\n inference endpoints using the endpoints command.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ml/endpoints", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#ListMLEndpointsInput": { + "type": "structure", + "members": { + "maxItems": { + "target": "com.amazonaws.neptunedata#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return (from 1 to 1024; the default\n is 10.

", + "smithy.api#httpQuery": "maxItems", + "smithy.api#range": { + "min": 1, + "max": 1024 + } + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#httpQuery": "neptuneIamRoleArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#ListMLEndpointsOutput": { + "type": "structure", + "members": { + "ids": { + "target": "com.amazonaws.neptunedata#StringList", + "traits": { + "smithy.api#documentation": "

A page from the list of inference endpoint IDs.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#ListMLModelTrainingJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#ListMLModelTrainingJobsInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#ListMLModelTrainingJobsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists Neptune ML model-training jobs. See Model\n training using the modeltraining command.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ml/modeltraining", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#ListMLModelTrainingJobsInput": { + "type": "structure", + "members": { + "maxItems": { + "target": "com.amazonaws.neptunedata#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return (from 1 to 1024; the default\n is 10).

", + "smithy.api#httpQuery": "maxItems", + "smithy.api#range": { + "min": 1, + "max": 1024 + } + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#httpQuery": "neptuneIamRoleArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#ListMLModelTrainingJobsOutput": { + "type": "structure", + "members": { + "ids": { + "target": "com.amazonaws.neptunedata#StringList", + "traits": { + "smithy.api#documentation": "

A page of the list of model training job IDs.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#ListMLModelTransformJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#ListMLModelTransformJobsInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#ListMLModelTransformJobsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of model transform job IDs. See Use\n a trained model to generate new model artifacts.

", + "smithy.api#http": { + "method": "GET", + "uri": "/ml/modeltransform", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#ListMLModelTransformJobsInput": { + "type": "structure", + "members": { + "maxItems": { + "target": "com.amazonaws.neptunedata#PositiveInteger", + "traits": { + "smithy.api#documentation": "

The maximum number of items to return (from 1 to 1024; the\n default is 10).

", + "smithy.api#httpQuery": "maxItems", + "smithy.api#range": { + "min": 1, + "max": 1024 + } + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

", + "smithy.api#httpQuery": "neptuneIamRoleArn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#ListMLModelTransformJobsOutput": { + "type": "structure", + "members": { + "ids": { + "target": "com.amazonaws.neptunedata#StringList", + "traits": { + "smithy.api#documentation": "

A page from the list of model transform IDs.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#ListOpenCypherQueries": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#ListOpenCypherQueriesInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#ListOpenCypherQueriesOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#FailureByQueryException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidNumericDataException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#ParsingException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#ReadOnlyViolationException" + }, + { + "target": "com.amazonaws.neptunedata#TimeLimitExceededException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists active openCypher queries. See Neptune\n openCypher status endpoint for more information.

", + "smithy.api#http": { + "method": "GET", + "uri": "/opencypher/status", + "code": 200 + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.neptunedata#ListOpenCypherQueriesInput": { + "type": "structure", + "members": { + "includeWaiting": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

When set to TRUE and other parameters are not\n present, causes status information to be returned for waiting\n queries as well as for running queries.

", + "smithy.api#httpQuery": "includeWaiting" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#ListOpenCypherQueriesOutput": { + "type": "structure", + "members": { + "acceptedQueryCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of queries that have been accepted but not yet completed,\n including queries in the queue.

" + } + }, + "runningQueryCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of currently running openCypher queries.

" + } + }, + "queries": { + "target": "com.amazonaws.neptunedata#OpenCypherQueries", + "traits": { + "smithy.api#documentation": "

A list of current openCypher queries.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#LoadUrlAccessDeniedException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when access is denied to a specified load URL.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptunedata#LoaderIdResult": { + "type": "structure", + "members": { + "loadIds": { + "target": "com.amazonaws.neptunedata#StringList", + "traits": { + "smithy.api#documentation": "

A list of load IDs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains a list of load IDs.

" + } + }, + "com.amazonaws.neptunedata#LongValuedMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#Long" + } + }, + "com.amazonaws.neptunedata#LongValuedMapList": { + "type": "list", + "member": { + "target": "com.amazonaws.neptunedata#LongValuedMap" + } + }, + "com.amazonaws.neptunedata#MLResourceNotFoundException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a specified machine-learning resource could not be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.neptunedata#MalformedQueryException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the malformed query request.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a query is submitted that is syntactically incorrect or does not\n pass additional validation.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptunedata#ManagePropertygraphStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#ManagePropertygraphStatisticsInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#ManagePropertygraphStatisticsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#ReadOnlyViolationException" + }, + { + "target": "com.amazonaws.neptunedata#StatisticsNotAvailableException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Manages the generation and use of property graph statistics.

", + "smithy.api#http": { + "method": "POST", + "uri": "/propertygraph/statistics", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.neptunedata#ManagePropertygraphStatisticsInput": { + "type": "structure", + "members": { + "mode": { + "target": "com.amazonaws.neptunedata#StatisticsAutoGenerationMode", + "traits": { + "smithy.api#documentation": "

The statistics generation mode. One of: DISABLE_AUTOCOMPUTE,\n ENABLE_AUTOCOMPUTE, or REFRESH, the last of\n which manually triggers DFE statistics generation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#ManagePropertygraphStatisticsOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded,\n the code is 200.

", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.neptunedata#RefreshStatisticsIdMap", + "traits": { + "smithy.api#documentation": "

This is only returned for refresh mode.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#ManageSparqlStatistics": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#ManageSparqlStatisticsInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#ManageSparqlStatisticsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#AccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#ReadOnlyViolationException" + }, + { + "target": "com.amazonaws.neptunedata#StatisticsNotAvailableException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Manages the generation and use of RDF graph statistics.

", + "smithy.api#http": { + "method": "POST", + "uri": "/sparql/statistics", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.neptunedata#ManageSparqlStatisticsInput": { + "type": "structure", + "members": { + "mode": { + "target": "com.amazonaws.neptunedata#StatisticsAutoGenerationMode", + "traits": { + "smithy.api#documentation": "

The statistics generation mode. One of: DISABLE_AUTOCOMPUTE,\n ENABLE_AUTOCOMPUTE, or REFRESH, the last of\n which manually triggers DFE statistics generation.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#ManageSparqlStatisticsOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP return code of the request. If the request succeeded,\n the code is 200.

", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.neptunedata#RefreshStatisticsIdMap", + "traits": { + "smithy.api#documentation": "

This is only returned for refresh mode.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#MemoryLimitExceededException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request that failed.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a request fails because of insufficient memory resources. The\n request can be retried.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.neptunedata#MethodNotAllowedException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when the HTTP method used by a request is not supported by the endpoint\n being used.

", + "smithy.api#error": "client", + "smithy.api#httpError": 405 + } + }, + "com.amazonaws.neptunedata#MissingParameterException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in which the parameter is missing.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a required parameter is missing.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptunedata#MlConfigDefinition": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The configuration name.

" + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN for the configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains a Neptune ML configuration.

" + } + }, + "com.amazonaws.neptunedata#MlModels": { + "type": "list", + "member": { + "target": "com.amazonaws.neptunedata#MlConfigDefinition" + } + }, + "com.amazonaws.neptunedata#MlResourceDefinition": { + "type": "structure", + "members": { + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The resource name.

" + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The resource ARN.

" + } + }, + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The resource status.

" + } + }, + "outputLocation": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The output location.

" + } + }, + "failureReason": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The failure reason, in case of a failure.

" + } + }, + "cloudwatchLogUrl": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The CloudWatch log URL for the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines a Neptune ML resource.

" + } + }, + "com.amazonaws.neptunedata#Mode": { + "type": "enum", + "members": { + "RESUME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESUME" + } + }, + "NEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW" + } + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + } + } + }, + "com.amazonaws.neptunedata#Models": { + "type": "list", + "member": { + "target": "com.amazonaws.neptunedata#MlConfigDefinition" + } + }, + "com.amazonaws.neptunedata#NodeLabels": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.neptunedata#NodeProperties": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.neptunedata#NodeStructure": { + "type": "structure", + "members": { + "count": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

Number of nodes that have this specific structure.

" + } + }, + "nodeProperties": { + "target": "com.amazonaws.neptunedata#NodeProperties", + "traits": { + "smithy.api#documentation": "

A list of the node properties present in this specific structure.

" + } + }, + "distinctOutgoingEdgeLabels": { + "target": "com.amazonaws.neptunedata#OutgoingEdgeLabels", + "traits": { + "smithy.api#documentation": "

A list of distinct outgoing edge labels present in this specific structure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A node structure.

" + } + }, + "com.amazonaws.neptunedata#NodeStructures": { + "type": "list", + "member": { + "target": "com.amazonaws.neptunedata#NodeStructure" + } + }, + "com.amazonaws.neptunedata#OpenCypherExplainMode": { + "type": "enum", + "members": { + "STATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "static" + } + }, + "DYNAMIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "dynamic" + } + }, + "DETAILS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "details" + } + } + } + }, + "com.amazonaws.neptunedata#OpenCypherQueries": { + "type": "list", + "member": { + "target": "com.amazonaws.neptunedata#GremlinQueryStatus" + } + }, + "com.amazonaws.neptunedata#OutgoingEdgeLabels": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.neptunedata#Parallelism": { + "type": "enum", + "members": { + "LOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOW" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "HIGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIGH" + } + }, + "OVERSUBSCRIBE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERSUBSCRIBE" + } + } + } + }, + "com.amazonaws.neptunedata#ParsingException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a parsing issue is encountered.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptunedata#PositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.neptunedata#PreconditionsFailedException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a precondition for processing a request is not satisfied.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptunedata#Predicates": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.neptunedata#PropertygraphData": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the Gremlin or openCypher element.

", + "smithy.api#required": {} + } + }, + "type": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of this Gremlin or openCypher element. Must be one of:

\n ", + "smithy.api#required": {} + } + }, + "key": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The property name. For element labels, this is label.

", + "smithy.api#required": {} + } + }, + "value": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

This is a JSON object that contains a value field for the value itself,\n and a datatype field for the JSON data type of that value:

", + "smithy.api#required": {} + } + }, + "from": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

If this is an edge (type = e), the ID of the\n corresponding from vertex or source node.

" + } + }, + "to": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

If this is an edge (type = e), the ID of the\n corresponding to vertex or target node.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A Gremlin or openCypher change record.

" + } + }, + "com.amazonaws.neptunedata#PropertygraphRecord": { + "type": "structure", + "members": { + "commitTimestampInMillis": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The time at which the commit for the transaction was requested,\n in milliseconds from the Unix epoch.

", + "smithy.api#jsonName": "commitTimestamp", + "smithy.api#required": {} + } + }, + "eventId": { + "target": "com.amazonaws.neptunedata#StringValuedMap", + "traits": { + "smithy.api#documentation": "

The sequence identifier of the stream change record.

", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.neptunedata#PropertygraphData", + "traits": { + "smithy.api#documentation": "

The serialized Gremlin or openCypher change record.

", + "smithy.api#required": {} + } + }, + "op": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The operation that created the change.

", + "smithy.api#required": {} + } + }, + "isLastOp": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Only present if this operation is the last one in its transaction.\n If present, it is set to true. It is useful for ensuring that an\n entire transaction is consumed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Structure of a property graph record.

" + } + }, + "com.amazonaws.neptunedata#PropertygraphRecordsList": { + "type": "list", + "member": { + "target": "com.amazonaws.neptunedata#PropertygraphRecord" + } + }, + "com.amazonaws.neptunedata#PropertygraphSummary": { + "type": "structure", + "members": { + "numNodes": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of nodes in the graph.

" + } + }, + "numEdges": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of edges in the graph.

" + } + }, + "numNodeLabels": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of distinct node labels in the graph.

" + } + }, + "numEdgeLabels": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of distinct edge labels in the graph.

" + } + }, + "nodeLabels": { + "target": "com.amazonaws.neptunedata#NodeLabels", + "traits": { + "smithy.api#documentation": "

A list of the distinct node labels in the graph.

" + } + }, + "edgeLabels": { + "target": "com.amazonaws.neptunedata#EdgeLabels", + "traits": { + "smithy.api#documentation": "

A list of the distinct edge labels in the graph.

" + } + }, + "numNodeProperties": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

A list of the distinct node properties in the graph, along\n with the count of nodes where each property is used.

" + } + }, + "numEdgeProperties": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of distinct edge properties in the graph.

" + } + }, + "nodeProperties": { + "target": "com.amazonaws.neptunedata#LongValuedMapList", + "traits": { + "smithy.api#documentation": "

The number of distinct node properties in the graph.

" + } + }, + "edgeProperties": { + "target": "com.amazonaws.neptunedata#LongValuedMapList", + "traits": { + "smithy.api#documentation": "

A list of the distinct edge properties in the graph, along\n with the count of edges where each property is used.

" + } + }, + "totalNodePropertyValues": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The total number of usages of all node properties.

" + } + }, + "totalEdgePropertyValues": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The total number of usages of all edge properties.

" + } + }, + "nodeStructures": { + "target": "com.amazonaws.neptunedata#NodeStructures", + "traits": { + "smithy.api#documentation": "

This field is only present when the requested mode is\n DETAILED. It contains a list of node structures.

" + } + }, + "edgeStructures": { + "target": "com.amazonaws.neptunedata#EdgeStructures", + "traits": { + "smithy.api#documentation": "

This field is only present when the requested mode is\n DETAILED. It contains a list of edge structures.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The graph summary API returns a read-only list of node and edge\n labels and property keys, along with counts of nodes, edges, and\n properties. See Graph\n summary response for a property graph (PG).

" + } + }, + "com.amazonaws.neptunedata#PropertygraphSummaryValueMap": { + "type": "structure", + "members": { + "version": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The version of this graph summary response.

" + } + }, + "lastStatisticsComputationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp, in ISO 8601 format, of the time at which Neptune last computed statistics.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "graphSummary": { + "target": "com.amazonaws.neptunedata#PropertygraphSummary", + "traits": { + "smithy.api#documentation": "

The graph summary.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Payload for the property graph summary response.

" + } + }, + "com.amazonaws.neptunedata#QueryEvalStats": { + "type": "structure", + "members": { + "waited": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Indicates how long the query waited, in milliseconds.

" + } + }, + "elapsed": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The number of milliseconds the query has been running so far.

" + } + }, + "cancelled": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Set to TRUE if the query was cancelled, or FALSE\n otherwise.

" + } + }, + "subqueries": { + "target": "smithy.api#Document", + "traits": { + "smithy.api#documentation": "

The number of subqueries in this query.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Structure to capture query statistics such as how many queries\n are running, accepted or waiting and their details.

" + } + }, + "com.amazonaws.neptunedata#QueryLanguageVersion": { + "type": "structure", + "members": { + "version": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The version of the query language.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Structure for expressing the query language version.

" + } + }, + "com.amazonaws.neptunedata#QueryLimitExceededException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request which exceeded the limit.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when the number of active queries exceeds what the server can process.\n The query in question can be retried when the system is less busy.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.neptunedata#QueryLimitException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request that exceeded the limit.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when the size of a query exceeds the system limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptunedata#QueryTooLargeException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request that is too large.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when the body of a query is too large.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptunedata#RDFGraphSummary": { + "type": "structure", + "members": { + "numDistinctSubjects": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of distinct subjects in the graph.

" + } + }, + "numDistinctPredicates": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of distinct predicates in the graph.

" + } + }, + "numQuads": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of quads in the graph.

" + } + }, + "numClasses": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The number of classes in the graph.

" + } + }, + "classes": { + "target": "com.amazonaws.neptunedata#Classes", + "traits": { + "smithy.api#documentation": "

A list of the classes in the graph.

" + } + }, + "predicates": { + "target": "com.amazonaws.neptunedata#LongValuedMapList", + "traits": { + "smithy.api#documentation": "

\"A list of predicates in the graph, along with the predicate counts.

" + } + }, + "subjectStructures": { + "target": "com.amazonaws.neptunedata#SubjectStructures", + "traits": { + "smithy.api#documentation": "

This field is only present when the request mode is\n DETAILED. It contains a list of subject structures.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The RDF graph summary API returns a read-only list of classes and\n predicate keys, along with counts of quads, subjects, and predicates.

" + } + }, + "com.amazonaws.neptunedata#RDFGraphSummaryValueMap": { + "type": "structure", + "members": { + "version": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The version of this graph summary response.

" + } + }, + "lastStatisticsComputationTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The timestamp, in ISO 8601 format, of the time at which Neptune\n last computed statistics.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "graphSummary": { + "target": "com.amazonaws.neptunedata#RDFGraphSummary", + "traits": { + "smithy.api#documentation": "

The graph summary of an RDF graph. See Graph\n summary response for an RDF graph.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Payload for an RDF graph summary response.

" + } + }, + "com.amazonaws.neptunedata#ReadOnlyViolationException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in which the parameter is missing.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a request attempts to write to a read-only resource.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptunedata#RefreshStatisticsIdMap": { + "type": "structure", + "members": { + "statisticsId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the statistics generation run that is currently occurring.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Statistics for REFRESH mode.

" + } + }, + "com.amazonaws.neptunedata#ReportAsText": { + "type": "blob", + "traits": { + "smithy.api#mediaType": "text/plain" + } + }, + "com.amazonaws.neptunedata#S3BucketRegion": { + "type": "enum", + "members": { + "US_EAST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-1" + } + }, + "US_EAST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-east-2" + } + }, + "US_WEST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-1" + } + }, + "US_WEST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-west-2" + } + }, + "CA_CENTRAL_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ca-central-1" + } + }, + "SA_EAST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "sa-east-1" + } + }, + "EU_NORTH_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-north-1" + } + }, + "EU_WEST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-1" + } + }, + "EU_WEST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-2" + } + }, + "EU_WEST_3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-west-3" + } + }, + "EU_CENTRAL_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "eu-central-1" + } + }, + "ME_SOUTH_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "me-south-1" + } + }, + "AF_SOUTH_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "af-south-1" + } + }, + "AP_EAST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-east-1" + } + }, + "AP_NORTHEAST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-1" + } + }, + "AP_NORTHEAST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-northeast-2" + } + }, + "AP_SOUTHEAST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-1" + } + }, + "AP_SOUTHEAST_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-southeast-2" + } + }, + "AP_SOUTH_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ap-south-1" + } + }, + "CN_NORTH_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-north-1" + } + }, + "CN_NORTHWEST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cn-northwest-1" + } + }, + "US_GOV_WEST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-west-1" + } + }, + "US_GOV_EAST_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "us-gov-east-1" + } + } + } + }, + "com.amazonaws.neptunedata#S3Exception": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when there is a problem accessing Amazon S3.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.neptunedata#ServerShutdownException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when the server shuts down while processing a request.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.neptunedata#SparqlData": { + "type": "structure", + "members": { + "stmt": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Holds an N-QUADS\n statement expressing the changed quad.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Neptune logs are converted to SPARQL quads in the graph using the\n Resource Description Framework (RDF) N-QUADS language defined\n in the W3C RDF 1.1 N-Quads specification

" + } + }, + "com.amazonaws.neptunedata#SparqlRecord": { + "type": "structure", + "members": { + "commitTimestampInMillis": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The time at which the commit for the transaction was requested,\n in milliseconds from the Unix epoch.

", + "smithy.api#jsonName": "commitTimestamp", + "smithy.api#required": {} + } + }, + "eventId": { + "target": "com.amazonaws.neptunedata#StringValuedMap", + "traits": { + "smithy.api#documentation": "

The sequence identifier of the stream change record.

", + "smithy.api#required": {} + } + }, + "data": { + "target": "com.amazonaws.neptunedata#SparqlData", + "traits": { + "smithy.api#documentation": "

The serialized SPARQL change record. The serialization formats\n of each record are described in more detail in Serialization\n Formats in Neptune Streams.

", + "smithy.api#required": {} + } + }, + "op": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The operation that created the change.

", + "smithy.api#required": {} + } + }, + "isLastOp": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Only present if this operation is the last one in its transaction.\n If present, it is set to true. It is useful for ensuring that an\n entire transaction is consumed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A serialized SPARQL stream record capturing a change-log entry\n for the RDF graph.

" + } + }, + "com.amazonaws.neptunedata#SparqlRecordsList": { + "type": "list", + "member": { + "target": "com.amazonaws.neptunedata#SparqlRecord" + } + }, + "com.amazonaws.neptunedata#StartLoaderJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#StartLoaderJobInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#StartLoaderJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#BulkLoadIdNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InternalFailureException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#LoadUrlAccessDeniedException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#S3Exception" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts a Neptune bulk loader job to load data from an Amazon S3\n bucket into a Neptune DB instance. See Using the Amazon Neptune\n Bulk Loader to Ingest Data.

", + "smithy.api#http": { + "method": "POST", + "uri": "/loader", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.neptunedata#StartLoaderJobInput": { + "type": "structure", + "members": { + "source": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The source parameter accepts an S3 URI that identifies a single\n file, multiple files, a folder, or multiple folders. Neptune loads every data file\n in any folder that is specified.

\n

The URI can be in any of the following formats.

\n \n

The object-key-name element of the URI is equivalent to the prefix\n parameter in an S3 ListObjects\n API call. It identifies all the objects in the specified S3 bucket whose names begin with\n that prefix. That can be a single file or folder, or multiple files and/or folders.

\n

The specified folder or folders can contain multiple vertex files and multiple edge files.

", + "smithy.api#required": {} + } + }, + "format": { + "target": "com.amazonaws.neptunedata#Format", + "traits": { + "smithy.api#documentation": "

The format of the data. For more information about data formats for the Neptune\n Loader command, see Load Data Formats.

\n

\n Allowed values\n

\n ", + "smithy.api#required": {} + } + }, + "s3BucketRegion": { + "target": "com.amazonaws.neptunedata#S3BucketRegion", + "traits": { + "smithy.api#documentation": "

The Amazon region of the S3 bucket. This must match the Amazon Region of the DB cluster.

", + "smithy.api#jsonName": "region", + "smithy.api#required": {} + } + }, + "iamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for an IAM role to be assumed by\n the Neptune DB instance for access to the S3 bucket. The IAM role ARN provided\n here should be attached to the DB cluster (see Adding\n the IAM Role to an Amazon Neptune Cluster.

", + "smithy.api#required": {} + } + }, + "mode": { + "target": "com.amazonaws.neptunedata#Mode", + "traits": { + "smithy.api#documentation": "

The load job mode.

\n

\n Allowed values: RESUME, NEW,\n AUTO.

\n

\n Default value: AUTO.

\n

\n \n

\n " + } + }, + "failOnError": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

\n \n failOnError\n   –   A flag to toggle a\n complete stop on an error.

\n

\n Allowed values: \"TRUE\", \"FALSE\".

\n

\n Default value: \"TRUE\".

\n

When this parameter is set to \"FALSE\", the loader tries to load all\n the data in the location specified, skipping any entries with errors.

\n

When this parameter is set to \"TRUE\", the loader stops\n as soon as it encounters an error. Data loaded up to that point persists.

" + } + }, + "parallelism": { + "target": "com.amazonaws.neptunedata#Parallelism", + "traits": { + "smithy.api#documentation": "

The optional parallelism parameter can be set\n to reduce the number of threads used by the bulk load process.

\n

\n Allowed values:

\n \n

\n Default value: HIGH\n

\n

The parallelism setting can sometimes result in a deadlock\n between threads when loading openCypher data. When this happens, Neptune returns the\n LOAD_DATA_DEADLOCK error. You can generally fix the issue by setting\n parallelism to a lower setting and retrying the load command.

" + } + }, + "parserConfiguration": { + "target": "com.amazonaws.neptunedata#StringValuedMap", + "traits": { + "smithy.api#documentation": "

\n \n parserConfiguration\n  \n –   An optional object with additional parser configuration values.\n Each of the child parameters is also optional:

\n

\n \n

\n
    \n
  • \n

    \n \n namedGraphUri\n   –  \n The default graph for all RDF formats when no graph is specified (for non-quads\n formats and NQUAD entries with no graph).

    \n

    The default is https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph.

    \n
    • \n
  • \n

    \n \n baseUri\n   –  \n The base URI for RDF/XML and Turtle formats.

    \n

    The default is https://aws.amazon.com/neptune/default.

    \n
    • \n
  • \n

    \n \n allowEmptyStrings\n   –  \n Gremlin users need to be able to pass empty string values(\"\") as node\n and edge properties when loading CSV data. If allowEmptyStrings\n is set to false (the default), such empty strings are treated\n as nulls and are not loaded.

    \n

    If allowEmptyStrings is set to true,\n the loader treats empty strings as valid property values and loads\n them accordingly.

    \n
    • \n
" + } + }, + "updateSingleCardinalityProperties": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

\n updateSingleCardinalityProperties\n is an optional parameter that controls how the bulk loader treats a new\n value for single-cardinality vertex or edge properties. This is not supported for\n loading openCypher data.

\n

\n Allowed values: \"TRUE\", \"FALSE\".

\n

\n Default value: \"FALSE\".

\n

By default, or when updateSingleCardinalityProperties is explicitly\n set to \"FALSE\", the loader treats a new value as an error, because it\n violates single cardinality.

\n

When updateSingleCardinalityProperties is set to \"TRUE\",\n on the other hand, the bulk loader replaces the existing value with the new one.\n If multiple edge or single-cardinality vertex property values are provided in the\n source file(s) being loaded, the final value at the end of the bulk load could be\n any one of those new values. The loader only guarantees that the existing value\n has been replaced by one of the new ones.

" + } + }, + "queueRequest": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

This is an optional flag parameter\n that indicates whether the load request can be queued up or not.

\n

You don't have to wait for one load job to complete before issuing the next one,\n because Neptune can queue up as many as 64 jobs at a time, provided that their\n queueRequest parameters are all set to \"TRUE\".

\n

If the queueRequest parameter is omitted or set to \"FALSE\",\n the load request will fail if another load job is already running.

\n

\n Allowed values: \"TRUE\", \"FALSE\".

\n

\n Default value: \"FALSE\".

" + } + }, + "dependencies": { + "target": "com.amazonaws.neptunedata#StringList", + "traits": { + "smithy.api#documentation": "

This is an optional parameter that can make a queued load request\n contingent on the successful completion of one or more previous jobs\n in the queue.

\n

Neptune can queue up as many as 64 load requests at a time, if their\n queueRequest parameters are set to \"TRUE\". The\n dependencies parameter lets you make execution of such a queued request\n dependent on the successful completion of one or more specified previous requests\n in the queue.

\n

For example, if load Job-A and Job-B are independent\n of each other, but load Job-C needs Job-A and Job-B\n to be finished before it begins, proceed as follows:

\n
    \n
  1. \n

    Submit load-job-A and load-job-B one after\n another in any order, and save their load-ids.

    \n
    2. \n
  2. \n

    Submit load-job-C with the load-ids of the\n two jobs in its dependencies field:

    \n
    3. \n
\n

Because of the dependencies parameter, the bulk loader will not start\n Job-C until Job-A and Job-B have completed\n successfully. If either one of them fails, Job-C will not be executed, and its\n status will be set to LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED.

\n

You can set up multiple levels of dependency in this way, so that the failure of one job\n will cause all requests that are directly or indirectly dependent on it to be cancelled.

" + } + }, + "userProvidedEdgeIds": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

This parameter is required only when loading openCypher data that contains relationship\n IDs. It must be included and set to True when openCypher relationship IDs\n are explicitly provided in the load data (recommended).

\n

When userProvidedEdgeIds is absent or set to True,\n an :ID column must be present in every relationship file in the load.

\n

When userProvidedEdgeIds is present and set to False,\n relationship files in the load must not contain an\n :ID column. Instead, the Neptune loader automatically generates an\n ID for each relationship.

\n

It's useful to provide relationship IDs explicitly so that the loader can resume\n loading after error in the CSV data have been fixed, without having to reload any\n relationships that have already been loaded. If relationship IDs have not been\n explicitly assigned, the loader cannot resume a failed load if any relationship file\n has had to be corrected, and must instead reload all the relationships.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#StartLoaderJobOutput": { + "type": "structure", + "members": { + "status": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP return code indicating the status of the load job.

", + "smithy.api#required": {} + } + }, + "payload": { + "target": "com.amazonaws.neptunedata#StringValuedMap", + "traits": { + "smithy.api#documentation": "

Contains a loadId name-value pair that provides an identifier\n for the load operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#StartMLDataProcessingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#StartMLDataProcessingJobInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#StartMLDataProcessingJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new Neptune ML data processing job for processing the\n graph data exported from Neptune for training. See The\n dataprocessing command.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ml/dataprocessing", + "code": 200 + } + } + }, + "com.amazonaws.neptunedata#StartMLDataProcessingJobInput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the new job. The default is an autogenerated UUID.

" + } + }, + "previousDataProcessingJobId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The job ID of a completed data processing job run on an earlier version of the data.

" + } + }, + "inputDataS3Location": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The URI of the Amazon S3 location where you want SageMaker to download\n the data needed to run the data processing job.

", + "smithy.api#required": {} + } + }, + "processedDataS3Location": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The URI of the Amazon S3 location where you want SageMaker to save the\n results of a data processing job.

", + "smithy.api#required": {} + } + }, + "sagemakerIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role for SageMaker execution.\n This must be listed in your DB cluster parameter group or an error will occur.

" + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume\n to perform tasks on your behalf. This must be listed in your DB cluster\n parameter group or an error will occur.

" + } + }, + "processingInstanceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of ML instance used during data processing. Its memory\n should be large enough to hold the processed dataset. The default is\n the smallest ml.r5 type whose memory is ten times larger than the size\n of the exported graph data on disk.

" + } + }, + "processingInstanceVolumeSizeInGB": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The disk volume size of the processing instance. Both input data\n and processed data are stored on disk, so the volume size must be large\n enough to hold both data sets. The default is 0. If not specified or 0,\n Neptune ML chooses the volume size automatically based on the data size.

" + } + }, + "processingTimeOutInSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Timeout in seconds for the data processing job. The default is 86,400 (1 day).

" + } + }, + "modelType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

One of the two model types that Neptune ML currently supports:\n heterogeneous graph models (heterogeneous), and knowledge\n graph (kge). The default is none. If not specified,\n Neptune ML chooses the model type automatically based on the data.

" + } + }, + "configFileName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A data specification file that describes how to load the exported\n graph data for training. The file is automatically generated by the\n Neptune export toolkit. The default is\n training-data-configuration.json.

" + } + }, + "subnets": { + "target": "com.amazonaws.neptunedata#StringList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets in the Neptune VPC. The default is None.

" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.neptunedata#StringList", + "traits": { + "smithy.api#documentation": "

The VPC security group IDs. The default is None.

" + } + }, + "volumeEncryptionKMSKey": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to\n encrypt data on the storage volume attached to the ML compute instances\n that run the training job. The default is None.

" + } + }, + "s3OutputEncryptionKMSKey": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Key Management Service (Amazon KMS) key that SageMaker uses\n to encrypt the output of the processing job. The default is none.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#StartMLDataProcessingJobOutput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the new data processing job.

" + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of the data processing job.

" + } + }, + "creationTimeInMillis": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The time it took to create the new processing job, in milliseconds.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#StartMLModelTrainingJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#StartMLModelTrainingJobInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#StartMLModelTrainingJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new Neptune ML model training job. See Model\n training using the modeltraining command.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ml/modeltraining", + "code": 200 + } + } + }, + "com.amazonaws.neptunedata#StartMLModelTrainingJobInput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the new job. The default is An autogenerated UUID.

" + } + }, + "previousModelTrainingJobId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The job ID of a completed model-training job that you want to update\n incrementally based on updated data.

" + } + }, + "dataProcessingJobId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The job ID of the completed data-processing job that has created\n the data that the training will work with.

", + "smithy.api#required": {} + } + }, + "trainModelS3Location": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The location in Amazon S3 where the model artifacts are to be stored.

", + "smithy.api#required": {} + } + }, + "sagemakerIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role for SageMaker execution.This must be listed\n in your DB cluster parameter group or an error will occur.

" + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

" + } + }, + "baseProcessingInstanceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of ML instance used in preparing and managing training\n of ML models. This is a CPU instance chosen based on memory requirements\n for processing the training data and model.

" + } + }, + "trainingInstanceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of ML instance used for model training. All Neptune ML\n models support CPU, GPU, and multiGPU training. The default is\n ml.p3.2xlarge. Choosing the right instance type for\n training depends on the task type, graph size, and your budget.

" + } + }, + "trainingInstanceVolumeSizeInGB": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The disk volume size of the training instance. Both input data\n and the output model are stored on disk, so the volume size must be\n large enough to hold both data sets. The default is 0. If not specified\n or 0, Neptune ML selects a disk volume size based on the recommendation\n generated in the data processing step.

" + } + }, + "trainingTimeOutInSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Timeout in seconds for the training job. The default is 86,400 (1 day).

" + } + }, + "maxHPONumberOfTrainingJobs": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Maximum total number of training jobs to start for the hyperparameter\n tuning job. The default is 2. Neptune ML automatically tunes the hyperparameters\n of the machine learning model. To obtain a model that performs well, use at\n least 10 jobs (in other words, set maxHPONumberOfTrainingJobs to 10).\n In general, the more tuning runs, the better the results.

" + } + }, + "maxHPOParallelTrainingJobs": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Maximum number of parallel training jobs to start for the hyperparameter\n tuning job. The default is 2. The number of parallel jobs you can run is\n limited by the available resources on your training instance.

" + } + }, + "subnets": { + "target": "com.amazonaws.neptunedata#StringList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets in the Neptune VPC. The default is None.

" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.neptunedata#StringList", + "traits": { + "smithy.api#documentation": "

The VPC security group IDs. The default is None.

" + } + }, + "volumeEncryptionKMSKey": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Key Management Service (KMS) key that SageMaker uses to\n encrypt data on the storage volume attached to the ML compute instances\n that run the training job. The default is None.

" + } + }, + "s3OutputEncryptionKMSKey": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Key Management Service (KMS) key that SageMaker uses\n to encrypt the output of the processing job. The default is none.

" + } + }, + "enableManagedSpotTraining": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Optimizes the cost of training machine-learning models by using\n Amazon Elastic Compute Cloud spot instances. The default is False.

" + } + }, + "customModelTrainingParameters": { + "target": "com.amazonaws.neptunedata#CustomModelTrainingParameters", + "traits": { + "smithy.api#documentation": "

The configuration for custom model training. This is a JSON object.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#StartMLModelTrainingJobOutput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the new model training job.

" + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of the new model training job.

" + } + }, + "creationTimeInMillis": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The model training job creation time, in milliseconds.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#StartMLModelTransformJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.neptunedata#StartMLModelTransformJobInput" + }, + "output": { + "target": "com.amazonaws.neptunedata#StartMLModelTransformJobOutput" + }, + "errors": [ + { + "target": "com.amazonaws.neptunedata#BadRequestException" + }, + { + "target": "com.amazonaws.neptunedata#ClientTimeoutException" + }, + { + "target": "com.amazonaws.neptunedata#ConstraintViolationException" + }, + { + "target": "com.amazonaws.neptunedata#IllegalArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidArgumentException" + }, + { + "target": "com.amazonaws.neptunedata#InvalidParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MissingParameterException" + }, + { + "target": "com.amazonaws.neptunedata#MLResourceNotFoundException" + }, + { + "target": "com.amazonaws.neptunedata#PreconditionsFailedException" + }, + { + "target": "com.amazonaws.neptunedata#TooManyRequestsException" + }, + { + "target": "com.amazonaws.neptunedata#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new model transform job. See Use\n a trained model to generate new model artifacts.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ml/modeltransform", + "code": 200 + } + } + }, + "com.amazonaws.neptunedata#StartMLModelTransformJobInput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A unique identifier for the new job. The default is an autogenerated UUID.

" + } + }, + "dataProcessingJobId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The job ID of a completed data-processing job. You must include either\n dataProcessingJobId and a mlModelTrainingJobId,\n or a trainingJobName.

" + } + }, + "mlModelTrainingJobId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The job ID of a completed model-training job. You must include either\n dataProcessingJobId and a mlModelTrainingJobId,\n or a trainingJobName.

" + } + }, + "trainingJobName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The name of a completed SageMaker training job. You must include either\n dataProcessingJobId and a mlModelTrainingJobId,\n or a trainingJobName.

" + } + }, + "modelTransformOutputS3Location": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The location in Amazon S3 where the model artifacts are to be stored.

", + "smithy.api#required": {} + } + }, + "sagemakerIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role for SageMaker execution. This must be listed\n in your DB cluster parameter group or an error will occur.

" + } + }, + "neptuneIamRoleArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of an IAM role that provides Neptune access to SageMaker\n and Amazon S3 resources. This must be listed in your DB cluster\n parameter group or an error will occur.

" + } + }, + "customModelTransformParameters": { + "target": "com.amazonaws.neptunedata#CustomModelTransformParameters", + "traits": { + "smithy.api#documentation": "

Configuration information for a model transform using a custom model.\n The customModelTransformParameters object contains the following\n fields, which must have values compatible with the saved model parameters from\n the training job:

" + } + }, + "baseProcessingInstanceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The type of ML instance used in preparing and managing training of ML models.\n This is an ML compute instance chosen based on memory requirements for processing\n the training data and model.

" + } + }, + "baseProcessingInstanceVolumeSizeInGB": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The disk volume size of the training instance in gigabytes. The default is 0.\n Both input data and the output model are stored on disk, so the volume size must\n be large enough to hold both data sets. If not specified or 0, Neptune ML selects\n a disk volume size based on the recommendation generated in the data processing step.

" + } + }, + "subnets": { + "target": "com.amazonaws.neptunedata#StringList", + "traits": { + "smithy.api#documentation": "

The IDs of the subnets in the Neptune VPC. The default is None.

" + } + }, + "securityGroupIds": { + "target": "com.amazonaws.neptunedata#StringList", + "traits": { + "smithy.api#documentation": "

The VPC security group IDs. The default is None.

" + } + }, + "volumeEncryptionKMSKey": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Key Management Service (KMS) key that SageMaker uses to encrypt data\n on the storage volume attached to the ML compute instances that run the training job.\n The default is None.

" + } + }, + "s3OutputEncryptionKMSKey": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Key Management Service (KMS) key that SageMaker uses to\n encrypt the output of the processing job. The default is none.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.neptunedata#StartMLModelTransformJobOutput": { + "type": "structure", + "members": { + "id": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The unique ID of the new model transform job.

" + } + }, + "arn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ARN of the model transform job.

" + } + }, + "creationTimeInMillis": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The creation time of the model transform job, in milliseconds.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.neptunedata#Statistics": { + "type": "structure", + "members": { + "autoCompute": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether or not automatic statistics generation is enabled.

" + } + }, + "active": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Indicates whether or not DFE statistics generation is enabled at all.

" + } + }, + "statisticsId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Reports the ID of the current statistics generation run.\n A value of -1 indicates that no statistics have been generated.

" + } + }, + "date": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The UTC time at which DFE statistics have most recently been generated.

", + "smithy.api#timestampFormat": "date-time" + } + }, + "note": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A note about problems in the case where statistics are invalid.

" + } + }, + "signatureInfo": { + "target": "com.amazonaws.neptunedata#StatisticsSummary", + "traits": { + "smithy.api#documentation": "

A StatisticsSummary structure that contains:

\n
    \n
  • \n

    \n signatureCount - The total number of signatures\n across all characteristic sets.

    \n
    • \n
  • \n

    \n instanceCount - The total number of\n characteristic-set instances.

    \n
    • \n
  • \n

    \n predicateCount - The total number of unique predicates.

    \n
    • \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "

Contains statistics information. The DFE engine uses information\n about the data in your Neptune graph to make effective trade-offs when\n planning query execution. This information takes the form of statistics\n that include so-called characteristic sets and predicate statistics\n that can guide query planning. See Managing\n statistics for the Neptune DFE to use.

" + } + }, + "com.amazonaws.neptunedata#StatisticsAutoGenerationMode": { + "type": "enum", + "members": { + "DISABLE_AUTOCOMPUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "disableAutoCompute" + } + }, + "ENABLE_AUTOCOMPUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "enableAutoCompute" + } + }, + "REFRESH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "refresh" + } + } + } + }, + "com.amazonaws.neptunedata#StatisticsNotAvailableException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when statistics needed to satisfy a request are not available.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.neptunedata#StatisticsSummary": { + "type": "structure", + "members": { + "signatureCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The total number of signatures across all characteristic sets.

" + } + }, + "instanceCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The total number of characteristic-set instances.

" + } + }, + "predicateCount": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The total number of unique predicates.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the characteristic sets generated in the statistics.

" + } + }, + "com.amazonaws.neptunedata#StreamRecordsNotFoundException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when stream records requested by a query cannot be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.neptunedata#StringList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.neptunedata#StringValuedMap": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.neptunedata#SubjectStructure": { + "type": "structure", + "members": { + "count": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

Number of occurrences of this specific structure.

" + } + }, + "predicates": { + "target": "com.amazonaws.neptunedata#Predicates", + "traits": { + "smithy.api#documentation": "

A list of predicates present in this specific structure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A subject structure.

" + } + }, + "com.amazonaws.neptunedata#SubjectStructures": { + "type": "list", + "member": { + "target": "com.amazonaws.neptunedata#SubjectStructure" + } + }, + "com.amazonaws.neptunedata#ThrottlingException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request that could not be processed for this reason.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when the rate of requests exceeds the maximum throughput. Requests can\n be retried after encountering this exception.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.neptunedata#TimeLimitExceededException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request that could not be processed for this reason.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when the an operation exceeds the time limit allowed for it.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.neptunedata#TooManyRequestsException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request that could not be processed for this reason.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when the number of requests being processed exceeds the limit.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.neptunedata#UnsupportedOperationException": { + "type": "structure", + "members": { + "detailedMessage": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

A detailed message describing the problem.

", + "smithy.api#required": {} + } + }, + "requestId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The ID of the request in question.

", + "smithy.api#required": {} + } + }, + "code": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The HTTP status code returned with the exception.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Raised when a request attempts to initiate an operation that is not supported.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/network-firewall.json b/codegen/sdk-codegen/aws-models/network-firewall.json index 5f5c6ef95f1..288cc7c81cc 100644 --- a/codegen/sdk-codegen/aws-models/network-firewall.json +++ b/codegen/sdk-codegen/aws-models/network-firewall.json @@ -817,18 +817,24 @@ "target": "com.amazonaws.networkfirewall#CreateTLSInspectionConfigurationResponse" }, "errors": [ + { + "target": "com.amazonaws.networkfirewall#InsufficientCapacityException" + }, { "target": "com.amazonaws.networkfirewall#InternalServerError" }, { "target": "com.amazonaws.networkfirewall#InvalidRequestException" }, + { + "target": "com.amazonaws.networkfirewall#LimitExceededException" + }, { "target": "com.amazonaws.networkfirewall#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "

Creates an Network Firewall TLS inspection configuration. A TLS inspection configuration contains the Certificate Manager certificate references that Network Firewall uses to decrypt and re-encrypt inbound traffic.

\n

After you create a TLS inspection configuration, you associate it with a firewall policy.

\n

To update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.

\n

To manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

\n

To retrieve information about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration.

\n

\n For more information about TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS\ninspection configurations in the Network Firewall Developer Guide.\n

" + "smithy.api#documentation": "

Creates an Network Firewall TLS inspection configuration. A TLS inspection configuration contains the Certificate Manager certificate references that Network Firewall uses to decrypt and re-encrypt inbound traffic.

\n

After you create a TLS inspection configuration, you associate it with a new firewall policy.

\n

To update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.

\n

To manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.

\n

To retrieve information about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration.

\n

\n For more information about TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS\ninspection configurations in the Network Firewall Developer Guide.\n

" } }, "com.amazonaws.networkfirewall#CreateTLSInspectionConfigurationRequest": { @@ -844,7 +850,7 @@ "TLSInspectionConfiguration": { "target": "com.amazonaws.networkfirewall#TLSInspectionConfiguration", "traits": { - "smithy.api#documentation": "

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

\n

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

\n

To use a TLS inspection configuration, you add it to a Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS\ninspection configurations in the Network Firewall Developer Guide.

", + "smithy.api#documentation": "

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

\n

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

\n

To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS\ninspection configurations in the Network Firewall Developer Guide.

", "smithy.api#required": {} } }, @@ -1743,7 +1749,7 @@ "TLSInspectionConfiguration": { "target": "com.amazonaws.networkfirewall#TLSInspectionConfiguration", "traits": { - "smithy.api#documentation": "

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

\n

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

\n

To use a TLS inspection configuration, you add it to a Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS\ninspection configurations in the Network Firewall Developer Guide.

" + "smithy.api#documentation": "

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

\n

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

\n

To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS\ninspection configurations in the Network Firewall Developer Guide.

" } }, "TLSInspectionConfigurationResponse": { @@ -3327,52 +3333,56 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, { - "conditions": [], + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], "type": "tree", @@ -3380,13 +3390,22 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], "type": "tree", @@ -3396,224 +3415,175 @@ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://network-firewall-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://network-firewall-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://network-firewall-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsFIPS" ] } ] - }, + } + ], + "type": "tree", + "rules": [ { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://network-firewall-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://network-firewall.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [], "endpoint": { - "url": "https://network-firewall.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://network-firewall.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://network-firewall.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" } ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] }, @@ -4299,7 +4269,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 2048 + "max": 4096 }, "smithy.api#pattern": "^[0-9A-Za-z:\\/+=]+$" } @@ -4864,14 +4834,14 @@ "Keyword": { "target": "com.amazonaws.networkfirewall#Keyword", "traits": { - "smithy.api#documentation": "

", + "smithy.api#documentation": "

The keyword for the Suricata compatible rule option. You must include a sid (signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see Rule options in the Suricata documentation.

", "smithy.api#required": {} } }, "Settings": { "target": "com.amazonaws.networkfirewall#Settings", "traits": { - "smithy.api#documentation": "

" + "smithy.api#documentation": "

The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the Keyword. For more information about the settings for specific options, see Rule options.

" } } }, @@ -4956,7 +4926,7 @@ "StatefulRules": { "target": "com.amazonaws.networkfirewall#StatefulRules", "traits": { - "smithy.api#documentation": "

An array of individual stateful rules inspection criteria to be used together in a stateful rule group.\n Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options.\n For information about the Suricata Rules format, see\n Rules Format.

" + "smithy.api#documentation": "

An array of individual stateful rules inspection criteria to be used together in a stateful rule group.\n Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options.\n For information about the Suricata Rules format, see\n Rules Format.

" } }, "StatelessRulesAndCustomActions": { @@ -5205,7 +5175,7 @@ "Action": { "target": "com.amazonaws.networkfirewall#StatefulAction", "traits": { - "smithy.api#documentation": "

Defines what Network Firewall should do with the packets in a traffic flow when the flow\n matches the stateful rule criteria. For all actions, Network Firewall performs the specified\n action and discontinues stateful inspection of the traffic flow.

\n

The actions for a stateful rule are defined as follows:

\n
    \n
  • \n

    \n PASS - Permits the packets to go to the\n intended destination.

    \n
    • \n
  • \n

    \n DROP - Blocks the packets from going to\n the intended destination and sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.

    \n
    • \n
  • \n

    \n ALERT - Permits the packets to go to the\n intended destination and sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.

    \n

    You can use this action to test a rule that you intend to use to drop traffic. You\n can enable the rule with ALERT action, verify in the logs that the rule\n is filtering as you want, then change the action to DROP.

    \n
    • \n
  • \n

    \n REJECT - Drops TCP traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a RST bit contained in the TCP header flags. Also sends an alert log mesage if alert logging is configured in the Firewall\n LoggingConfiguration.

    \n

    \n REJECT isn't currently available for use with IMAP and FTP protocols.

    \n
    • \n
", + "smithy.api#documentation": "

Defines what Network Firewall should do with the packets in a traffic flow when the flow\n matches the stateful rule criteria. For all actions, Network Firewall performs the specified\n action and discontinues stateful inspection of the traffic flow.

\n

The actions for a stateful rule are defined as follows:

\n
    \n
  • \n

    \n PASS - Permits the packets to go to the\n intended destination.

    \n
    • \n
  • \n

    \n DROP - Blocks the packets from going to\n the intended destination and sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.

    \n
    • \n
  • \n

    \n ALERT - Permits the packets to go to the\n intended destination and sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.

    \n

    You can use this action to test a rule that you intend to use to drop traffic. You\n can enable the rule with ALERT action, verify in the logs that the rule\n is filtering as you want, then change the action to DROP.

    \n
    • \n
", "smithy.api#required": {} } }, @@ -5225,7 +5195,7 @@ } }, "traits": { - "smithy.api#documentation": "

A single Suricata rules specification, for use in a stateful rule group.\n Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options.\n For information about the Suricata Rules format, see\n Rules Format.

" + "smithy.api#documentation": "

A single Suricata rules specification, for use in a stateful rule group.\n Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options.\n For information about the Suricata Rules format, see\n Rules Format.

" } }, "com.amazonaws.networkfirewall#StatefulRuleDirection": { @@ -5709,7 +5679,7 @@ } }, "traits": { - "smithy.api#documentation": "

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

\n

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

\n

To use a TLS inspection configuration, you add it to a Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS\ninspection configurations in the Network Firewall Developer Guide.

" + "smithy.api#documentation": "

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

\n

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

\n

To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS\ninspection configurations in the Network Firewall Developer Guide.

" } }, "com.amazonaws.networkfirewall#TLSInspectionConfigurationMetadata": { @@ -6508,7 +6478,7 @@ "FirewallPolicy": { "target": "com.amazonaws.networkfirewall#FirewallPolicy", "traits": { - "smithy.api#documentation": "

The updated firewall policy to use for the firewall.

", + "smithy.api#documentation": "

The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another TLSInspectionConfiguration.

", "smithy.api#required": {} } }, @@ -6906,7 +6876,7 @@ "TLSInspectionConfiguration": { "target": "com.amazonaws.networkfirewall#TLSInspectionConfiguration", "traits": { - "smithy.api#documentation": "

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

\n

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

\n

To use a TLS inspection configuration, you add it to a Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS\ninspection configurations in the Network Firewall Developer Guide.

", + "smithy.api#documentation": "

The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

\n

Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

\n

To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS\ninspection configurations in the Network Firewall Developer Guide.

", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/pca-connector-ad.json b/codegen/sdk-codegen/aws-models/pca-connector-ad.json new file mode 100644 index 00000000000..4c5f430d38d --- /dev/null +++ b/codegen/sdk-codegen/aws-models/pca-connector-ad.json @@ -0,0 +1,5686 @@ +{ + "smithy": "2.0", + "shapes": { + "com.amazonaws.pcaconnectorad#AccessControlEntry": { + "type": "structure", + "members": { + "GroupDisplayName": { + "target": "com.amazonaws.pcaconnectorad#DisplayName", + "traits": { + "smithy.api#documentation": "

Name of the Active Directory group. This name does not need to match the group name in Active Directory.

" + } + }, + "GroupSecurityIdentifier": { + "target": "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier", + "traits": { + "smithy.api#documentation": "

Security identifier (SID) of the group object from Active Directory. The SID starts with\n \"S-\".

" + } + }, + "AccessRights": { + "target": "com.amazonaws.pcaconnectorad#AccessRights", + "traits": { + "smithy.api#documentation": "

Permissions to allow or deny an Active Directory group to enroll or autoenroll certificates issued\n against a template.

" + } + }, + "TemplateArn": { + "target": "com.amazonaws.pcaconnectorad#TemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the Access Control Entry was created.

" + } + }, + "UpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the Access Control Entry was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An access control entry allows or denies Active Directory groups based on their security\n identifiers (SIDs) from enrolling and/or autoenrolling with the template.

" + } + }, + "com.amazonaws.pcaconnectorad#AccessControlEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcaconnectorad#AccessControlEntrySummary" + } + }, + "com.amazonaws.pcaconnectorad#AccessControlEntrySummary": { + "type": "structure", + "members": { + "GroupDisplayName": { + "target": "com.amazonaws.pcaconnectorad#DisplayName", + "traits": { + "smithy.api#documentation": "

Name of the Active Directory group. This name does not need to match the group name in Active Directory.

" + } + }, + "GroupSecurityIdentifier": { + "target": "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier", + "traits": { + "smithy.api#documentation": "

Security identifier (SID) of the group object from Active Directory. The SID starts with\n \"S-\".

" + } + }, + "AccessRights": { + "target": "com.amazonaws.pcaconnectorad#AccessRights", + "traits": { + "smithy.api#documentation": "

Allow or deny an Active Directory group from enrolling and autoenrolling certificates issued against\n a template.

" + } + }, + "TemplateArn": { + "target": "com.amazonaws.pcaconnectorad#TemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the Access Control Entry was created.

" + } + }, + "UpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the Access Control Entry was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary of group access control entries that allow or deny Active Directory groups based on their\n security identifiers (SIDs) from enrolling and/or autofenrolling with the template.

" + } + }, + "com.amazonaws.pcaconnectorad#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

You can receive this error if you attempt to create a resource share when you don't have\n the required permissions. This can be caused by insufficient permissions in policies\n attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen\n because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP)\n that affects your Amazon Web Services account.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.pcaconnectorad#AccessRight": { + "type": "enum", + "members": { + "ALLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALLOW" + } + }, + "DENY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY" + } + } + } + }, + "com.amazonaws.pcaconnectorad#AccessRights": { + "type": "structure", + "members": { + "Enroll": { + "target": "com.amazonaws.pcaconnectorad#AccessRight", + "traits": { + "smithy.api#documentation": "

Allow or deny an Active Directory group from enrolling certificates issued against a\n template.

" + } + }, + "AutoEnroll": { + "target": "com.amazonaws.pcaconnectorad#AccessRight", + "traits": { + "smithy.api#documentation": "

Allow or deny an Active Directory group from autoenrolling certificates issued against a template.\n The Active Directory group must be allowed to enroll to allow autoenrollment

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a\n template.

" + } + }, + "com.amazonaws.pcaconnectorad#ApplicationPolicies": { + "type": "structure", + "members": { + "Critical": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Marks the application policy extension as critical.

" + } + }, + "Policies": { + "target": "com.amazonaws.pcaconnectorad#ApplicationPolicyList", + "traits": { + "smithy.api#documentation": "

Application policies describe what the certificate can be used for.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Application policies describe what the certificate can be used for.

" + } + }, + "com.amazonaws.pcaconnectorad#ApplicationPolicy": { + "type": "union", + "members": { + "PolicyType": { + "target": "com.amazonaws.pcaconnectorad#ApplicationPolicyType", + "traits": { + "smithy.api#documentation": "

The type of application policy

" + } + }, + "PolicyObjectIdentifier": { + "target": "com.amazonaws.pcaconnectorad#CustomObjectIdentifier", + "traits": { + "smithy.api#documentation": "

The object identifier (OID) of an application policy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Application policies describe what the certificate can be used for.

" + } + }, + "com.amazonaws.pcaconnectorad#ApplicationPolicyList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcaconnectorad#ApplicationPolicy" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.pcaconnectorad#ApplicationPolicyType": { + "type": "enum", + "members": { + "ALL_APPLICATION_POLICIES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_APPLICATION_POLICIES" + } + }, + "ANY_PURPOSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANY_PURPOSE" + } + }, + "ATTESTATION_IDENTITY_KEY_CERTIFICATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTESTATION_IDENTITY_KEY_CERTIFICATE" + } + }, + "CERTIFICATE_REQUEST_AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CERTIFICATE_REQUEST_AGENT" + } + }, + "CLIENT_AUTHENTICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIENT_AUTHENTICATION" + } + }, + "CODE_SIGNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CODE_SIGNING" + } + }, + "CTL_USAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CTL_USAGE" + } + }, + "DIGITAL_RIGHTS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIGITAL_RIGHTS" + } + }, + "DIRECTORY_SERVICE_EMAIL_REPLICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY_SERVICE_EMAIL_REPLICATION" + } + }, + "DISALLOWED_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISALLOWED_LIST" + } + }, + "DNS_SERVER_TRUST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DNS_SERVER_TRUST" + } + }, + "DOCUMENT_ENCRYPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT_ENCRYPTION" + } + }, + "DOCUMENT_SIGNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOCUMENT_SIGNING" + } + }, + "DYNAMIC_CODE_GENERATOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DYNAMIC_CODE_GENERATOR" + } + }, + "EARLY_LAUNCH_ANTIMALWARE_DRIVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EARLY_LAUNCH_ANTIMALWARE_DRIVER" + } + }, + "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMBEDDED_WINDOWS_SYSTEM_COMPONENT_VERIFICATION" + } + }, + "ENCLAVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCLAVE" + } + }, + "ENCRYPTING_FILE_SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENCRYPTING_FILE_SYSTEM" + } + }, + "ENDORSEMENT_KEY_CERTIFICATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDORSEMENT_KEY_CERTIFICATE" + } + }, + "FILE_RECOVERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILE_RECOVERY" + } + }, + "HAL_EXTENSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HAL_EXTENSION" + } + }, + "IP_SECURITY_END_SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_SECURITY_END_SYSTEM" + } + }, + "IP_SECURITY_IKE_INTERMEDIATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_SECURITY_IKE_INTERMEDIATE" + } + }, + "IP_SECURITY_TUNNEL_TERMINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_SECURITY_TUNNEL_TERMINATION" + } + }, + "IP_SECURITY_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_SECURITY_USER" + } + }, + "ISOLATED_USER_MODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ISOLATED_USER_MODE" + } + }, + "KDC_AUTHENTICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KDC_AUTHENTICATION" + } + }, + "KERNEL_MODE_CODE_SIGNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KERNEL_MODE_CODE_SIGNING" + } + }, + "KEY_PACK_LICENSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY_PACK_LICENSES" + } + }, + "KEY_RECOVERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY_RECOVERY" + } + }, + "KEY_RECOVERY_AGENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY_RECOVERY_AGENT" + } + }, + "LICENSE_SERVER_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LICENSE_SERVER_VERIFICATION" + } + }, + "LIFETIME_SIGNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIFETIME_SIGNING" + } + }, + "MICROSOFT_PUBLISHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MICROSOFT_PUBLISHER" + } + }, + "MICROSOFT_TIME_STAMPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MICROSOFT_TIME_STAMPING" + } + }, + "MICROSOFT_TRUST_LIST_SIGNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MICROSOFT_TRUST_LIST_SIGNING" + } + }, + "OCSP_SIGNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OCSP_SIGNING" + } + }, + "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OEM_WINDOWS_SYSTEM_COMPONENT_VERIFICATION" + } + }, + "PLATFORM_CERTIFICATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLATFORM_CERTIFICATE" + } + }, + "PREVIEW_BUILD_SIGNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREVIEW_BUILD_SIGNING" + } + }, + "PRIVATE_KEY_ARCHIVAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIVATE_KEY_ARCHIVAL" + } + }, + "PROTECTED_PROCESS_LIGHT_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROTECTED_PROCESS_LIGHT_VERIFICATION" + } + }, + "PROTECTED_PROCESS_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PROTECTED_PROCESS_VERIFICATION" + } + }, + "QUALIFIED_SUBORDINATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUALIFIED_SUBORDINATION" + } + }, + "REVOKED_LIST_SIGNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REVOKED_LIST_SIGNER" + } + }, + "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROOT_PROGRAM_AUTO_UPDATE_CA_REVOCATION" + } + }, + "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROOT_PROGRAM_AUTO_UPDATE_END_REVOCATION" + } + }, + "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROOT_PROGRAM_NO_OSCP_FAILOVER_TO_CRL" + } + }, + "ROOT_LIST_SIGNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROOT_LIST_SIGNER" + } + }, + "SECURE_EMAIL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECURE_EMAIL" + } + }, + "SERVER_AUTHENTICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVER_AUTHENTICATION" + } + }, + "SMART_CARD_LOGIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMART_CARD_LOGIN" + } + }, + "SPC_ENCRYPTED_DIGEST_RETRY_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPC_ENCRYPTED_DIGEST_RETRY_COUNT" + } + }, + "SPC_RELAXED_PE_MARKER_CHECK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPC_RELAXED_PE_MARKER_CHECK" + } + }, + "TIME_STAMPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIME_STAMPING" + } + }, + "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_HARDWARE_DRIVER_ATTESTED_VERIFICATION" + } + }, + "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_HARDWARE_DRIVER_EXTENDED_VERIFICATION" + } + }, + "WINDOWS_HARDWARE_DRIVER_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_HARDWARE_DRIVER_VERIFICATION" + } + }, + "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_HELLO_RECOVERY_KEY_ENCRYPTION" + } + }, + "WINDOWS_KITS_COMPONENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_KITS_COMPONENT" + } + }, + "WINDOWS_RT_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_RT_VERIFICATION" + } + }, + "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SOFTWARE_EXTENSION_VERIFICATION" + } + }, + "WINDOWS_STORE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_STORE" + } + }, + "WINDOWS_SYSTEM_COMPONENT_VERIFICATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SYSTEM_COMPONENT_VERIFICATION" + } + }, + "WINDOWS_TCB_COMPONENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_TCB_COMPONENT" + } + }, + "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_THIRD_PARTY_APPLICATION_COMPONENT" + } + }, + "WINDOWS_UPDATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_UPDATE" + } + } + } + }, + "com.amazonaws.pcaconnectorad#CertificateAuthorityArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 200 + }, + "smithy.api#pattern": "^arn:[\\w-]+:acm-pca:[\\w-]+:[0-9]+:certificate-authority\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.pcaconnectorad#CertificateValidity": { + "type": "structure", + "members": { + "ValidityPeriod": { + "target": "com.amazonaws.pcaconnectorad#ValidityPeriod", + "traits": { + "smithy.api#documentation": "

Information describing the end of the validity period of the certificate. This parameter\n sets the “Not After” date for the certificate. Certificate validity is the period of time\n during which a certificate is valid. Validity can be expressed as an explicit date and time\n when the certificate expires, or as a span of time after issuance, stated in days, months,\n or years. For more information, see Validity in RFC 5280. This value is unaffected when\n ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the\n future, the certificate will expire 20 days from issuance time regardless of the\n ValidityNotBefore value.

", + "smithy.api#required": {} + } + }, + "RenewalPeriod": { + "target": "com.amazonaws.pcaconnectorad#ValidityPeriod", + "traits": { + "smithy.api#documentation": "

Renewal period is the period of time before certificate expiration when a new\n certificate will be requested.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information describing the end of the validity period of the certificate. This parameter\n sets the “Not After” date for the certificate. Certificate validity is the period of time\n during which a certificate is valid. Validity can be expressed as an explicit date and time\n when the certificate expires, or as a span of time after issuance, stated in days, months,\n or years. For more information, see Validity in RFC 5280. This value is unaffected when\n ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the\n future, the certificate will expire 20 days from issuance time regardless of the\n ValidityNotBefore value.

" + } + }, + "com.amazonaws.pcaconnectorad#ClientCompatibilityV2": { + "type": "enum", + "members": { + "WINDOWS_SERVER_2003": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2003" + } + }, + "WINDOWS_SERVER_2008": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2008" + } + }, + "WINDOWS_SERVER_2008_R2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2008_R2" + } + }, + "WINDOWS_SERVER_2012": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2012" + } + }, + "WINDOWS_SERVER_2012_R2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2012_R2" + } + }, + "WINDOWS_SERVER_2016": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2016" + } + } + } + }, + "com.amazonaws.pcaconnectorad#ClientCompatibilityV3": { + "type": "enum", + "members": { + "WINDOWS_SERVER_2008": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2008" + } + }, + "WINDOWS_SERVER_2008_R2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2008_R2" + } + }, + "WINDOWS_SERVER_2012": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2012" + } + }, + "WINDOWS_SERVER_2012_R2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2012_R2" + } + }, + "WINDOWS_SERVER_2016": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2016" + } + } + } + }, + "com.amazonaws.pcaconnectorad#ClientCompatibilityV4": { + "type": "enum", + "members": { + "WINDOWS_SERVER_2012": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2012" + } + }, + "WINDOWS_SERVER_2012_R2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2012_R2" + } + }, + "WINDOWS_SERVER_2016": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WINDOWS_SERVER_2016" + } + } + } + }, + "com.amazonaws.pcaconnectorad#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[!-~]+$" + } + }, + "com.amazonaws.pcaconnectorad#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Web Services resource.

", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The resource type, which can be one of Connector, Template, TemplateGroupAccessControlEntry, ServicePrincipalName, or DirectoryRegistration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

This request cannot be completed for one of the following reasons because the requested\n resource was being concurrently modified by another request.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.pcaconnectorad#Connector": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

" + } + }, + "CertificateAuthorityArn": { + "target": "com.amazonaws.pcaconnectorad#CertificateAuthorityArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate authority being used.

" + } + }, + "CertificateEnrollmentPolicyServerEndpoint": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Certificate enrollment endpoint for Active Directory domain-joined objects reach out to when\n requesting certificates.

" + } + }, + "DirectoryId": { + "target": "com.amazonaws.pcaconnectorad#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the Active Directory.

" + } + }, + "VpcInformation": { + "target": "com.amazonaws.pcaconnectorad#VpcInformation", + "traits": { + "smithy.api#documentation": "

Information of the VPC and security group(s) used with the connector.

" + } + }, + "Status": { + "target": "com.amazonaws.pcaconnectorad#ConnectorStatus", + "traits": { + "smithy.api#documentation": "

Status of the connector. Status can be creating, active, deleting, or failed.

" + } + }, + "StatusReason": { + "target": "com.amazonaws.pcaconnectorad#ConnectorStatusReason", + "traits": { + "smithy.api#documentation": "

Additional information about the connector status if the status is failed.

" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the connector was created.

" + } + }, + "UpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the connector was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon Web Services Private CA Connector for Active Directory is a service that links your Active Directory with Amazon Web Services Private CA. The connector brokers the\n exchange of certificates from Amazon Web Services Private CA to domain-joined users and machines managed with\n Active Directory.

" + } + }, + "com.amazonaws.pcaconnectorad#ConnectorArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 200 + }, + "smithy.api#pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.pcaconnectorad#ConnectorList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcaconnectorad#ConnectorSummary" + } + }, + "com.amazonaws.pcaconnectorad#ConnectorResource": { + "type": "resource", + "identifiers": { + "ConnectorArn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn" + } + }, + "create": { + "target": "com.amazonaws.pcaconnectorad#CreateConnector" + }, + "read": { + "target": "com.amazonaws.pcaconnectorad#GetConnector" + }, + "delete": { + "target": "com.amazonaws.pcaconnectorad#DeleteConnector" + }, + "list": { + "target": "com.amazonaws.pcaconnectorad#ListConnectors" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Connector" + } + } + }, + "com.amazonaws.pcaconnectorad#ConnectorStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.pcaconnectorad#ConnectorStatusReason": { + "type": "enum", + "members": { + "DIRECTORY_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY_ACCESS_DENIED" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_FAILURE" + } + }, + "PRIVATECA_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIVATECA_ACCESS_DENIED" + } + }, + "PRIVATECA_RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIVATECA_RESOURCE_NOT_FOUND" + } + }, + "SECURITY_GROUP_NOT_IN_VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECURITY_GROUP_NOT_IN_VPC" + } + }, + "VPC_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_ACCESS_DENIED" + } + }, + "VPC_ENDPOINT_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_ENDPOINT_LIMIT_EXCEEDED" + } + }, + "VPC_RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_RESOURCE_NOT_FOUND" + } + } + } + }, + "com.amazonaws.pcaconnectorad#ConnectorSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

" + } + }, + "CertificateAuthorityArn": { + "target": "com.amazonaws.pcaconnectorad#CertificateAuthorityArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate authority being used.

" + } + }, + "CertificateEnrollmentPolicyServerEndpoint": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Certificate enrollment endpoint for Active Directory domain-joined objects to request\n certificates.

" + } + }, + "DirectoryId": { + "target": "com.amazonaws.pcaconnectorad#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the Active Directory.

" + } + }, + "VpcInformation": { + "target": "com.amazonaws.pcaconnectorad#VpcInformation", + "traits": { + "smithy.api#documentation": "

Information of the VPC and security group(s) used with the connector.

" + } + }, + "Status": { + "target": "com.amazonaws.pcaconnectorad#ConnectorStatus", + "traits": { + "smithy.api#documentation": "

Status of the connector. Status can be creating, active, deleting, or failed.

" + } + }, + "StatusReason": { + "target": "com.amazonaws.pcaconnectorad#ConnectorStatusReason", + "traits": { + "smithy.api#documentation": "

Additional information about the connector status if the status is failed.

" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the connector was created.

" + } + }, + "UpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the connector was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary description of the Amazon Web Services Private CA AD connectors belonging to an Amazon Web Services\n account.

" + } + }, + "com.amazonaws.pcaconnectorad#CreateConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#CreateConnectorRequest" + }, + "output": { + "target": "com.amazonaws.pcaconnectorad#CreateConnectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ConflictException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a connector between Amazon Web Services Private CA and an Active Directory. You must specify the private CA,\n directory ID, and security groups.

", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/connectors" + } + } + }, + "com.amazonaws.pcaconnectorad#CreateConnectorRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.pcaconnectorad#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the Active Directory.

", + "smithy.api#required": {} + } + }, + "CertificateAuthorityArn": { + "target": "com.amazonaws.pcaconnectorad#CertificateAuthorityArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate authority being used.

", + "smithy.api#required": {} + } + }, + "VpcInformation": { + "target": "com.amazonaws.pcaconnectorad#VpcInformation", + "traits": { + "smithy.api#documentation": "

Security group IDs that describe the inbound and outbound rules.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.pcaconnectorad#ClientToken", + "traits": { + "smithy.api#documentation": "

Idempotency token.

", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.pcaconnectorad#Tags", + "traits": { + "aws.cloudformation#cfnMutability": "write", + "smithy.api#documentation": "

Metadata assigned to a connector consisting of a key-value pair.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#CreateConnectorResponse": { + "type": "structure", + "members": { + "ConnectorArn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn", + "traits": { + "smithy.api#documentation": "

If successful, the Amazon Resource Name (ARN) of the connector for Active Directory.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcaconnectorad#CreateDirectoryRegistration": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#CreateDirectoryRegistrationRequest" + }, + "output": { + "target": "com.amazonaws.pcaconnectorad#CreateDirectoryRegistrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ConflictException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an\n Active Directory

", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/directoryRegistrations" + } + } + }, + "com.amazonaws.pcaconnectorad#CreateDirectoryRegistrationRequest": { + "type": "structure", + "members": { + "DirectoryId": { + "target": "com.amazonaws.pcaconnectorad#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the Active Directory.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.pcaconnectorad#ClientToken", + "traits": { + "smithy.api#documentation": "

Idempotency token.

", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.pcaconnectorad#Tags", + "traits": { + "aws.cloudformation#cfnMutability": "write", + "smithy.api#documentation": "

Metadata assigned to a directory registration consisting of a key-value pair.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#CreateDirectoryRegistrationResponse": { + "type": "structure", + "members": { + "DirectoryRegistrationArn": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcaconnectorad#CreateServicePrincipalName": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#CreateServicePrincipalNameRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ConflictException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a service principal name (SPN) for the service account in Active Directory. Kerberos\n authentication uses SPNs to associate a service instance with a service sign-in\n account.

", + "smithy.api#http": { + "code": 202, + "method": "POST", + "uri": "/directoryRegistrations/{DirectoryRegistrationArn}/servicePrincipalNames/{ConnectorArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.pcaconnectorad#CreateServicePrincipalNameRequest": { + "type": "structure", + "members": { + "DirectoryRegistrationArn": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ConnectorArn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.pcaconnectorad#ClientToken", + "traits": { + "smithy.api#documentation": "

Idempotency token.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#CreateTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#CreateTemplateRequest" + }, + "output": { + "target": "com.amazonaws.pcaconnectorad#CreateTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ConflictException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Active Directory compatible certificate template. The connectors issues certificates\n using these templates based on the requester’s Active Directory group membership.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/templates" + } + } + }, + "com.amazonaws.pcaconnectorad#CreateTemplateGroupAccessControlEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#CreateTemplateGroupAccessControlEntryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ConflictException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Create a group access control entry. Allow or deny Active Directory groups from enrolling and/or\n autoenrolling with the template based on the group security identifiers (SIDs).

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/templates/{TemplateArn}/accessControlEntries" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.pcaconnectorad#CreateTemplateGroupAccessControlEntryRequest": { + "type": "structure", + "members": { + "TemplateArn": { + "target": "com.amazonaws.pcaconnectorad#TemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupSecurityIdentifier": { + "target": "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier", + "traits": { + "smithy.api#documentation": "

Security identifier (SID) of the group object from Active Directory. The SID starts with\n \"S-\".

", + "smithy.api#required": {} + } + }, + "GroupDisplayName": { + "target": "com.amazonaws.pcaconnectorad#DisplayName", + "traits": { + "smithy.api#documentation": "

Name of the Active Directory group. This name does not need to match the group name in Active Directory.

", + "smithy.api#required": {} + } + }, + "AccessRights": { + "target": "com.amazonaws.pcaconnectorad#AccessRights", + "traits": { + "smithy.api#documentation": "

Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a\n template.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.pcaconnectorad#ClientToken", + "traits": { + "smithy.api#documentation": "

Idempotency token.

", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#CreateTemplateRequest": { + "type": "structure", + "members": { + "ConnectorArn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.pcaconnectorad#TemplateName", + "traits": { + "smithy.api#documentation": "

Name of the template. The template name must be unique.

", + "smithy.api#required": {} + } + }, + "Definition": { + "target": "com.amazonaws.pcaconnectorad#TemplateDefinition", + "traits": { + "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.pcaconnectorad#ClientToken", + "traits": { + "smithy.api#documentation": "

Idempotency token.

", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.pcaconnectorad#Tags", + "traits": { + "aws.cloudformation#cfnMutability": "write", + "smithy.api#documentation": "

Metadata assigned to a template consisting of a key-value pair.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#CreateTemplateResponse": { + "type": "structure", + "members": { + "TemplateArn": { + "target": "com.amazonaws.pcaconnectorad#TemplateArn", + "traits": { + "smithy.api#documentation": "

If successful, the Amazon Resource Name (ARN) of the template.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcaconnectorad#CryptoProvidersList": { + "type": "list", + "member": { + "target": "smithy.api#String", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.pcaconnectorad#CustomObjectIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^([0-2])\\.([0-9]|([0-3][0-9]))(\\.([0-9]+)){0,126}$" + } + }, + "com.amazonaws.pcaconnectorad#DeleteConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#DeleteConnectorRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ConflictException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN) of the\n connector that you want to delete. You can find the ARN by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors\n action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can\n deregister your directory by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration\n action.

", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/connectors/{ConnectorArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.pcaconnectorad#DeleteConnectorRequest": { + "type": "structure", + "members": { + "ConnectorArn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#DeleteDirectoryRegistration": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#DeleteDirectoryRegistrationRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ConflictException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a directory registration. Deleting a directory registration deauthorizes\n Amazon Web Services Private CA with the directory.

", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/directoryRegistrations/{DirectoryRegistrationArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.pcaconnectorad#DeleteDirectoryRegistrationRequest": { + "type": "structure", + "members": { + "DirectoryRegistrationArn": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#DeleteServicePrincipalName": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#DeleteServicePrincipalNameRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ConflictException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the service principal name (SPN) used by a connector to authenticate with your\n Active Directory.

", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/directoryRegistrations/{DirectoryRegistrationArn}/servicePrincipalNames/{ConnectorArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.pcaconnectorad#DeleteServicePrincipalNameRequest": { + "type": "structure", + "members": { + "DirectoryRegistrationArn": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ConnectorArn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#DeleteTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#DeleteTemplateRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ConflictException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a template. Certificates issued using the template are still valid until they\n are revoked or expired.

", + "smithy.api#http": { + "code": 202, + "method": "DELETE", + "uri": "/templates/{TemplateArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.pcaconnectorad#DeleteTemplateGroupAccessControlEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#DeleteTemplateGroupAccessControlEntryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ConflictException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a group access control entry.

", + "smithy.api#http": { + "code": 200, + "method": "DELETE", + "uri": "/templates/{TemplateArn}/accessControlEntries/{GroupSecurityIdentifier}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.pcaconnectorad#DeleteTemplateGroupAccessControlEntryRequest": { + "type": "structure", + "members": { + "TemplateArn": { + "target": "com.amazonaws.pcaconnectorad#TemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupSecurityIdentifier": { + "target": "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier", + "traits": { + "smithy.api#documentation": "

Security identifier (SID) of the group object from Active Directory. The SID starts with\n \"S-\".

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#DeleteTemplateRequest": { + "type": "structure", + "members": { + "TemplateArn": { + "target": "com.amazonaws.pcaconnectorad#TemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#DirectoryId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^d-[0-9a-f]{10}$" + } + }, + "com.amazonaws.pcaconnectorad#DirectoryRegistration": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called\n CreateDirectoryRegistration.

" + } + }, + "DirectoryId": { + "target": "com.amazonaws.pcaconnectorad#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the Active Directory.

" + } + }, + "Status": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationStatus", + "traits": { + "smithy.api#documentation": "

Status of the directory registration.

" + } + }, + "StatusReason": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationStatusReason", + "traits": { + "smithy.api#documentation": "

Additional information about the directory registration status if the status is\n failed.

" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the directory registration was created.

" + } + }, + "UpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the directory registration was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The directory registration represents the authorization of the connector service with a\n directory.

" + } + }, + "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 200 + }, + "smithy.api#pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:directory-registration\\/d-[0-9a-f]{10}$" + } + }, + "com.amazonaws.pcaconnectorad#DirectoryRegistrationList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationSummary" + } + }, + "com.amazonaws.pcaconnectorad#DirectoryRegistrationResource": { + "type": "resource", + "identifiers": { + "DirectoryRegistrationArn": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn" + } + }, + "create": { + "target": "com.amazonaws.pcaconnectorad#CreateDirectoryRegistration" + }, + "read": { + "target": "com.amazonaws.pcaconnectorad#GetDirectoryRegistration" + }, + "delete": { + "target": "com.amazonaws.pcaconnectorad#DeleteDirectoryRegistration" + }, + "list": { + "target": "com.amazonaws.pcaconnectorad#ListDirectoryRegistrations" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "DirectoryRegistration" + } + } + }, + "com.amazonaws.pcaconnectorad#DirectoryRegistrationStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.pcaconnectorad#DirectoryRegistrationStatusReason": { + "type": "enum", + "members": { + "DIRECTORY_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY_ACCESS_DENIED" + } + }, + "DIRECTORY_RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY_RESOURCE_NOT_FOUND" + } + }, + "DIRECTORY_NOT_ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY_NOT_ACTIVE" + } + }, + "DIRECTORY_NOT_REACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY_NOT_REACHABLE" + } + }, + "DIRECTORY_TYPE_NOT_SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY_TYPE_NOT_SUPPORTED" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_FAILURE" + } + } + } + }, + "com.amazonaws.pcaconnectorad#DirectoryRegistrationSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

" + } + }, + "DirectoryId": { + "target": "com.amazonaws.pcaconnectorad#DirectoryId", + "traits": { + "smithy.api#documentation": "

The identifier of the Active Directory.

" + } + }, + "Status": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationStatus", + "traits": { + "smithy.api#documentation": "

Status of the directory registration.

" + } + }, + "StatusReason": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationStatusReason", + "traits": { + "smithy.api#documentation": "

Additional information about the directory registration status if the status is\n failed.

" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the directory registration was created.

" + } + }, + "UpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the directory registration was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The directory registration represents the authorization of the connector service with\n the Active Directory.

" + } + }, + "com.amazonaws.pcaconnectorad#DisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\x20-\\x7E]+$" + } + }, + "com.amazonaws.pcaconnectorad#EnrollmentFlagsV2": { + "type": "structure", + "members": { + "IncludeSymmetricAlgorithms": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include symmetric algorithms allowed by the subject.

" + } + }, + "UserInteractionRequired": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Require user interaction when the subject is enrolled and the private key associated\n with the certificate is used.

" + } + }, + "RemoveInvalidCertificateFromPersonalStore": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Delete expired or revoked certificates instead of archiving them.

" + } + }, + "NoSecurityExtension": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

This flag instructs the CA to not include the security extension\n szOID_NTDS_CA_SECURITY_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE] sections\n 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This addresses a Windows\n Kerberos elevation-of-privilege vulnerability.

" + } + }, + "EnableKeyReuseOnNtTokenKeysetStorageFull": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Allow renewal using the same key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Template configurations for v2 template schema.

" + } + }, + "com.amazonaws.pcaconnectorad#EnrollmentFlagsV3": { + "type": "structure", + "members": { + "IncludeSymmetricAlgorithms": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include symmetric algorithms allowed by the subject.

" + } + }, + "UserInteractionRequired": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Require user interaction when the subject is enrolled and the private key associated\n with the certificate is used.

" + } + }, + "RemoveInvalidCertificateFromPersonalStore": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Delete expired or revoked certificates instead of archiving them.

" + } + }, + "NoSecurityExtension": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

This flag instructs the CA to not include the security extension\n szOID_NTDS_CA_SECURITY_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE] sections\n 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This addresses a Windows\n Kerberos elevation-of-privilege vulnerability.

" + } + }, + "EnableKeyReuseOnNtTokenKeysetStorageFull": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Allow renewal using the same key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Template configurations for v3 template schema.

" + } + }, + "com.amazonaws.pcaconnectorad#EnrollmentFlagsV4": { + "type": "structure", + "members": { + "IncludeSymmetricAlgorithms": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include symmetric algorithms allowed by the subject.

" + } + }, + "UserInteractionRequired": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Require user interaction when the subject is enrolled and the private key associated\n with the certificate is used.

" + } + }, + "RemoveInvalidCertificateFromPersonalStore": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Delete expired or revoked certificates instead of archiving them.

" + } + }, + "NoSecurityExtension": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

This flag instructs the CA to not include the security extension\n szOID_NTDS_CA_SECURITY_EXT (OID:1.3.6.1.4.1.311.25.2), as specified in [MS-WCCE] sections\n 2.2.2.7.7.4 and 3.2.2.6.2.1.4.5.9, in the issued certificate. This addresses a Windows\n Kerberos elevation-of-privilege vulnerability.

" + } + }, + "EnableKeyReuseOnNtTokenKeysetStorageFull": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Allow renewal using the same key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Template configurations for v4 template schema.

" + } + }, + "com.amazonaws.pcaconnectorad#ExtensionsV2": { + "type": "structure", + "members": { + "KeyUsage": { + "target": "com.amazonaws.pcaconnectorad#KeyUsage", + "traits": { + "smithy.api#documentation": "

The key usage extension defines the purpose (e.g., encipherment, signature, certificate\n signing) of the key contained in the certificate.

", + "smithy.api#required": {} + } + }, + "ApplicationPolicies": { + "target": "com.amazonaws.pcaconnectorad#ApplicationPolicies", + "traits": { + "smithy.api#documentation": "

Application policies specify what the certificate is used for and its purpose.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Certificate extensions for v2 template schema

" + } + }, + "com.amazonaws.pcaconnectorad#ExtensionsV3": { + "type": "structure", + "members": { + "KeyUsage": { + "target": "com.amazonaws.pcaconnectorad#KeyUsage", + "traits": { + "smithy.api#documentation": "

The key usage extension defines the purpose (e.g., encipherment, signature, certificate\n signing) of the key contained in the certificate.

", + "smithy.api#required": {} + } + }, + "ApplicationPolicies": { + "target": "com.amazonaws.pcaconnectorad#ApplicationPolicies", + "traits": { + "smithy.api#documentation": "

Application policies specify what the certificate is used for and its purpose.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Certificate extensions for v3 template schema

" + } + }, + "com.amazonaws.pcaconnectorad#ExtensionsV4": { + "type": "structure", + "members": { + "KeyUsage": { + "target": "com.amazonaws.pcaconnectorad#KeyUsage", + "traits": { + "smithy.api#documentation": "

The key usage extension defines the purpose (e.g., encipherment, signature) of the key\n contained in the certificate.

", + "smithy.api#required": {} + } + }, + "ApplicationPolicies": { + "target": "com.amazonaws.pcaconnectorad#ApplicationPolicies", + "traits": { + "smithy.api#documentation": "

Application policies specify what the certificate is used for and its purpose.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Certificate extensions for v4 template schema

" + } + }, + "com.amazonaws.pcaconnectorad#GeneralFlagsV2": { + "type": "structure", + "members": { + "AutoEnrollment": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Allows certificate issuance using autoenrollment. Set to TRUE to allow\n autoenrollment.

" + } + }, + "MachineType": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Defines if the template is for machines or users. Set to TRUE if the template is for\n machines. Set to FALSE if the template is for users.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

General flags for v2 template schema that defines if the template is for a machine or a\n user and if the template can be issued using autoenrollment.

" + } + }, + "com.amazonaws.pcaconnectorad#GeneralFlagsV3": { + "type": "structure", + "members": { + "AutoEnrollment": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Allows certificate issuance using autoenrollment. Set to TRUE to allow\n autoenrollment.

" + } + }, + "MachineType": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Defines if the template is for machines or users. Set to TRUE if the template is for\n machines. Set to FALSE if the template is for users

" + } + } + }, + "traits": { + "smithy.api#documentation": "

General flags for v3 template schema that defines if the template is for a machine or a\n user and if the template can be issued using autoenrollment.

" + } + }, + "com.amazonaws.pcaconnectorad#GeneralFlagsV4": { + "type": "structure", + "members": { + "AutoEnrollment": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Allows certificate issuance using autoenrollment. Set to TRUE to allow\n autoenrollment.

" + } + }, + "MachineType": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Defines if the template is for machines or users. Set to TRUE if the template is for\n machines. Set to FALSE if the template is for users

" + } + } + }, + "traits": { + "smithy.api#documentation": "

General flags for v4 template schema that defines if the template is for a machine or a\n user and if the template can be issued using autoenrollment.

" + } + }, + "com.amazonaws.pcaconnectorad#GetConnector": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#GetConnectorRequest" + }, + "output": { + "target": "com.amazonaws.pcaconnectorad#GetConnectorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists information about your connector. You specify the connector on input by its ARN\n (Amazon Resource Name).

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/connectors/{ConnectorArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.pcaconnectorad#GetConnectorRequest": { + "type": "structure", + "members": { + "ConnectorArn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#GetConnectorResponse": { + "type": "structure", + "members": { + "Connector": { + "target": "com.amazonaws.pcaconnectorad#Connector", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

A structure that contains information about your connector.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcaconnectorad#GetDirectoryRegistration": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#GetDirectoryRegistrationRequest" + }, + "output": { + "target": "com.amazonaws.pcaconnectorad#GetDirectoryRegistrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

A structure that contains information about your directory registration.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/directoryRegistrations/{DirectoryRegistrationArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.pcaconnectorad#GetDirectoryRegistrationRequest": { + "type": "structure", + "members": { + "DirectoryRegistrationArn": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#GetDirectoryRegistrationResponse": { + "type": "structure", + "members": { + "DirectoryRegistration": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistration", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The directory registration represents the authorization of the connector service with a\n directory.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcaconnectorad#GetServicePrincipalName": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#GetServicePrincipalNameRequest" + }, + "output": { + "target": "com.amazonaws.pcaconnectorad#GetServicePrincipalNameResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the service principal name that the connector uses to authenticate with\n Active Directory.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/directoryRegistrations/{DirectoryRegistrationArn}/servicePrincipalNames/{ConnectorArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.pcaconnectorad#GetServicePrincipalNameRequest": { + "type": "structure", + "members": { + "DirectoryRegistrationArn": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ConnectorArn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#GetServicePrincipalNameResponse": { + "type": "structure", + "members": { + "ServicePrincipalName": { + "target": "com.amazonaws.pcaconnectorad#ServicePrincipalName", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The service principal name that the connector uses to authenticate with Active Directory.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcaconnectorad#GetTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#GetTemplateRequest" + }, + "output": { + "target": "com.amazonaws.pcaconnectorad#GetTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves a certificate template that the connector uses to issue certificates from a\n private CA.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/templates/{TemplateArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.pcaconnectorad#GetTemplateGroupAccessControlEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#GetTemplateGroupAccessControlEntryRequest" + }, + "output": { + "target": "com.amazonaws.pcaconnectorad#GetTemplateGroupAccessControlEntryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Retrieves the group access control entries for a template.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/templates/{TemplateArn}/accessControlEntries/{GroupSecurityIdentifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.pcaconnectorad#GetTemplateGroupAccessControlEntryRequest": { + "type": "structure", + "members": { + "TemplateArn": { + "target": "com.amazonaws.pcaconnectorad#TemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupSecurityIdentifier": { + "target": "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier", + "traits": { + "smithy.api#documentation": "

Security identifier (SID) of the group object from Active Directory. The SID starts with\n \"S-\".

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#GetTemplateGroupAccessControlEntryResponse": { + "type": "structure", + "members": { + "AccessControlEntry": { + "target": "com.amazonaws.pcaconnectorad#AccessControlEntry", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

An access control entry allows or denies an Active Directory group from enrolling and/or\n autoenrolling with a template.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcaconnectorad#GetTemplateRequest": { + "type": "structure", + "members": { + "TemplateArn": { + "target": "com.amazonaws.pcaconnectorad#TemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#GetTemplateResponse": { + "type": "structure", + "members": { + "Template": { + "target": "com.amazonaws.pcaconnectorad#Template", + "traits": { + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

A certificate template that the connector uses to issue certificates from a private\n CA.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 256 + }, + "smithy.api#pattern": "^S-[0-9]-([0-9]+-){1,14}[0-9]+$" + } + }, + "com.amazonaws.pcaconnectorad#HashAlgorithm": { + "type": "enum", + "members": { + "SHA256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHA256" + } + }, + "SHA384": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHA384" + } + }, + "SHA512": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHA512" + } + } + } + }, + "com.amazonaws.pcaconnectorad#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception or failure with\n an internal server.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.pcaconnectorad#KeySpec": { + "type": "enum", + "members": { + "KEY_EXCHANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KEY_EXCHANGE" + } + }, + "SIGNATURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SIGNATURE" + } + } + } + }, + "com.amazonaws.pcaconnectorad#KeyUsage": { + "type": "structure", + "members": { + "Critical": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Sets the key usage extension to critical.

" + } + }, + "UsageFlags": { + "target": "com.amazonaws.pcaconnectorad#KeyUsageFlags", + "traits": { + "smithy.api#documentation": "

The key usage flags represent the purpose (e.g., encipherment, signature) of the key\n contained in the certificate.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The key usage extension defines the purpose (e.g., encipherment, signature) of the key\n contained in the certificate.

" + } + }, + "com.amazonaws.pcaconnectorad#KeyUsageFlags": { + "type": "structure", + "members": { + "DigitalSignature": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

The digitalSignature is asserted when the subject public key is used for verifying\n digital signatures.

" + } + }, + "NonRepudiation": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

NonRepudiation is asserted when the subject public key is used to verify digital\n signatures.

" + } + }, + "KeyEncipherment": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

KeyEncipherment is asserted when the subject public key is used for enciphering private\n or secret keys, i.e., for key transport.

" + } + }, + "DataEncipherment": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

DataEncipherment is asserted when the subject public key is used for directly\n enciphering raw user data without the use of an intermediate symmetric cipher.

" + } + }, + "KeyAgreement": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

KeyAgreement is asserted when the subject public key is used for key agreement.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The key usage flags represent the purpose (e.g., encipherment, signature) of the key\n contained in the certificate.

" + } + }, + "com.amazonaws.pcaconnectorad#KeyUsageProperty": { + "type": "union", + "members": { + "PropertyType": { + "target": "com.amazonaws.pcaconnectorad#KeyUsagePropertyType", + "traits": { + "smithy.api#documentation": "

You can specify all key usages using property type ALL. You can use property type or\n property flags but not both.

" + } + }, + "PropertyFlags": { + "target": "com.amazonaws.pcaconnectorad#KeyUsagePropertyFlags", + "traits": { + "smithy.api#documentation": "

You can specify key usage for encryption, key agreement, and signature. You can use\n property flags or property type but not both.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The key usage property defines the purpose of the private key contained in the\n certificate. You can specify specific purposes using property flags or all by using\n property type ALL.

" + } + }, + "com.amazonaws.pcaconnectorad#KeyUsagePropertyFlags": { + "type": "structure", + "members": { + "Decrypt": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Allows key for encryption and decryption.

" + } + }, + "KeyAgreement": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Allows key exchange without encryption.

" + } + }, + "Sign": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Allow key use for digital signature.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies key usage.

" + } + }, + "com.amazonaws.pcaconnectorad#KeyUsagePropertyType": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.pcaconnectorad#ListConnectors": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#ListConnectorsRequest" + }, + "output": { + "target": "com.amazonaws.pcaconnectorad#ListConnectorsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the connectors that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector action.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/connectors" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Connectors" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.pcaconnectorad#ListConnectorsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.pcaconnectorad#MaxResults", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results to specify the maximum number of items to\n return in the response on each page. If additional items exist beyond the number you\n specify, the NextToken element is sent in the response. Use this\n NextToken value in a subsequent request to retrieve additional\n items.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.pcaconnectorad#NextToken", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

", + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#ListConnectorsResponse": { + "type": "structure", + "members": { + "Connectors": { + "target": "com.amazonaws.pcaconnectorad#ConnectorList", + "traits": { + "smithy.api#documentation": "

Summary information about each connector you have created.

" + } + }, + "NextToken": { + "target": "com.amazonaws.pcaconnectorad#NextToken", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken parameter from the\n response you just received.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcaconnectorad#ListDirectoryRegistrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#ListDirectoryRegistrationsRequest" + }, + "output": { + "target": "com.amazonaws.pcaconnectorad#ListDirectoryRegistrationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the directory registrations that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration\n action.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/directoryRegistrations" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "DirectoryRegistrations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.pcaconnectorad#ListDirectoryRegistrationsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.pcaconnectorad#MaxResults", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results to specify the maximum number of items to\n return in the response on each page. If additional items exist beyond the number you\n specify, the NextToken element is sent in the response. Use this\n NextToken value in a subsequent request to retrieve additional\n items.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.pcaconnectorad#NextToken", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

", + "smithy.api#httpQuery": "NextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#ListDirectoryRegistrationsResponse": { + "type": "structure", + "members": { + "DirectoryRegistrations": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationList", + "traits": { + "smithy.api#documentation": "

Summary information about each directory registration you have created.

" + } + }, + "NextToken": { + "target": "com.amazonaws.pcaconnectorad#NextToken", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcaconnectorad#ListServicePrincipalNames": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#ListServicePrincipalNamesRequest" + }, + "output": { + "target": "com.amazonaws.pcaconnectorad#ListServicePrincipalNamesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the service principal names that the connector uses to authenticate with\n Active Directory.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/directoryRegistrations/{DirectoryRegistrationArn}/servicePrincipalNames" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "ServicePrincipalNames" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.pcaconnectorad#ListServicePrincipalNamesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.pcaconnectorad#MaxResults", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results to specify the maximum number of items to\n return in the response on each page. If additional items exist beyond the number you\n specify, the NextToken element is sent in the response. Use this\n NextToken value in a subsequent request to retrieve additional\n items.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.pcaconnectorad#NextToken", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "DirectoryRegistrationArn": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#ListServicePrincipalNamesResponse": { + "type": "structure", + "members": { + "ServicePrincipalNames": { + "target": "com.amazonaws.pcaconnectorad#ServicePrincipalNameList", + "traits": { + "smithy.api#documentation": "

The service principal name, if any, that the connector uses to authenticate with\n Active Directory.

" + } + }, + "NextToken": { + "target": "com.amazonaws.pcaconnectorad#NextToken", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcaconnectorad#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.pcaconnectorad#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags, if any, that are associated with your resource.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/tags/{ResourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.pcaconnectorad#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you created the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.pcaconnectorad#Tags", + "traits": { + "smithy.api#documentation": "

The tags, if any, that are associated with your resource.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcaconnectorad#ListTemplateGroupAccessControlEntries": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#ListTemplateGroupAccessControlEntriesRequest" + }, + "output": { + "target": "com.amazonaws.pcaconnectorad#ListTemplateGroupAccessControlEntriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists group access control entries you created.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/templates/{TemplateArn}/accessControlEntries" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "AccessControlEntries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.pcaconnectorad#ListTemplateGroupAccessControlEntriesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.pcaconnectorad#MaxResults", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results to specify the maximum number of items to\n return in the response on each page. If additional items exist beyond the number you\n specify, the NextToken element is sent in the response. Use this\n NextToken value in a subsequent request to retrieve additional\n items.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.pcaconnectorad#NextToken", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "TemplateArn": { + "target": "com.amazonaws.pcaconnectorad#TemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#ListTemplateGroupAccessControlEntriesResponse": { + "type": "structure", + "members": { + "AccessControlEntries": { + "target": "com.amazonaws.pcaconnectorad#AccessControlEntryList", + "traits": { + "smithy.api#documentation": "

An access control entry grants or denies permission to an Active Directory group to enroll\n certificates for a template.

" + } + }, + "NextToken": { + "target": "com.amazonaws.pcaconnectorad#NextToken", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcaconnectorad#ListTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#ListTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.pcaconnectorad#ListTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the templates, if any, that are associated with a connector.

", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/templates" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Templates" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.pcaconnectorad#ListTemplatesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.pcaconnectorad#MaxResults", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results to specify the maximum number of items to\n return in the response on each page. If additional items exist beyond the number you\n specify, the NextToken element is sent in the response. Use this\n NextToken value in a subsequent request to retrieve additional\n items.

", + "smithy.api#httpQuery": "MaxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.pcaconnectorad#NextToken", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

", + "smithy.api#httpQuery": "NextToken" + } + }, + "ConnectorArn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

", + "smithy.api#httpQuery": "ConnectorArn", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#ListTemplatesResponse": { + "type": "structure", + "members": { + "Templates": { + "target": "com.amazonaws.pcaconnectorad#TemplateList", + "traits": { + "smithy.api#documentation": "

Custom configuration templates used when issuing a certificate.

" + } + }, + "NextToken": { + "target": "com.amazonaws.pcaconnectorad#NextToken", + "traits": { + "smithy.api#documentation": "

Use this parameter when paginating results in a subsequent request after you receive a\n response with truncated results. Set it to the value of the NextToken\n parameter from the response you just received.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.pcaconnectorad#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.pcaconnectorad#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^(?:[A-Za-z0-9_-]{4})*(?:[A-Za-z0-9_-]{2}==|[A-Za-z0-9_-]{3}=)?$" + } + }, + "com.amazonaws.pcaconnectorad#PcaConnectorAd": { + "type": "service", + "version": "2018-05-10", + "operations": [ + { + "target": "com.amazonaws.pcaconnectorad#ListTagsForResource" + }, + { + "target": "com.amazonaws.pcaconnectorad#TagResource" + }, + { + "target": "com.amazonaws.pcaconnectorad#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.pcaconnectorad#ConnectorResource" + }, + { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationResource" + }, + { + "target": "com.amazonaws.pcaconnectorad#ServicePrincipalNameResource" + }, + { + "target": "com.amazonaws.pcaconnectorad#TemplateGroupAccessControlEntryResource" + }, + { + "target": "com.amazonaws.pcaconnectorad#TemplateResource" + } + ], + "traits": { + "aws.api#service": { + "arnNamespace": "pca-connector-ad", + "cloudFormationName": "PCAConnectorAD", + "sdkId": "Pca Connector Ad", + "serviceName": "pca-connector-ad", + "cloudTrailEventSource": "pca-connector-ad.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "pca-connector-ad" + }, + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "*", + "content-type", + "x-amz-content-sha256", + "x-amz-user-agent", + "x-amzn-platform-id", + "x-amzn-trace-id" + ], + "additionalExposedHeaders": [ + "x-amzn-errortype", + "x-amzn-requestid", + "x-amzn-trace-id" + ], + "maxAge": 86400 + }, + "smithy.api#documentation": "

Amazon Web Services Private CA Connector for Active Directory creates a connector between Amazon Web Services Private CA and Active Directory (AD) that enables you to\n provision security certificates for AD signed by a private CA that you own. For more\n information, see Amazon Web Services Private CA Connector for Active Directory.

", + "smithy.api#title": "PcaConnectorAd", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pca-connector-ad-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pca-connector-ad-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pca-connector-ad.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://pca-connector-ad.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://pca-connector-ad.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.pcaconnectorad#PrivateKeyAlgorithm": { + "type": "enum", + "members": { + "RSA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RSA" + } + }, + "ECDH_P256": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECDH_P256" + } + }, + "ECDH_P384": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECDH_P384" + } + }, + "ECDH_P521": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ECDH_P521" + } + } + } + }, + "com.amazonaws.pcaconnectorad#PrivateKeyAttributesV2": { + "type": "structure", + "members": { + "MinimalKeyLength": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Set the minimum key length of the private key.

", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "KeySpec": { + "target": "com.amazonaws.pcaconnectorad#KeySpec", + "traits": { + "smithy.api#documentation": "

Defines the purpose of the private key. Set it to \"KEY_EXCHANGE\" or \"SIGNATURE\"\n value.

", + "smithy.api#required": {} + } + }, + "CryptoProviders": { + "target": "com.amazonaws.pcaconnectorad#CryptoProvidersList", + "traits": { + "smithy.api#documentation": "

Defines the cryptographic providers used to generate the private key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the attributes of the private key.

" + } + }, + "com.amazonaws.pcaconnectorad#PrivateKeyAttributesV3": { + "type": "structure", + "members": { + "MinimalKeyLength": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Set the minimum key length of the private key.

", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "KeySpec": { + "target": "com.amazonaws.pcaconnectorad#KeySpec", + "traits": { + "smithy.api#documentation": "

Defines the purpose of the private key. Set it to \"KEY_EXCHANGE\" or \"SIGNATURE\"\n value.

", + "smithy.api#required": {} + } + }, + "CryptoProviders": { + "target": "com.amazonaws.pcaconnectorad#CryptoProvidersList", + "traits": { + "smithy.api#documentation": "

Defines the cryptographic providers used to generate the private key.

" + } + }, + "KeyUsageProperty": { + "target": "com.amazonaws.pcaconnectorad#KeyUsageProperty", + "traits": { + "smithy.api#documentation": "

The key usage property defines the purpose of the private key contained in the\n certificate. You can specify specific purposes using property flags or all by using\n property type ALL.

", + "smithy.api#required": {} + } + }, + "Algorithm": { + "target": "com.amazonaws.pcaconnectorad#PrivateKeyAlgorithm", + "traits": { + "smithy.api#documentation": "

Defines the algorithm used to generate the private key.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the attributes of the private key.

" + } + }, + "com.amazonaws.pcaconnectorad#PrivateKeyAttributesV4": { + "type": "structure", + "members": { + "MinimalKeyLength": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

Set the minimum key length of the private key.

", + "smithy.api#range": { + "min": 1 + }, + "smithy.api#required": {} + } + }, + "KeySpec": { + "target": "com.amazonaws.pcaconnectorad#KeySpec", + "traits": { + "smithy.api#documentation": "

Defines the purpose of the private key. Set it to \"KEY_EXCHANGE\" or \"SIGNATURE\"\n value.

", + "smithy.api#required": {} + } + }, + "CryptoProviders": { + "target": "com.amazonaws.pcaconnectorad#CryptoProvidersList", + "traits": { + "smithy.api#documentation": "

Defines the cryptographic providers used to generate the private key.

" + } + }, + "KeyUsageProperty": { + "target": "com.amazonaws.pcaconnectorad#KeyUsageProperty", + "traits": { + "smithy.api#documentation": "

The key usage property defines the purpose of the private key contained in the\n certificate. You can specify specific purposes using property flags or all by using\n property type ALL.

" + } + }, + "Algorithm": { + "target": "com.amazonaws.pcaconnectorad#PrivateKeyAlgorithm", + "traits": { + "smithy.api#documentation": "

Defines the algorithm used to generate the private key.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines the attributes of the private key.

" + } + }, + "com.amazonaws.pcaconnectorad#PrivateKeyFlagsV2": { + "type": "structure", + "members": { + "ExportableKey": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Allows the private key to be exported.

" + } + }, + "StrongKeyProtectionRequired": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Require user input when using the private key for enrollment.

" + } + }, + "ClientVersion": { + "target": "com.amazonaws.pcaconnectorad#ClientCompatibilityV2", + "traits": { + "smithy.api#documentation": "

Defines the minimum client compatibility.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Private key flags for v2 templates specify the client compatibility, if the private key\n can be exported, and if user input is required when using a private key.

" + } + }, + "com.amazonaws.pcaconnectorad#PrivateKeyFlagsV3": { + "type": "structure", + "members": { + "ExportableKey": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Allows the private key to be exported.

" + } + }, + "StrongKeyProtectionRequired": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Requirer user input when using the private key for enrollment.

" + } + }, + "RequireAlternateSignatureAlgorithm": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Reguires the PKCS #1 v2.1 signature format for certificates. You should verify that your\n CA, objects, and applications can accept this signature format.

" + } + }, + "ClientVersion": { + "target": "com.amazonaws.pcaconnectorad#ClientCompatibilityV3", + "traits": { + "smithy.api#documentation": "

Defines the minimum client compatibility.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Private key flags for v3 templates specify the client compatibility, if the private key\n can be exported, if user input is required when using a private key, and if an alternate\n signature algorithm should be used.

" + } + }, + "com.amazonaws.pcaconnectorad#PrivateKeyFlagsV4": { + "type": "structure", + "members": { + "ExportableKey": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Allows the private key to be exported.

" + } + }, + "StrongKeyProtectionRequired": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Require user input when using the private key for enrollment.

" + } + }, + "RequireAlternateSignatureAlgorithm": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Requires the PKCS #1 v2.1 signature format for certificates. You should verify that your\n CA, objects, and applications can accept this signature format.

" + } + }, + "RequireSameKeyRenewal": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Renew certificate using the same private key.

" + } + }, + "UseLegacyProvider": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Specifies the cryptographic service provider category used to generate private keys. Set\n to TRUE to use Legacy Cryptographic Service Providers and FALSE to use Key Storage\n Providers.

" + } + }, + "ClientVersion": { + "target": "com.amazonaws.pcaconnectorad#ClientCompatibilityV4", + "traits": { + "smithy.api#documentation": "

Defines the minimum client compatibility.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Private key flags for v4 templates specify the client compatibility, if the private key\n can be exported, if user input is required when using a private key, if an alternate\n signature algorithm should be used, and if certificates are renewed using the same private\n key.

" + } + }, + "com.amazonaws.pcaconnectorad#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Web Services resource.

", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The resource type, which can be one of Connector, Template, TemplateGroupAccessControlEntry, ServicePrincipalName, or DirectoryRegistration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The operation tried to access a nonexistent resource. The resource might not be\n specified correctly, or its status might not be ACTIVE.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.pcaconnectorad#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 11, + "max": 20 + }, + "smithy.api#pattern": "^(?:sg-[0-9a-f]{8}|sg-[0-9a-f]{17})$" + } + }, + "com.amazonaws.pcaconnectorad#SecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcaconnectorad#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.pcaconnectorad#ServicePrincipalName": { + "type": "structure", + "members": { + "DirectoryRegistrationArn": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

" + } + }, + "ConnectorArn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.html.

" + } + }, + "Status": { + "target": "com.amazonaws.pcaconnectorad#ServicePrincipalNameStatus", + "traits": { + "smithy.api#documentation": "

The status of a service principal name.

" + } + }, + "StatusReason": { + "target": "com.amazonaws.pcaconnectorad#ServicePrincipalNameStatusReason", + "traits": { + "smithy.api#documentation": "

Additional information for the status of a service principal name if the status is\n failed.

" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the service principal name was created.

" + } + }, + "UpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the service principal name was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The service principal name that the connector uses to authenticate with Active Directory.

" + } + }, + "com.amazonaws.pcaconnectorad#ServicePrincipalNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcaconnectorad#ServicePrincipalNameSummary" + } + }, + "com.amazonaws.pcaconnectorad#ServicePrincipalNameResource": { + "type": "resource", + "identifiers": { + "DirectoryRegistrationArn": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn" + }, + "ConnectorArn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn" + } + }, + "put": { + "target": "com.amazonaws.pcaconnectorad#CreateServicePrincipalName" + }, + "read": { + "target": "com.amazonaws.pcaconnectorad#GetServicePrincipalName" + }, + "delete": { + "target": "com.amazonaws.pcaconnectorad#DeleteServicePrincipalName" + }, + "list": { + "target": "com.amazonaws.pcaconnectorad#ListServicePrincipalNames" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "ServicePrincipalName" + }, + "smithy.api#noReplace": {} + } + }, + "com.amazonaws.pcaconnectorad#ServicePrincipalNameStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.pcaconnectorad#ServicePrincipalNameStatusReason": { + "type": "enum", + "members": { + "DIRECTORY_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY_ACCESS_DENIED" + } + }, + "DIRECTORY_NOT_REACHABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY_NOT_REACHABLE" + } + }, + "DIRECTORY_RESOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY_RESOURCE_NOT_FOUND" + } + }, + "SPN_EXISTS_ON_DIFFERENT_AD_OBJECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPN_EXISTS_ON_DIFFERENT_AD_OBJECT" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_FAILURE" + } + } + } + }, + "com.amazonaws.pcaconnectorad#ServicePrincipalNameSummary": { + "type": "structure", + "members": { + "DirectoryRegistrationArn": { + "target": "com.amazonaws.pcaconnectorad#DirectoryRegistrationArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

" + } + }, + "ConnectorArn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

" + } + }, + "Status": { + "target": "com.amazonaws.pcaconnectorad#ServicePrincipalNameStatus", + "traits": { + "smithy.api#documentation": "

The status of a service principal name.

" + } + }, + "StatusReason": { + "target": "com.amazonaws.pcaconnectorad#ServicePrincipalNameStatusReason", + "traits": { + "smithy.api#documentation": "

Additional information for the status of a service principal name if the status is\n failed.

" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the service principal name was created.

" + } + }, + "UpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

Time when the service principal name was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The service principal name that the connector uses to authenticate with Active Directory.

" + } + }, + "com.amazonaws.pcaconnectorad#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The identifier of the Amazon Web Services resource.

", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The resource type, which can be one of Connector, Template, TemplateGroupAccessControlEntry, ServicePrincipalName, or DirectoryRegistration.

", + "smithy.api#required": {} + } + }, + "ServiceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Identifies the originating service.

", + "smithy.api#required": {} + } + }, + "QuotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The code associated with the service quota.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Request would cause a service quota to be exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.pcaconnectorad#SubjectNameFlagsV2": { + "type": "structure", + "members": { + "SanRequireDomainDns": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the domain DNS in the subject alternate name.

" + } + }, + "SanRequireSpn": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the service principal name (SPN) in the subject alternate name.

" + } + }, + "SanRequireDirectoryGuid": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the globally unique identifier (GUID) in the subject alternate name.

" + } + }, + "SanRequireUpn": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the user principal name (UPN) in the subject alternate name.

" + } + }, + "SanRequireEmail": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the subject's email in the subject alternate name.

" + } + }, + "SanRequireDns": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the DNS in the subject alternate name.

" + } + }, + "RequireDnsAsCn": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the DNS as common name in the subject name.

" + } + }, + "RequireEmail": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the subject's email in the subject name.

" + } + }, + "RequireCommonName": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the common name in the subject name.

" + } + }, + "RequireDirectoryPath": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the directory path in the subject name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information to include in the subject name and alternate subject name of the\n certificate. The subject name can be common name, directory path, DNS as common name, or\n left blank. You can optionally include email to the subject name for user templates. If you\n leave the subject name blank then you must set a subject alternate name. The subject\n alternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email,\n service principal name (SPN), and user principal name (UPN). You can leave the SAN blank.\n If you leave the SAN blank, then you must set a subject name.

" + } + }, + "com.amazonaws.pcaconnectorad#SubjectNameFlagsV3": { + "type": "structure", + "members": { + "SanRequireDomainDns": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the domain DNS in the subject alternate name.

" + } + }, + "SanRequireSpn": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the service principal name (SPN) in the subject alternate name.

" + } + }, + "SanRequireDirectoryGuid": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the globally unique identifier (GUID) in the subject alternate name.

" + } + }, + "SanRequireUpn": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the user principal name (UPN) in the subject alternate name.

" + } + }, + "SanRequireEmail": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the subject's email in the subject alternate name.

" + } + }, + "SanRequireDns": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the DNS in the subject alternate name.

" + } + }, + "RequireDnsAsCn": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the DNS as common name in the subject name.

" + } + }, + "RequireEmail": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the subject's email in the subject name.

" + } + }, + "RequireCommonName": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the common name in the subject name.

" + } + }, + "RequireDirectoryPath": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the directory path in the subject name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information to include in the subject name and alternate subject name of the\n certificate. The subject name can be common name, directory path, DNS as common name, or\n left blank. You can optionally include email to the subject name for user templates. If you\n leave the subject name blank then you must set a subject alternate name. The subject\n alternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email,\n service principal name (SPN), and user principal name (UPN). You can leave the SAN blank.\n If you leave the SAN blank, then you must set a subject name.

" + } + }, + "com.amazonaws.pcaconnectorad#SubjectNameFlagsV4": { + "type": "structure", + "members": { + "SanRequireDomainDns": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the domain DNS in the subject alternate name.

" + } + }, + "SanRequireSpn": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the service principal name (SPN) in the subject alternate name.

" + } + }, + "SanRequireDirectoryGuid": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the globally unique identifier (GUID) in the subject alternate name.

" + } + }, + "SanRequireUpn": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the user principal name (UPN) in the subject alternate name.

" + } + }, + "SanRequireEmail": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the subject's email in the subject alternate name.

" + } + }, + "SanRequireDns": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the DNS in the subject alternate name.

" + } + }, + "RequireDnsAsCn": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the DNS as common name in the subject name.

" + } + }, + "RequireEmail": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the subject's email in the subject name.

" + } + }, + "RequireCommonName": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the common name in the subject name.

" + } + }, + "RequireDirectoryPath": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

Include the directory path in the subject name.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information to include in the subject name and alternate subject name of the\n certificate. The subject name can be common name, directory path, DNS as common name, or\n left blank. You can optionally include email to the subject name for user templates. If you\n leave the subject name blank then you must set a subject alternate name. The subject\n alternate name (SAN) can include globally unique identifier (GUID), DNS, domain DNS, email,\n service principal name (SPN), and user principal name (UPN). You can leave the SAN blank.\n If you leave the SAN blank, then you must set a subject name.

" + } + }, + "com.amazonaws.pcaconnectorad#TagKeyList": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.pcaconnectorad#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#TagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds one or more tags to your resource.

", + "smithy.api#http": { + "code": 204, + "method": "POST", + "uri": "/tags/{ResourceArn}" + } + } + }, + "com.amazonaws.pcaconnectorad#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you created the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.pcaconnectorad#Tags", + "traits": { + "smithy.api#documentation": "

Metadata assigned to a directory registration consisting of a key-value pair.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#Tags": { + "type": "map", + "key": { + "target": "smithy.api#String" + }, + "value": { + "target": "smithy.api#String" + } + }, + "com.amazonaws.pcaconnectorad#Template": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.pcaconnectorad#TemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

" + } + }, + "ConnectorArn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

" + } + }, + "Definition": { + "target": "com.amazonaws.pcaconnectorad#TemplateDefinition", + "traits": { + "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

" + } + }, + "Name": { + "target": "com.amazonaws.pcaconnectorad#TemplateName", + "traits": { + "smithy.api#documentation": "

Name of the templates. Template names must be unique.

" + } + }, + "ObjectIdentifier": { + "target": "com.amazonaws.pcaconnectorad#CustomObjectIdentifier", + "traits": { + "smithy.api#documentation": "

Object identifier of a template.

" + } + }, + "PolicySchema": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The template schema version. Template schema versions can be v2, v3, or v4. The template\n configuration options change based on the template schema version.

" + } + }, + "Status": { + "target": "com.amazonaws.pcaconnectorad#TemplateStatus", + "traits": { + "smithy.api#documentation": "

Status of the template. Status can be creating, active, deleting, or failed.

" + } + }, + "Revision": { + "target": "com.amazonaws.pcaconnectorad#TemplateRevision", + "traits": { + "smithy.api#documentation": "

The version of the template. Template updates will increment the minor revision.\n Re-enrolling all certificate holders will increment the major revision.

" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the template was created.

" + } + }, + "UpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the template was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Active Directory compatible certificate template. Connectors issue certificates against these\n templates based on the requestor's Active Directory group membership.

" + } + }, + "com.amazonaws.pcaconnectorad#TemplateArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 5, + "max": 200 + }, + "smithy.api#pattern": "^arn:[\\w-]+:pca-connector-ad:[\\w-]+:[0-9]+:connector\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}\\/template\\/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$" + } + }, + "com.amazonaws.pcaconnectorad#TemplateDefinition": { + "type": "union", + "members": { + "TemplateV2": { + "target": "com.amazonaws.pcaconnectorad#TemplateV2", + "traits": { + "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

" + } + }, + "TemplateV3": { + "target": "com.amazonaws.pcaconnectorad#TemplateV3", + "traits": { + "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

" + } + }, + "TemplateV4": { + "target": "com.amazonaws.pcaconnectorad#TemplateV4", + "traits": { + "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

" + } + }, + "com.amazonaws.pcaconnectorad#TemplateGroupAccessControlEntryResource": { + "type": "resource", + "identifiers": { + "TemplateArn": { + "target": "com.amazonaws.pcaconnectorad#TemplateArn" + }, + "GroupSecurityIdentifier": { + "target": "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier" + } + }, + "put": { + "target": "com.amazonaws.pcaconnectorad#CreateTemplateGroupAccessControlEntry" + }, + "read": { + "target": "com.amazonaws.pcaconnectorad#GetTemplateGroupAccessControlEntry" + }, + "update": { + "target": "com.amazonaws.pcaconnectorad#UpdateTemplateGroupAccessControlEntry" + }, + "delete": { + "target": "com.amazonaws.pcaconnectorad#DeleteTemplateGroupAccessControlEntry" + }, + "list": { + "target": "com.amazonaws.pcaconnectorad#ListTemplateGroupAccessControlEntries" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "TemplateGroupAccessControlEntry" + } + } + }, + "com.amazonaws.pcaconnectorad#TemplateList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcaconnectorad#TemplateSummary" + } + }, + "com.amazonaws.pcaconnectorad#TemplateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^(?!^\\s+$)((?![\\x5c'\\x2b,;<=>#\\x22])([\\x20-\\x7E]))+$" + } + }, + "com.amazonaws.pcaconnectorad#TemplateNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.pcaconnectorad#TemplateName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + }, + "smithy.api#uniqueItems": {} + } + }, + "com.amazonaws.pcaconnectorad#TemplateResource": { + "type": "resource", + "identifiers": { + "TemplateArn": { + "target": "com.amazonaws.pcaconnectorad#TemplateArn" + } + }, + "create": { + "target": "com.amazonaws.pcaconnectorad#CreateTemplate" + }, + "read": { + "target": "com.amazonaws.pcaconnectorad#GetTemplate" + }, + "update": { + "target": "com.amazonaws.pcaconnectorad#UpdateTemplate" + }, + "delete": { + "target": "com.amazonaws.pcaconnectorad#DeleteTemplate" + }, + "list": { + "target": "com.amazonaws.pcaconnectorad#ListTemplates" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Template" + } + } + }, + "com.amazonaws.pcaconnectorad#TemplateRevision": { + "type": "structure", + "members": { + "MajorRevision": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The revision version of the template. Re-enrolling all certificate holders will\n increment the major revision.

", + "smithy.api#required": {} + } + }, + "MinorRevision": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The revision version of the template. Re-enrolling all certificate holders will\n increment the major revision.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The revision version of the template. Template updates will increment the minor\n revision. Re-enrolling all certificate holders will increment the major revision.

" + } + }, + "com.amazonaws.pcaconnectorad#TemplateStatus": { + "type": "enum", + "members": { + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.pcaconnectorad#TemplateSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.pcaconnectorad#TemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

" + } + }, + "ConnectorArn": { + "target": "com.amazonaws.pcaconnectorad#ConnectorArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

" + } + }, + "Definition": { + "target": "com.amazonaws.pcaconnectorad#TemplateDefinition", + "traits": { + "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

" + } + }, + "Name": { + "target": "com.amazonaws.pcaconnectorad#TemplateName", + "traits": { + "smithy.api#documentation": "

Name of the template. The template name must be unique.

" + } + }, + "ObjectIdentifier": { + "target": "com.amazonaws.pcaconnectorad#CustomObjectIdentifier", + "traits": { + "smithy.api#documentation": "

Object identifier of a template.

" + } + }, + "PolicySchema": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "

The template schema version. Template schema versions can be v2, v3, or v4. The template\n configuration options change based on the template schema version.

" + } + }, + "Status": { + "target": "com.amazonaws.pcaconnectorad#TemplateStatus", + "traits": { + "smithy.api#documentation": "

Status of the template. Status can be creating, active, deleting, or failed.

" + } + }, + "Revision": { + "target": "com.amazonaws.pcaconnectorad#TemplateRevision", + "traits": { + "smithy.api#documentation": "

The revision version of the template. Template updates will increment the minor\n revision. Re-enrolling all certificate holders will increment the major revision.

" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the template was created.

" + } + }, + "UpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the template was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Active Directory compatible certificate template. Connectors issue certificates against these\n templates based on the requestor's Active Directory group membership.

" + } + }, + "com.amazonaws.pcaconnectorad#TemplateV2": { + "type": "structure", + "members": { + "CertificateValidity": { + "target": "com.amazonaws.pcaconnectorad#CertificateValidity", + "traits": { + "smithy.api#documentation": "

Certificate validity describes the validity and renewal periods of a certificate.

", + "smithy.api#required": {} + } + }, + "SupersededTemplates": { + "target": "com.amazonaws.pcaconnectorad#TemplateNameList", + "traits": { + "smithy.api#documentation": "

List of templates in Active Directory that are superseded by this template.

" + } + }, + "PrivateKeyAttributes": { + "target": "com.amazonaws.pcaconnectorad#PrivateKeyAttributesV2", + "traits": { + "smithy.api#documentation": "

Private key attributes allow you to specify the minimal key length, key spec, and\n cryptographic providers for the private key of a certificate for v2 templates. V2 templates\n allow you to use Legacy Cryptographic Service Providers.

", + "smithy.api#required": {} + } + }, + "PrivateKeyFlags": { + "target": "com.amazonaws.pcaconnectorad#PrivateKeyFlagsV2", + "traits": { + "smithy.api#documentation": "

Private key flags for v2 templates specify the client compatibility, if the private key\n can be exported, and if user input is required when using a private key.

", + "smithy.api#required": {} + } + }, + "EnrollmentFlags": { + "target": "com.amazonaws.pcaconnectorad#EnrollmentFlagsV2", + "traits": { + "smithy.api#documentation": "

Enrollment flags describe the enrollment settings for certificates such as using the\n existing private key and deleting expired or revoked certificates.

", + "smithy.api#required": {} + } + }, + "SubjectNameFlags": { + "target": "com.amazonaws.pcaconnectorad#SubjectNameFlagsV2", + "traits": { + "smithy.api#documentation": "

Subject name flags describe the subject name and subject alternate name that is included\n in a certificate.

", + "smithy.api#required": {} + } + }, + "GeneralFlags": { + "target": "com.amazonaws.pcaconnectorad#GeneralFlagsV2", + "traits": { + "smithy.api#documentation": "

General flags describe whether the template is used for computers or users and if the\n template can be used with autoenrollment.

", + "smithy.api#required": {} + } + }, + "Extensions": { + "target": "com.amazonaws.pcaconnectorad#ExtensionsV2", + "traits": { + "smithy.api#documentation": "

Extensions describe the key usage extensions and application policies for a\n template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

v2 template schema that uses Legacy Cryptographic Providers.

" + } + }, + "com.amazonaws.pcaconnectorad#TemplateV3": { + "type": "structure", + "members": { + "CertificateValidity": { + "target": "com.amazonaws.pcaconnectorad#CertificateValidity", + "traits": { + "smithy.api#documentation": "

Certificate validity describes the validity and renewal periods of a certificate.

", + "smithy.api#required": {} + } + }, + "SupersededTemplates": { + "target": "com.amazonaws.pcaconnectorad#TemplateNameList", + "traits": { + "smithy.api#documentation": "

List of templates in Active Directory that are superseded by this template.

" + } + }, + "PrivateKeyAttributes": { + "target": "com.amazonaws.pcaconnectorad#PrivateKeyAttributesV3", + "traits": { + "smithy.api#documentation": "

Private key attributes allow you to specify the algorithm, minimal key length, key spec,\n key usage, and cryptographic providers for the private key of a certificate for v3\n templates. V3 templates allow you to use Key Storage Providers.

", + "smithy.api#required": {} + } + }, + "PrivateKeyFlags": { + "target": "com.amazonaws.pcaconnectorad#PrivateKeyFlagsV3", + "traits": { + "smithy.api#documentation": "

Private key flags for v3 templates specify the client compatibility, if the private key\n can be exported, if user input is required when using a private key, and if an alternate\n signature algorithm should be used.

", + "smithy.api#required": {} + } + }, + "EnrollmentFlags": { + "target": "com.amazonaws.pcaconnectorad#EnrollmentFlagsV3", + "traits": { + "smithy.api#documentation": "

Enrollment flags describe the enrollment settings for certificates such as using the\n existing private key and deleting expired or revoked certificates.

", + "smithy.api#required": {} + } + }, + "SubjectNameFlags": { + "target": "com.amazonaws.pcaconnectorad#SubjectNameFlagsV3", + "traits": { + "smithy.api#documentation": "

Subject name flags describe the subject name and subject alternate name that is included\n in a certificate.

", + "smithy.api#required": {} + } + }, + "GeneralFlags": { + "target": "com.amazonaws.pcaconnectorad#GeneralFlagsV3", + "traits": { + "smithy.api#documentation": "

General flags describe whether the template is used for computers or users and if the\n template can be used with autoenrollment.

", + "smithy.api#required": {} + } + }, + "HashAlgorithm": { + "target": "com.amazonaws.pcaconnectorad#HashAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the hash algorithm used to hash the private key.

", + "smithy.api#required": {} + } + }, + "Extensions": { + "target": "com.amazonaws.pcaconnectorad#ExtensionsV3", + "traits": { + "smithy.api#documentation": "

Extensions describe the key usage extensions and application policies for a\n template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

v3 template schema that uses Key Storage Providers.

" + } + }, + "com.amazonaws.pcaconnectorad#TemplateV4": { + "type": "structure", + "members": { + "CertificateValidity": { + "target": "com.amazonaws.pcaconnectorad#CertificateValidity", + "traits": { + "smithy.api#documentation": "

Certificate validity describes the validity and renewal periods of a certificate.

", + "smithy.api#required": {} + } + }, + "SupersededTemplates": { + "target": "com.amazonaws.pcaconnectorad#TemplateNameList", + "traits": { + "smithy.api#documentation": "

List of templates in Active Directory that are superseded by this template.

" + } + }, + "PrivateKeyAttributes": { + "target": "com.amazonaws.pcaconnectorad#PrivateKeyAttributesV4", + "traits": { + "smithy.api#documentation": "

Private key attributes allow you to specify the minimal key length, key spec, key usage,\n and cryptographic providers for the private key of a certificate for v4 templates. V4\n templates allow you to use either Key Storage Providers or Legacy Cryptographic Service\n Providers. You specify the cryptography provider category in private key flags.

", + "smithy.api#required": {} + } + }, + "PrivateKeyFlags": { + "target": "com.amazonaws.pcaconnectorad#PrivateKeyFlagsV4", + "traits": { + "smithy.api#documentation": "

Private key flags for v4 templates specify the client compatibility, if the private key\n can be exported, if user input is required when using a private key, if an alternate\n signature algorithm should be used, and if certificates are renewed using the same private\n key.

", + "smithy.api#required": {} + } + }, + "EnrollmentFlags": { + "target": "com.amazonaws.pcaconnectorad#EnrollmentFlagsV4", + "traits": { + "smithy.api#documentation": "

Enrollment flags describe the enrollment settings for certificates using the existing\n private key and deleting expired or revoked certificates.

", + "smithy.api#required": {} + } + }, + "SubjectNameFlags": { + "target": "com.amazonaws.pcaconnectorad#SubjectNameFlagsV4", + "traits": { + "smithy.api#documentation": "

Subject name flags describe the subject name and subject alternate name that is included\n in a certificate.

", + "smithy.api#required": {} + } + }, + "GeneralFlags": { + "target": "com.amazonaws.pcaconnectorad#GeneralFlagsV4", + "traits": { + "smithy.api#documentation": "

General flags describe whether the template is used for computers or users and if the\n template can be used with autoenrollment.

", + "smithy.api#required": {} + } + }, + "HashAlgorithm": { + "target": "com.amazonaws.pcaconnectorad#HashAlgorithm", + "traits": { + "smithy.api#documentation": "

Specifies the hash algorithm used to hash the private key. Hash algorithm can only be\n specified when using Key Storage Providers.

" + } + }, + "Extensions": { + "target": "com.amazonaws.pcaconnectorad#ExtensionsV4", + "traits": { + "smithy.api#documentation": "

Extensions describe the key usage extensions and application policies for a\n template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

v4 template schema that can use either Legacy Cryptographic Providers or Key Storage\n Providers.

" + } + }, + "com.amazonaws.pcaconnectorad#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "ServiceCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Identifies the originating service.

" + } + }, + "QuotaCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The code associated with the quota.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The limit on the number of requests per second was exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.pcaconnectorad#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#UntagResourceRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes one or more tags from your resource.

", + "smithy.api#http": { + "code": 204, + "method": "DELETE", + "uri": "/tags/{ResourceArn}" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.pcaconnectorad#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you created the resource.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.pcaconnectorad#TagKeyList", + "traits": { + "smithy.api#documentation": "

Specifies a list of tag keys that you want to remove from the specified\n resources.

", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#UpdateTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#UpdateTemplateRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ConflictException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update template configuration to define the information included in certificates.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/templates/{TemplateArn}" + } + } + }, + "com.amazonaws.pcaconnectorad#UpdateTemplateGroupAccessControlEntry": { + "type": "operation", + "input": { + "target": "com.amazonaws.pcaconnectorad#UpdateTemplateGroupAccessControlEntryRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.pcaconnectorad#AccessDeniedException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ConflictException" + }, + { + "target": "com.amazonaws.pcaconnectorad#InternalServerException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ThrottlingException" + }, + { + "target": "com.amazonaws.pcaconnectorad#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.

", + "smithy.api#http": { + "code": 200, + "method": "PATCH", + "uri": "/templates/{TemplateArn}/accessControlEntries/{GroupSecurityIdentifier}" + } + } + }, + "com.amazonaws.pcaconnectorad#UpdateTemplateGroupAccessControlEntryRequest": { + "type": "structure", + "members": { + "TemplateArn": { + "target": "com.amazonaws.pcaconnectorad#TemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupSecurityIdentifier": { + "target": "com.amazonaws.pcaconnectorad#GroupSecurityIdentifier", + "traits": { + "smithy.api#documentation": "

Security identifier (SID) of the group object from Active Directory. The SID starts with\n \"S-\".

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupDisplayName": { + "target": "com.amazonaws.pcaconnectorad#DisplayName", + "traits": { + "smithy.api#documentation": "

Name of the Active Directory group. This name does not need to match the group name in Active Directory.

" + } + }, + "AccessRights": { + "target": "com.amazonaws.pcaconnectorad#AccessRights", + "traits": { + "smithy.api#documentation": "

Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a\n template.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#UpdateTemplateRequest": { + "type": "structure", + "members": { + "TemplateArn": { + "target": "com.amazonaws.pcaconnectorad#TemplateArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Definition": { + "target": "com.amazonaws.pcaconnectorad#TemplateDefinition", + "traits": { + "smithy.api#documentation": "

Template configuration to define the information included in certificates. Define\n certificate validity and renewal periods, certificate request handling and enrollment\n options, key usage extensions, application policies, and cryptography settings.

" + } + }, + "ReenrollAllCertificateHolders": { + "target": "smithy.api#Boolean", + "traits": { + "smithy.api#documentation": "

This setting allows the major version of a template to be increased automatically. All\n members of Active Directory groups that are allowed to enroll with a template will receive a new\n certificate issued using that template.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.pcaconnectorad#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "smithy.api#String", + "traits": { + "smithy.api#required": {} + } + }, + "Reason": { + "target": "com.amazonaws.pcaconnectorad#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "

The reason for the validation error. This won't be return for every\n validation exception.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An input validation error occurred. For example, invalid characters in a template name,\n or if a pagination token is invalid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.pcaconnectorad#ValidationExceptionReason": { + "type": "enum", + "members": { + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIELD_VALIDATION_FAILED" + } + }, + "INVALID_PERMISSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_PERMISSION" + } + }, + "INVALID_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_STATE" + } + }, + "MISMATCHED_CONNECTOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISMATCHED_CONNECTOR" + } + }, + "MISMATCHED_VPC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISMATCHED_VPC" + } + }, + "NO_CLIENT_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_CLIENT_TOKEN" + } + }, + "UNKNOWN_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN_OPERATION" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + } + } + }, + "com.amazonaws.pcaconnectorad#ValidityPeriod": { + "type": "structure", + "members": { + "PeriodType": { + "target": "com.amazonaws.pcaconnectorad#ValidityPeriodType", + "traits": { + "smithy.api#documentation": "

The unit of time. You can select hours, days, weeks, months, and years.

", + "smithy.api#required": {} + } + }, + "Period": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "

The numeric value for the validity period.

", + "smithy.api#range": { + "min": 1, + "max": 8766000 + }, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information describing the end of the validity period of the certificate. This parameter\n sets the “Not After” date for the certificate. Certificate validity is the period of time\n during which a certificate is valid. Validity can be expressed as an explicit date and time\n when the certificate expires, or as a span of time after issuance, stated in hours, days,\n months, or years. For more information, see Validity in RFC 5280. This value is unaffected\n when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the\n future, the certificate will expire 20 days from issuance time regardless of the\n ValidityNotBefore value.

" + } + }, + "com.amazonaws.pcaconnectorad#ValidityPeriodType": { + "type": "enum", + "members": { + "HOURS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOURS" + } + }, + "DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAYS" + } + }, + "WEEKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEKS" + } + }, + "MONTHS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHS" + } + }, + "YEARS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YEARS" + } + } + } + }, + "com.amazonaws.pcaconnectorad#VpcInformation": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "target": "com.amazonaws.pcaconnectorad#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

The security groups used with the connector. You can use a maximum of 4 security groups\n with a connector.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about your VPC and security groups used with the connector.

" + } + } + } +} \ No newline at end of file diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index 4eb82fbfeac..bc1720a6c9b 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -4256,6 +4256,12 @@ "traits": { "smithy.api#documentation": "

The workspace settings for the SageMaker Canvas application.

" } + }, + "IdentityProviderOAuthSettings": { + "target": "com.amazonaws.sagemaker#IdentityProviderOAuthSettings", + "traits": { + "smithy.api#documentation": "

The settings for connecting to an external data source with OAuth.

" + } } }, "traits": { @@ -11606,6 +11612,23 @@ "smithy.api#documentation": "

Describes the location of the channel data.

" } }, + "com.amazonaws.sagemaker#DataSourceName": { + "type": "enum", + "members": { + "SalesforceGenie": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SalesforceGenie" + } + }, + "Snowflake": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Snowflake" + } + } + } + }, "com.amazonaws.sagemaker#Database": { "type": "string", "traits": { @@ -27263,6 +27286,44 @@ } } }, + "com.amazonaws.sagemaker#IdentityProviderOAuthSetting": { + "type": "structure", + "members": { + "DataSourceName": { + "target": "com.amazonaws.sagemaker#DataSourceName", + "traits": { + "smithy.api#documentation": "

The name of the data source that you're connecting to. Canvas currently supports OAuth for Snowflake and Salesforce Data Cloud.

" + } + }, + "Status": { + "target": "com.amazonaws.sagemaker#FeatureStatus", + "traits": { + "smithy.api#documentation": "

Describes whether OAuth for a data source is enabled or disabled in the Canvas\n application.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.sagemaker#SecretArn", + "traits": { + "smithy.api#documentation": "

The ARN of an Amazon Web Services Secrets Manager secret that stores the credentials from your\n identity provider, such as the client ID and secret, authorization URL, and token URL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon SageMaker Canvas app setting where you configure OAuth for connecting to an external\n data source, such as Snowflake.

" + } + }, + "com.amazonaws.sagemaker#IdentityProviderOAuthSettings": { + "type": "list", + "member": { + "target": "com.amazonaws.sagemaker#IdentityProviderOAuthSetting" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, "com.amazonaws.sagemaker#Image": { "type": "structure", "members": { @@ -47147,7 +47208,7 @@ "JobDurationInSeconds": { "target": "com.amazonaws.sagemaker#JobDurationInSeconds", "traits": { - "smithy.api#documentation": "

Specifies the maximum duration of the job, in seconds. The maximum value is 7200.

" + "smithy.api#documentation": "

Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.

" } }, "TrafficPattern": {