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.
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.
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": { @@ -10928,6 +11003,9 @@ "target": "com.amazonaws.appflow#UpdateFlowResponse" }, "errors": [ + { + "target": "com.amazonaws.appflow#AccessDeniedException" + }, { "target": "com.amazonaws.appflow#ConflictException" }, diff --git a/codegen/sdk/aws-models/application-auto-scaling.json b/codegen/sdk/aws-models/application-auto-scaling.json index e1a8b5ad9a8..10389491008 100644 --- a/codegen/sdk/aws-models/application-auto-scaling.json +++ b/codegen/sdk/aws-models/application-auto-scaling.json @@ -140,6 +140,7 @@ "arnNamespace": "application-autoscaling", "cloudFormationName": "ApplicationAutoScaling", "cloudTrailEventSource": "applicationautoscaling.amazonaws.com", + "docId": "application-autoscaling-2016-02-06", "endpointPrefix": "application-autoscaling" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/application-discovery-service.json b/codegen/sdk/aws-models/application-discovery-service.json index 2818542f524..be6ea71ed5a 100644 --- a/codegen/sdk/aws-models/application-discovery-service.json +++ b/codegen/sdk/aws-models/application-discovery-service.json @@ -115,6 +115,7 @@ "arnNamespace": "discovery", "cloudFormationName": "ApplicationDiscoveryService", "cloudTrailEventSource": "applicationdiscoveryservice.amazonaws.com", + "docId": "discovery-2015-11-01", "endpointPrefix": "discovery" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/applicationcostprofiler.json b/codegen/sdk/aws-models/applicationcostprofiler.json index 4ad95a95ad7..206abb7a5e4 100644 --- a/codegen/sdk/aws-models/applicationcostprofiler.json +++ b/codegen/sdk/aws-models/applicationcostprofiler.json @@ -58,6 +58,7 @@ "arnNamespace": "application-cost-profiler", "cloudFormationName": "ApplicationCostProfiler", "cloudTrailEventSource": "applicationcostprofiler.amazonaws.com", + "docId": "AWSApplicationCostProfiler-2020-09-10", "endpointPrefix": "application-cost-profiler" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/apprunner.json b/codegen/sdk/aws-models/apprunner.json index 87547cbf351..f5d51a34138 100644 --- a/codegen/sdk/aws-models/apprunner.json +++ b/codegen/sdk/aws-models/apprunner.json @@ -1553,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.
\nA 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.
\nA 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": { @@ -4172,6 +4172,12 @@ "traits": { "smithy.api#enumValue": "GITHUB" } + }, + "BITBUCKET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BITBUCKET" + } } } }, @@ -4442,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\n CREATE_FAILED – The service failed to create. To troubleshoot this failure, read the failure events and logs, change any\n parameters that need to be fixed, and retry the call to create the service.
The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.
\n\n DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure\n that all related resources are removed.
The current state of the App Runner service. These particular values mean the following.
\n\n CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. \n To troubleshoot this failure, read the failure events and logs, change any\n parameters that need to be fixed, and rebuild your service using UpdateService.
\n DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure\n that all related resources are removed.
The current state of the App Runner service. These particular values mean the following.
\n\n CREATE_FAILED – The service failed to create. Read the failure events and logs, change any parameters that need to be fixed,\n and retry the call to create the service.
The failed service isn't usable, and still counts towards your service quota. When you're done analyzing the failure, delete the service.
\n\n DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure\n that all related resources are removed.
The current state of the App Runner service. These particular values mean the following.
\n\n CREATE_FAILED – The service failed to create. The failed service isn't usable, and still counts towards your service quota. \n To troubleshoot this failure, read the failure events and logs, change any\n parameters that need to be fixed, and rebuild your service using UpdateService.
\n DELETE_FAILED – The service failed to delete and can't be successfully recovered. Retry the service deletion call to ensure\n that all related resources are removed.
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": { @@ -2752,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": { @@ -2886,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": { @@ -3267,7 +3285,8 @@ "traits": { "smithy.api#length": { "min": 1 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#ControlSetsCount": { @@ -3867,7 +3886,8 @@ "smithy.api#length": { "min": 1, "max": 50 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#CreatedBy": { @@ -3877,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": { @@ -3971,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": { @@ -3981,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": { @@ -4570,7 +4593,8 @@ "min": 1, "max": 320 }, - "smithy.api#pattern": "^.*@.*$" + "smithy.api#pattern": "^.*@.*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#ErrorCode": { @@ -5726,7 +5750,8 @@ } }, "traits": { - "smithy.api#output": {} + "smithy.api#output": {}, + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#GetEvidenceFolder": { @@ -6509,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": { @@ -7529,7 +7555,8 @@ "min": 1, "max": 300 }, - "smithy.api#pattern": "^[^\\/]*$" + "smithy.api#pattern": "^[^\\/]*$", + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#ManualEvidenceTextResponse": { @@ -7539,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": { @@ -7917,6 +7945,9 @@ "type": "list", "member": { "target": "com.amazonaws.auditmanager#Role" + }, + "traits": { + "smithy.api#sensitive": {} } }, "com.amazonaws.auditmanager#S3Url": { @@ -7936,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": { @@ -7956,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": { @@ -8552,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": { @@ -8601,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": { @@ -9440,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/aws-models/auto-scaling-plans.json b/codegen/sdk/aws-models/auto-scaling-plans.json index 6cef03205f3..a110d23dde9 100644 --- a/codegen/sdk/aws-models/auto-scaling-plans.json +++ b/codegen/sdk/aws-models/auto-scaling-plans.json @@ -58,6 +58,7 @@ "arnNamespace": "autoscaling-plans", "cloudFormationName": "AutoScalingPlans", "cloudTrailEventSource": "autoscalingplans.amazonaws.com", + "docId": "autoscaling-plans-2018-01-06", "endpointPrefix": "autoscaling-plans" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/auto-scaling.json b/codegen/sdk/aws-models/auto-scaling.json index 014424840bc..8d867b1718b 100644 --- a/codegen/sdk/aws-models/auto-scaling.json +++ b/codegen/sdk/aws-models/auto-scaling.json @@ -1281,6 +1281,7 @@ "arnNamespace": "autoscaling", "cloudFormationName": "AutoScaling", "cloudTrailEventSource": "autoscaling.amazonaws.com", + "docId": "autoscaling-2011-01-01", "endpointPrefix": "autoscaling" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/backup.json b/codegen/sdk/aws-models/backup.json index 91ce36fb0dc..0a1a679cfdc 100644 --- a/codegen/sdk/aws-models/backup.json +++ b/codegen/sdk/aws-models/backup.json @@ -568,6 +568,12 @@ "traits": { "smithy.api#documentation": "Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False\n (or not specified) causes Backup to create snapshot backups.
" } + }, + "ScheduleExpressionTimezone": { + "target": "com.amazonaws.backup#Timezone", + "traits": { + "smithy.api#documentation": "This is the timezone in which the schedule expression is set. By default, \n ScheduleExpressions are in UTC. You can modify this to a specified timezone.
" + } } }, "traits": { @@ -632,6 +638,12 @@ "traits": { "smithy.api#documentation": "Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False\n (or not specified) causes Backup to create snapshot backups.
" } + }, + "ScheduleExpressionTimezone": { + "target": "com.amazonaws.backup#Timezone", + "traits": { + "smithy.api#documentation": "This is the timezone in which the schedule expression is set. By default, \n ScheduleExpressions are in UTC. You can modify this to a specified timezone.
" + } } }, "traits": { @@ -1995,7 +2007,7 @@ } ], "traits": { - "smithy.api#documentation": "This request creates a logical container where backups are stored.
\nThis request includes a name, optionally one or more resource tags, an encryption key, \n and a request ID.
\nDo not include sensitive data, such as passport numbers, in the name of a backup\n vault.
\nThis request creates a logical container to where backups may be copied.
\nThis request includes a name, the Region, the maximum number of retention days, the \n minimum number of retention days, and optionally can include tags and a creator request \n ID.
\nDo not include sensitive data, such as passport numbers, in the name of a backup\n vault.
\nThe scope of a control. The control scope defines what the control will evaluate. Three\n examples of control scopes are: a specific backup plan, all backup plans with a specific\n tag, or all backup plans. For more information, see \n ControlScope.\n
The scope of a control. The control scope defines what the control will evaluate. Three\n examples of control scopes are: a specific backup plan, all backup plans with a specific\n tag, or all backup plans.
" } } }, @@ -9747,6 +9759,9 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.backup#Timezone": { + "type": "string" + }, "com.amazonaws.backup#UntagResource": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/cleanrooms.json b/codegen/sdk/aws-models/cleanrooms.json index 61f47650f54..cb3aac82da8 100644 --- a/codegen/sdk/aws-models/cleanrooms.json +++ b/codegen/sdk/aws-models/cleanrooms.json @@ -64,7 +64,7 @@ ], "maxAge": 86400 }, - "smithy.api#documentation": "Welcome to the Clean Rooms API Reference.
\nClean 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.
\nTo 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.
\nClean 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.
\nTo learn more about Clean Rooms concepts, procedures, and best practices, see the\n Clean Rooms User Guide.
\nTo 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", @@ -841,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": {} } }, @@ -865,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": { @@ -910,7 +910,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 100 + "max": 225 } } }, @@ -942,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": {} } }, @@ -1069,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": { @@ -1131,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": { @@ -1140,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 }, @@ -1506,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": {} } }, @@ -1563,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", @@ -1598,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": { @@ -1618,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" @@ -1627,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": {} } } @@ -1646,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": {} } } @@ -1798,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": {} } }, @@ -1811,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": {} } }, @@ -1870,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": { @@ -1894,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": {} } }, @@ -1914,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": {} } }, @@ -1995,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": {} } }, @@ -2016,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": {} } }, @@ -2030,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": {} } }, @@ -2195,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": {} } }, @@ -2276,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": { @@ -2358,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": {} } }, @@ -2429,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": { @@ -2564,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": {} } }, @@ -2676,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": {} } }, @@ -2826,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": {} } } @@ -2977,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": { @@ -3076,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": { @@ -3089,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.
" } } } @@ -3193,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" @@ -3313,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.
" } } } @@ -3356,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.
" } } } @@ -3448,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.
" } } } @@ -3471,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": {} } } @@ -3708,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": {} } @@ -3767,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" @@ -4102,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" @@ -4111,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" @@ -4235,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" @@ -4244,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": {} } @@ -4305,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" @@ -4587,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": {} } @@ -4733,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": { @@ -4789,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" } }, @@ -4808,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": { @@ -4865,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" @@ -4874,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" } }, @@ -4893,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": { @@ -4947,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" } }, @@ -4973,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": { @@ -5030,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": {} } @@ -5038,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" } }, @@ -5064,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.
" } } } @@ -5111,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" } }, @@ -5137,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.
" } } } @@ -5196,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" } }, @@ -5215,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": { @@ -5269,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" } }, @@ -5295,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": { @@ -5370,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" } }, @@ -5389,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": { @@ -5455,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" } }, @@ -5488,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.
" } } } @@ -5525,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": {} } @@ -5601,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": {} } }, @@ -5653,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" } @@ -5661,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": {} } }, @@ -5751,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": {} } }, @@ -5786,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": {} } }, @@ -5803,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": { @@ -5828,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": { @@ -5944,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": {} } }, @@ -5979,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": {} } }, @@ -6167,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": { @@ -6181,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": { @@ -6205,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": { @@ -6240,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": { @@ -6248,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": { @@ -6361,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": { @@ -6376,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": { @@ -6460,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": {} } } @@ -6673,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": {} } }, @@ -6693,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": {} } }, @@ -6818,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`.
" } } }, @@ -6903,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", @@ -6924,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" @@ -6940,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.
" } } } @@ -6999,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": { @@ -7169,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": {} } @@ -7317,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": { @@ -7431,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": {} } @@ -7504,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" @@ -7551,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" @@ -7638,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.
" + } } } }, @@ -7714,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/aws-models/cloudhsm-v2.json b/codegen/sdk/aws-models/cloudhsm-v2.json index 1ec8753110b..aa16b18c41d 100644 --- a/codegen/sdk/aws-models/cloudhsm-v2.json +++ b/codegen/sdk/aws-models/cloudhsm-v2.json @@ -262,6 +262,7 @@ "arnNamespace": "cloudhsm", "cloudFormationName": "CloudHSMV2", "cloudTrailEventSource": "cloudhsmv2.amazonaws.com", + "docId": "cloudhsmv2-2017-04-28", "endpointPrefix": "cloudhsmv2" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/cloudsearch-domain.json b/codegen/sdk/aws-models/cloudsearch-domain.json index 2a163cee815..1eebf671b68 100644 --- a/codegen/sdk/aws-models/cloudsearch-domain.json +++ b/codegen/sdk/aws-models/cloudsearch-domain.json @@ -55,6 +55,7 @@ "arnNamespace": "cloudsearch", "cloudFormationName": "CloudSearchDomain", "cloudTrailEventSource": "cloudsearchdomain.amazonaws.com", + "docId": "cloudsearchdomain-2013-01-01", "endpointPrefix": "cloudsearchdomain" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/cloudtrail.json b/codegen/sdk/aws-models/cloudtrail.json index eb2ee584425..025baa7af0c 100644 --- a/codegen/sdk/aws-models/cloudtrail.json +++ b/codegen/sdk/aws-models/cloudtrail.json @@ -2272,6 +2272,9 @@ { "target": "com.amazonaws.cloudtrail#TagsLimitExceededException" }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, { "target": "com.amazonaws.cloudtrail#TrailAlreadyExistsException" }, @@ -2718,6 +2721,9 @@ { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, @@ -3958,6 +3964,9 @@ { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, @@ -6649,6 +6658,9 @@ { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, @@ -6756,6 +6768,9 @@ { "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, @@ -7973,6 +7988,9 @@ { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, @@ -8314,6 +8332,9 @@ { "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, @@ -8428,6 +8449,26 @@ "com.amazonaws.cloudtrail#TerminationProtectionEnabled": { "type": "boolean" }, + "com.amazonaws.cloudtrail#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ThrottlingException", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "\n This exception is thrown when the request rate exceeds the limit. \n
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, "com.amazonaws.cloudtrail#Trail": { "type": "structure", "members": { @@ -9070,6 +9111,9 @@ { "target": "com.amazonaws.cloudtrail#S3BucketDoesNotExistException" }, + { + "target": "com.amazonaws.cloudtrail#ThrottlingException" + }, { "target": "com.amazonaws.cloudtrail#TrailNotFoundException" }, diff --git a/codegen/sdk/aws-models/cloudwatch-logs.json b/codegen/sdk/aws-models/cloudwatch-logs.json index 888fcf84dd7..a3f0e0d634f 100644 --- a/codegen/sdk/aws-models/cloudwatch-logs.json +++ b/codegen/sdk/aws-models/cloudwatch-logs.json @@ -3292,6 +3292,7 @@ "arnNamespace": "logs", "cloudFormationName": "Logs", "cloudTrailEventSource": "cloudwatchlogs.amazonaws.com", + "docId": "logs-2014-03-28", "endpointPrefix": "logs" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/cloudwatch.json b/codegen/sdk/aws-models/cloudwatch.json index e880481a5b0..9ab9f01acd3 100644 --- a/codegen/sdk/aws-models/cloudwatch.json +++ b/codegen/sdk/aws-models/cloudwatch.json @@ -2562,6 +2562,7 @@ "arnNamespace": "monitoring", "cloudFormationName": "CloudWatch", "cloudTrailEventSource": "cloudwatch.amazonaws.com", + "docId": "monitoring-2010-08-01", "endpointPrefix": "monitoring" }, "aws.auth#sigv4": { @@ -4431,7 +4432,7 @@ "ResourceARN": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { - "smithy.api#documentation": "The ARN of the CloudWatch resource that you want to view tags for.
\nThe ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n
The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n
For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.
", + "smithy.api#documentation": "The ARN of the CloudWatch resource that you want to view tags for.
\nThe ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n
The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name\n \n
For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.
", "smithy.api#required": {} } } @@ -6743,7 +6744,7 @@ "ResourceARN": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { - "smithy.api#documentation": "The ARN of the CloudWatch resource that you're adding tags to.
\nThe ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n
The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n
For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.
", + "smithy.api#documentation": "The ARN of the CloudWatch resource that you're adding tags to.
\nThe ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n
The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name\n \n
For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.
", "smithy.api#required": {} } }, @@ -6838,7 +6839,7 @@ "ResourceARN": { "target": "com.amazonaws.cloudwatch#AmazonResourceName", "traits": { - "smithy.api#documentation": "The ARN of the CloudWatch resource that you're removing tags from.
\nThe ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n
The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule:insight-rule-name\n \n
For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.
", + "smithy.api#documentation": "The ARN of the CloudWatch resource that you're removing tags from.
\nThe ARN format of an alarm is \n\t\t\tarn:aws:cloudwatch:Region:account-id:alarm:alarm-name\n \n
The ARN format of a Contributor Insights rule is \n\t\t\tarn:aws:cloudwatch:Region:account-id:insight-rule/insight-rule-name\n \n
For more information about ARN format, see Resource\n\t\t\t\tTypes Defined by Amazon CloudWatch in the Amazon Web Services General\n\t\t\tReference.
", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/cognito-identity-provider.json b/codegen/sdk/aws-models/cognito-identity-provider.json index 95b24327433..8f8ffffb633 100644 --- a/codegen/sdk/aws-models/cognito-identity-provider.json +++ b/codegen/sdk/aws-models/cognito-identity-provider.json @@ -359,6 +359,7 @@ "arnNamespace": "cognito-idp", "cloudFormationName": "Cognito", "cloudTrailEventSource": "cognitoidentityprovider.amazonaws.com", + "docId": "cognito-idp-2016-04-18", "endpointPrefix": "cognito-idp" }, "aws.auth#sigv4": { @@ -1668,7 +1669,63 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new user in the specified user pool.
\nIf MessageAction isn't set, the default is to send a welcome message via\n email or phone (SMS).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThis message is based on a template that you configured in your call to create or\n update a user pool. This template includes your custom sign-up instructions and\n placeholders for user name and temporary password.
\nAlternatively, you can call AdminCreateUser with SUPPRESS\n for the MessageAction parameter, and Amazon Cognito won't send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD state until\n they sign in and change their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nCreates a new user in the specified user pool.
\nIf MessageAction isn't set, the default is to send a welcome message via\n email or phone (SMS).
This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nThis message is based on a template that you configured in your call to create or\n update a user pool. This template includes your custom sign-up instructions and\n placeholders for user name and temporary password.
\nAlternatively, you can call AdminCreateUser with SUPPRESS\n for the MessageAction parameter, and Amazon Cognito won't send any email.
In either case, the user will be in the FORCE_CHANGE_PASSWORD state until\n they sign in and change their password.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nUpdates the specified user's attributes, including developer attributes, as an\n administrator. Works on any user.
\nFor custom attributes, you must prepend the custom: prefix to the\n attribute name.
In addition to updating user attributes, this API can also be used to mark phone and\n email as verified.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nUpdates the specified user's attributes, including developer attributes, as an\n administrator. Works on any user. To delete an attribute from your user, submit the\n attribute in your API request with a blank value.
\nFor custom attributes, you must prepend the custom: prefix to the\n attribute name.
In addition to updating user attributes, this API can also be used to mark phone and\n email as verified.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nBegins setup of time-based one-time password (TOTP) multi-factor authentication (MFA)\n for a user, with a unique private key that Amazon Cognito generates and returns in the API\n response. You can authorize an AssociateSoftwareToken request with either\n the user's access token, or a session string from a challenge response that you received\n from Amazon Cognito.
Amazon Cognito disassociates an existing software token when you verify the new token in a\n VerifySoftwareToken API request. If you don't verify the software\n token and your user pool doesn't require MFA, the user can then authenticate with\n user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito\n generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge\n each time your user signs. Complete setup with AssociateSoftwareToken\n and VerifySoftwareToken.
After you set up software token MFA for your user, Amazon Cognito generates a\n SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to\n this challenge with your user's TOTP.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nBegins setup of time-based one-time password (TOTP) multi-factor authentication (MFA)\n for a user, with a unique private key that Amazon Cognito generates and returns in the API\n response. You can authorize an AssociateSoftwareToken request with either\n the user's access token, or a session string from a challenge response that you received\n from Amazon Cognito.
Amazon Cognito disassociates an existing software token when you verify the new token in a\n VerifySoftwareToken API request. If you don't verify the software\n token and your user pool doesn't require MFA, the user can then authenticate with\n user name and password credentials alone. If your user pool requires TOTP MFA, Amazon Cognito\n generates an MFA_SETUP or SOFTWARE_TOKEN_SETUP challenge\n each time your user signs. Complete setup with AssociateSoftwareToken\n and VerifySoftwareToken.
After you set up software token MFA for your user, Amazon Cognito generates a\n SOFTWARE_TOKEN_MFA challenge when they authenticate. Respond to\n this challenge with your user's TOTP.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nThe Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs.\n The log group must not be encrypted with Key Management Service and must be in the same Amazon Web Services account\n as your user pool.
" + "smithy.api#documentation": "The Amazon Resource Name (arn) of a CloudWatch Logs log group where your user pool sends logs.\n The log group must not be encrypted with Key Management Service and must be in the same Amazon Web Services account\n as your user pool.
\nTo send logs to log groups with a resource policy of a size greater than 5120\n characters, configure a log group with a path that starts with\n /aws/vendedlogs. For more information, see Enabling\n logging from certain Amazon Web Services services.
The CloudWatch logging destination of a user pool detailed activity logging configuration.
" + "smithy.api#documentation": "The CloudWatch logging destination of a user pool detailed activity logging\n configuration.
" } }, "com.amazonaws.cognitoidentityprovider#CodeDeliveryDetailsListType": { @@ -4741,7 +4803,9 @@ } ], "traits": { - "smithy.api#documentation": "Confirms tracking of the device. This API call is the call that begins device\n tracking.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nConfirms tracking of the device. This API call is the call that begins device\n tracking.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nThe IdP name.
", "smithy.api#required": {} @@ -5497,7 +5561,459 @@ } ], "traits": { - "smithy.api#documentation": "This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCreates a new Amazon Cognito user pool and sets the password policy for the\n pool.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nCreates a new Amazon Cognito user pool and sets the password policy for the\n pool.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nCreates the user pool client.
\nWhen you create a new user pool client, token revocation is automatically activated.\n For more information about revoking tokens, see RevokeToken.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nCreates the user pool client.
\nWhen you create a new user pool client, token revocation is automatically activated.\n For more information about revoking tokens, see RevokeToken.
\nIf you don't provide a value for an attribute, Amazon Cognito sets it to its default value.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nForgets the specified device.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nForgets the specified device.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nGets the device.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nGets the device.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nThe ID of the user pool where you want to view detailed activity logging configuration.
", + "smithy.api#documentation": "The ID of the user pool where you want to view detailed activity logging\n configuration.
", "smithy.api#required": {} } } @@ -8667,7 +9311,9 @@ } ], "traits": { - "smithy.api#documentation": "Signs out a user from all devices. GlobalSignOut invalidates all\n identity, access and refresh tokens that Amazon Cognito has issued to a user. A user can still\n use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie\n validity period.
Your app isn't aware that a user's access token is revoked unless it attempts to\n authorize a user pools API request with an access token that contains the scope\n aws.cognito.signin.user.admin. Your app might otherwise accept access\n tokens until they expire.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nSigns out a user from all devices. GlobalSignOut invalidates all\n identity, access and refresh tokens that Amazon Cognito has issued to a user. A user can still\n use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie\n validity period.
Your app isn't aware that a user's access token is revoked unless it attempts to\n authorize a user pools API request with an access token that contains the scope\n aws.cognito.signin.user.admin. Your app might otherwise accept access\n tokens until they expire.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nInitiates sign-in for a user in the Amazon Cognito user directory. You can't sign in a user\n with a federated IdP with InitiateAuth. For more information, see Adding user pool sign-in through a third party.
Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nThis action might generate an SMS text message. Starting June 1, 2021, US telecom carriers\n require you to register an origination phone number before you can send SMS messages\n to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a\n phone number with Amazon Pinpoint.\n Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must\n receive SMS messages might not be able to sign up, activate their accounts, or sign\n in.
\nIf you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service,\n Amazon Simple Notification Service might place your account in the SMS sandbox. In \n sandbox\n mode\n , you can send messages only to verified phone\n numbers. After you test your app while in the sandbox environment, you can move out\n of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito\n Developer Guide.
\nLists the sign-in devices that Amazon Cognito has registered to the current user.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nLists the sign-in devices that Amazon Cognito has registered to the current user.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nLists users and their basic details in a user pool.
\nAmazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you must use IAM credentials to authorize requests, and you must\n grant yourself the corresponding IAM permission in a policy.
\n\n Learn more\n
\n\n Using the Amazon Cognito user pools API and user pool endpoints\n
\nThe errorlevel selection of logs that a user pool sends for detailed activity logging.
The errorlevel selection of logs that a user pool sends for detailed\n activity logging.
Revokes all of the access tokens generated by, and at the same time as, the specified\n refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito\n user APIs, or to authorize access to your resource server.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nRevokes all of the access tokens generated by, and at the same time as, the specified\n refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito\n user APIs, or to authorize access to your resource server.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nA collection of all of the detailed activity logging configurations for a user pool.
", + "smithy.api#documentation": "A collection of all of the detailed activity logging configurations for a user\n pool.
", "smithy.api#required": {} } } @@ -11746,7 +12503,7 @@ "LogDeliveryConfiguration": { "target": "com.amazonaws.cognitoidentityprovider#LogDeliveryConfigurationType", "traits": { - "smithy.api#documentation": "The detailed activity logging configuration that you applied to the requested user pool.
" + "smithy.api#documentation": "The detailed activity logging configuration that you applied to the requested user\n pool.
" } } }, @@ -11958,7 +12715,9 @@ } ], "traits": { - "smithy.api#documentation": "Set the user's multi-factor authentication (MFA) method preference, including which\n MFA factors are activated and if any are preferred. Only one factor can be set as\n preferred. The preferred MFA factor will be used to authenticate a user if multiple\n factors are activated. If multiple options are activated and no preference is set, a\n challenge to choose an MFA option will be returned during sign-in. If an MFA type is\n activated for a user, the user will be prompted for MFA during all sign-in attempts\n unless device tracking is turned on and the device has been trusted. If you want MFA to\n be applied selectively based on the assessed risk level of sign-in attempts, deactivate\n MFA for users and turn on Adaptive Authentication for the user pool.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nSet the user's multi-factor authentication (MFA) method preference, including which\n MFA factors are activated and if any are preferred. Only one factor can be set as\n preferred. The preferred MFA factor will be used to authenticate a user if multiple\n factors are activated. If multiple options are activated and no preference is set, a\n challenge to choose an MFA option will be returned during sign-in. If an MFA type is\n activated for a user, the user will be prompted for MFA during all sign-in attempts\n unless device tracking is turned on and the device has been trusted. If you want MFA to\n be applied selectively based on the assessed risk level of sign-in attempts, deactivate\n MFA for users and turn on Adaptive Authentication for the user pool.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nProvides the feedback for an authentication event, whether it was from a valid user or\n not. This feedback is used for improving the risk evaluation decision for the user pool\n as part of Amazon Cognito advanced security.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nProvides the feedback for an authentication event, whether it was from a valid user or\n not. This feedback is used for improving the risk evaluation decision for the user pool\n as part of Amazon Cognito advanced security.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nUpdates the device status.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nUpdates the device status.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nContextual data, such as the user's device fingerprint, IP address, or location, used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
" + "smithy.api#documentation": "Contextual data, such as the user's device fingerprint, IP address, or location, used\n for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
", + "smithy.api#sensitive": {} } }, "com.amazonaws.cognitoidentityprovider#UserFilterType": { @@ -15131,7 +15896,9 @@ } ], "traits": { - "smithy.api#documentation": "Use this API to register a user's entered time-based one-time password (TOTP) code and\n mark the user's software token MFA status as \"verified\" if successful. The request takes\n an access token or a session string, but not both.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\nUse this API to register a user's entered time-based one-time password (TOTP) code and\n mark the user's software token MFA status as \"verified\" if successful. The request takes\n an access token or a session string, but not both.
\nAmazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For\n this operation, you can't use IAM credentials to authorize requests, and you can't\n grant IAM permissions in policies. For more information about authorization models in\n Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.
\n\n Export optimization recommendations for your licenses.\n
\nRecommendations are exported in a comma-separated values (CSV) file, and its metadata\n in a JavaScript Object Notation (JSON) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting\n Recommendations in the Compute Optimizer User\n Guide.
\nYou can have only one license export job in progress per Amazon Web Services Region.
" + } + }, + "com.amazonaws.computeoptimizer#ExportLicenseRecommendationsRequest": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.computeoptimizer#AccountIds", + "traits": { + "smithy.api#documentation": "The IDs of the Amazon Web Services accounts for which to export license\n recommendations.
\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.
\nThis parameter can't be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.
\nIf this parameter is omitted, recommendations \n for member accounts aren't included in the export.
\nYou can specify multiple account IDs per request.
" + } + }, + "filters": { + "target": "com.amazonaws.computeoptimizer#LicenseRecommendationFilters", + "traits": { + "smithy.api#documentation": "\n An array of objects to specify a filter that exports a more specific set of license recommendations.\n
" + } + }, + "fieldsToExport": { + "target": "com.amazonaws.computeoptimizer#ExportableLicenseFields", + "traits": { + "smithy.api#documentation": "The recommendations data to include in the export file. For more information about the\n fields that can be exported, see Exported files in the Compute Optimizer User\n Guide.
" + } + }, + "s3DestinationConfig": { + "target": "com.amazonaws.computeoptimizer#S3DestinationConfig", + "traits": { + "smithy.api#required": {} + } + }, + "fileFormat": { + "target": "com.amazonaws.computeoptimizer#FileFormat", + "traits": { + "smithy.api#documentation": "The format of the export file.
\nA CSV file is the only export format currently supported.
" + } + }, + "includeMemberAccounts": { + "target": "com.amazonaws.computeoptimizer#IncludeMemberAccounts", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.
\nThe member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information,\n see Compute Optimizer and Amazon Web Services Organizations trusted access in the\n Compute Optimizer User Guide.
\nIf this parameter is omitted, recommendations for member accounts of the organization \n aren't included in the export file .
\nThis parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.computeoptimizer#ExportLicenseRecommendationsResponse": { + "type": "structure", + "members": { + "jobId": { + "target": "com.amazonaws.computeoptimizer#JobId", + "traits": { + "smithy.api#documentation": "\n The identification number of the export job.\n
\nTo view the status of an export job, use the DescribeRecommendationExportJobs \n action and specify the job ID.
" + } + }, + "s3Destination": { + "target": "com.amazonaws.computeoptimizer#S3Destination" + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.computeoptimizer#ExportableAutoScalingGroupField": { "type": "enum", "members": { @@ -3784,6 +3890,143 @@ "target": "com.amazonaws.computeoptimizer#ExportableLambdaFunctionField" } }, + "com.amazonaws.computeoptimizer#ExportableLicenseField": { + "type": "enum", + "members": { + "ACCOUNT_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AccountId" + } + }, + "RESOURCE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ResourceArn" + } + }, + "LOOKBACK_PERIOD_IN_DAYS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LookbackPeriodInDays" + } + }, + "LAST_REFRESH_TIMESTAMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastRefreshTimestamp" + } + }, + "LICENSE_FINDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Finding" + } + }, + "LICENSE_FINDING_REASON_CODES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FindingReasonCodes" + } + }, + "CURRENT_LICENSE_CONFIGURATION_NUMBER_OF_CORES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CurrentLicenseConfigurationNumberOfCores" + } + }, + "CURRENT_LICENSE_CONFIGURATION_INSTANCE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CurrentLicenseConfigurationInstanceType" + } + }, + "CURRENT_LICENSE_CONFIGURATION_OPERATING_SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CurrentLicenseConfigurationOperatingSystem" + } + }, + "CURRENT_LICENSE_CONFIGURATION_LICENSE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CurrentLicenseConfigurationLicenseName" + } + }, + "CURRENT_LICENSE_CONFIGURATION_LICENSE_EDITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CurrentLicenseConfigurationLicenseEdition" + } + }, + "CURRENT_LICENSE_CONFIGURATION_LICENSE_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CurrentLicenseConfigurationLicenseModel" + } + }, + "CURRENT_LICENSE_CONFIGURATION_LICENSE_VERSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CurrentLicenseConfigurationLicenseVersion" + } + }, + "CURRENT_LICENSE_CONFIGURATION_METRICS_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CurrentLicenseConfigurationMetricsSource" + } + }, + "RECOMMENDATION_OPTIONS_OPERATING_SYSTEM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecommendationOptionsOperatingSystem" + } + }, + "RECOMMENDATION_OPTIONS_LICENSE_EDITION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecommendationOptionsLicenseEdition" + } + }, + "RECOMMENDATION_OPTIONS_LICENSE_MODEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecommendationOptionsLicenseModel" + } + }, + "RECOMMENDATION_OPTIONS_SAVINGS_OPPORTUNITY_PERCENTAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecommendationOptionsSavingsOpportunityPercentage" + } + }, + "RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_CURRENCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecommendationOptionsEstimatedMonthlySavingsCurrency" + } + }, + "RECOMMENDATION_OPTIONS_ESTIMATED_MONTHLY_SAVINGS_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RecommendationOptionsEstimatedMonthlySavingsValue" + } + }, + "TAGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Tags" + } + } + } + }, + "com.amazonaws.computeoptimizer#ExportableLicenseFields": { + "type": "list", + "member": { + "target": "com.amazonaws.computeoptimizer#ExportableLicenseField" + } + }, "com.amazonaws.computeoptimizer#ExportableVolumeField": { "type": "enum", "members": { @@ -5197,45 +5440,13 @@ "smithy.api#output": {} } }, - "com.amazonaws.computeoptimizer#GetRecommendationError": { - "type": "structure", - "members": { - "identifier": { - "target": "com.amazonaws.computeoptimizer#Identifier", - "traits": { - "smithy.api#documentation": "The ID of the error.
" - } - }, - "code": { - "target": "com.amazonaws.computeoptimizer#Code", - "traits": { - "smithy.api#documentation": "The error code.
" - } - }, - "message": { - "target": "com.amazonaws.computeoptimizer#Message", - "traits": { - "smithy.api#documentation": "The message, or reason, for the error.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Describes an error experienced when getting recommendations.
\nFor example, an error is returned if you request recommendations for an unsupported\n Auto Scaling group, or if you request recommendations for an instance of an\n unsupported instance family.
" - } - }, - "com.amazonaws.computeoptimizer#GetRecommendationErrors": { - "type": "list", - "member": { - "target": "com.amazonaws.computeoptimizer#GetRecommendationError" - } - }, - "com.amazonaws.computeoptimizer#GetRecommendationPreferences": { + "com.amazonaws.computeoptimizer#GetLicenseRecommendations": { "type": "operation", "input": { - "target": "com.amazonaws.computeoptimizer#GetRecommendationPreferencesRequest" + "target": "com.amazonaws.computeoptimizer#GetLicenseRecommendationsRequest" }, "output": { - "target": "com.amazonaws.computeoptimizer#GetRecommendationPreferencesResponse" + "target": "com.amazonaws.computeoptimizer#GetLicenseRecommendationsResponse" }, "errors": [ { @@ -5264,41 +5475,175 @@ } ], "traits": { - "smithy.api#documentation": "Returns existing recommendation preferences, such as enhanced infrastructure\n metrics.
\nUse the scope parameter to specify which preferences to return. You can\n specify to return preferences for an organization, a specific account ID, or a specific\n EC2 instance or Auto Scaling group Amazon Resource Name (ARN).
For more information, see Activating\n enhanced infrastructure metrics in the Compute Optimizer User\n Guide.
", - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "recommendationPreferencesDetails", - "pageSize": "maxResults" - } + "smithy.api#documentation": "Returns license recommendations for Amazon EC2 instances that run on a specific license.
\nCompute Optimizer generates recommendations for licenses that meet a specific set of requirements. For more\n information, see the Supported resources and\n requirements in the Compute Optimizer User\n Guide.
" } }, - "com.amazonaws.computeoptimizer#GetRecommendationPreferencesRequest": { + "com.amazonaws.computeoptimizer#GetLicenseRecommendationsRequest": { "type": "structure", "members": { - "resourceType": { - "target": "com.amazonaws.computeoptimizer#ResourceType", - "traits": { - "smithy.api#documentation": "The target resource type of the recommendation preference for which to return\n preferences.
\nThe Ec2Instance option encompasses standalone instances and instances\n that are part of Auto Scaling groups. The AutoScalingGroup option\n encompasses only instances that are part of an Auto Scaling group.
The valid values for this parameter are Ec2Instance and\n AutoScalingGroup.
An object that describes the scope of the recommendation preference to return.
\nYou can return recommendation preferences that are created at the organization level\n (for management accounts of an organization only), account level, and resource level.\n For more information, see Activating\n enhanced infrastructure metrics in the Compute Optimizer User\n Guide.
" + "smithy.api#documentation": "\n The ARN that identifies the Amazon EC2 instance.\n
\n\n The following is the format of the ARN:\n
\n\n arn:aws:ec2:region:aws_account_id:instance/instance-id\n
The token to advance to the next page of recommendation preferences.
" + "smithy.api#documentation": "\n The token to advance to the next page of license recommendations.\n
" } }, "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { - "smithy.api#documentation": "The maximum number of recommendation preferences to return with a single\n request.
\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
\n The maximum number of license recommendations to return with a single request.\n
\n\n To retrieve the remaining results, make another request with the returned\n nextToken value.\n
\n An array of objects to specify a filter that returns a more specific list of license recommendations.\n
" + } + }, + "accountIds": { + "target": "com.amazonaws.computeoptimizer#AccountIds", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account for which to return license recommendations.
\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return license recommendations.
\nOnly one account ID can be specified per request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.computeoptimizer#GetLicenseRecommendationsResponse": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.computeoptimizer#NextToken", + "traits": { + "smithy.api#documentation": "\n The token to use to advance to the next page of license recommendations.\n
" + } + }, + "licenseRecommendations": { + "target": "com.amazonaws.computeoptimizer#LicenseRecommendations", + "traits": { + "smithy.api#documentation": "\n An array of objects that describe license recommendations.\n
" + } + }, + "errors": { + "target": "com.amazonaws.computeoptimizer#GetRecommendationErrors", + "traits": { + "smithy.api#documentation": "\n An array of objects that describe errors of the request.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.computeoptimizer#GetRecommendationError": { + "type": "structure", + "members": { + "identifier": { + "target": "com.amazonaws.computeoptimizer#Identifier", + "traits": { + "smithy.api#documentation": "The ID of the error.
" + } + }, + "code": { + "target": "com.amazonaws.computeoptimizer#Code", + "traits": { + "smithy.api#documentation": "The error code.
" + } + }, + "message": { + "target": "com.amazonaws.computeoptimizer#Message", + "traits": { + "smithy.api#documentation": "The message, or reason, for the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an error experienced when getting recommendations.
\nFor example, an error is returned if you request recommendations for an unsupported\n Auto Scaling group, or if you request recommendations for an instance of an\n unsupported instance family.
" + } + }, + "com.amazonaws.computeoptimizer#GetRecommendationErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.computeoptimizer#GetRecommendationError" + } + }, + "com.amazonaws.computeoptimizer#GetRecommendationPreferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.computeoptimizer#GetRecommendationPreferencesRequest" + }, + "output": { + "target": "com.amazonaws.computeoptimizer#GetRecommendationPreferencesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.computeoptimizer#AccessDeniedException" + }, + { + "target": "com.amazonaws.computeoptimizer#InternalServerException" + }, + { + "target": "com.amazonaws.computeoptimizer#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.computeoptimizer#MissingAuthenticationToken" + }, + { + "target": "com.amazonaws.computeoptimizer#OptInRequiredException" + }, + { + "target": "com.amazonaws.computeoptimizer#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.computeoptimizer#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.computeoptimizer#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Returns existing recommendation preferences, such as enhanced infrastructure\n metrics.
\nUse the scope parameter to specify which preferences to return. You can\n specify to return preferences for an organization, a specific account ID, or a specific\n EC2 instance or Auto Scaling group Amazon Resource Name (ARN).
For more information, see Activating\n enhanced infrastructure metrics in the Compute Optimizer User\n Guide.
", + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "recommendationPreferencesDetails", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.computeoptimizer#GetRecommendationPreferencesRequest": { + "type": "structure", + "members": { + "resourceType": { + "target": "com.amazonaws.computeoptimizer#ResourceType", + "traits": { + "smithy.api#documentation": "The target resource type of the recommendation preference for which to return\n preferences.
\nThe Ec2Instance option encompasses standalone instances and instances\n that are part of Auto Scaling groups. The AutoScalingGroup option\n encompasses only instances that are part of an Auto Scaling group.
The valid values for this parameter are Ec2Instance and\n AutoScalingGroup.
An object that describes the scope of the recommendation preference to return.
\nYou can return recommendation preferences that are created at the organization level\n (for management accounts of an organization only), account level, and resource level.\n For more information, see Activating\n enhanced infrastructure metrics in the Compute Optimizer User\n Guide.
" + } + }, + "nextToken": { + "target": "com.amazonaws.computeoptimizer#NextToken", + "traits": { + "smithy.api#documentation": "The token to advance to the next page of recommendation preferences.
" + } + }, + "maxResults": { + "target": "com.amazonaws.computeoptimizer#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of recommendation preferences to return with a single\n request.
\nTo retrieve the remaining results, make another request with the returned\n nextToken value.
\n The current number of cores associated with the instance.\n
" + } + }, + "instanceType": { + "target": "com.amazonaws.computeoptimizer#InstanceType", + "traits": { + "smithy.api#documentation": "\n The instance type used in the license.\n
" + } + }, + "operatingSystem": { + "target": "com.amazonaws.computeoptimizer#OperatingSystem", + "traits": { + "smithy.api#documentation": "\n The operating system of the instance. \n
" + } + }, + "licenseEdition": { + "target": "com.amazonaws.computeoptimizer#LicenseEdition", + "traits": { + "smithy.api#documentation": "\n The edition of the license for the application that runs on the instance.\n
" + } + }, + "licenseName": { + "target": "com.amazonaws.computeoptimizer#LicenseName", + "traits": { + "smithy.api#documentation": "\n The name of the license for the application that runs on the instance.\n
" + } + }, + "licenseModel": { + "target": "com.amazonaws.computeoptimizer#LicenseModel", + "traits": { + "smithy.api#documentation": "\n The license type associated with the instance.\n
" + } + }, + "licenseVersion": { + "target": "com.amazonaws.computeoptimizer#LicenseVersion", + "traits": { + "smithy.api#documentation": "\n The version of the license for the application that runs on the instance.\n
" + } + }, + "metricsSource": { + "target": "com.amazonaws.computeoptimizer#MetricsSource", + "traits": { + "smithy.api#documentation": "\n The list of metric sources required to generate recommendations for commercial software licenses.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Describes the configuration of a license for an Amazon EC2 instance.\n
" + } + }, + "com.amazonaws.computeoptimizer#LicenseEdition": { + "type": "enum", + "members": { + "ENTERPRISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Enterprise" + } + }, + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Standard" + } + }, + "FREE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Free" + } + }, + "NO_LICENSE_EDITION_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NoLicenseEditionFound" + } + } + } + }, + "com.amazonaws.computeoptimizer#LicenseFinding": { + "type": "enum", + "members": { + "INSUFFICIENT_METRICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InsufficientMetrics" + } + }, + "OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Optimized" + } + }, + "NOT_OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NotOptimized" + } + } + } + }, + "com.amazonaws.computeoptimizer#LicenseFindingReasonCode": { + "type": "enum", + "members": { + "CW_APP_INSIGHTS_DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InvalidCloudWatchApplicationInsightsSetup" + } + }, + "CW_APP_INSIGHTS_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudWatchApplicationInsightsError" + } + }, + "LICENSE_OVER_PROVISIONED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LicenseOverprovisioned" + } + }, + "OPTIMIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Optimized" + } + } + } + }, + "com.amazonaws.computeoptimizer#LicenseFindingReasonCodes": { + "type": "list", + "member": { + "target": "com.amazonaws.computeoptimizer#LicenseFindingReasonCode" + } + }, + "com.amazonaws.computeoptimizer#LicenseModel": { + "type": "enum", + "members": { + "LICENSE_INCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LicenseIncluded" + } + }, + "BRING_YOUR_OWN_LICENSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BringYourOwnLicense" + } + } + } + }, + "com.amazonaws.computeoptimizer#LicenseName": { + "type": "enum", + "members": { + "SQLSERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQLServer" + } + } + } + }, + "com.amazonaws.computeoptimizer#LicenseRecommendation": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.computeoptimizer#ResourceArn", + "traits": { + "smithy.api#documentation": "\n The ARN that identifies the Amazon EC2 instance.\n
" + } + }, + "accountId": { + "target": "com.amazonaws.computeoptimizer#AccountId", + "traits": { + "smithy.api#documentation": "\n The Amazon Web Services account ID of the license. \n
" + } + }, + "currentLicenseConfiguration": { + "target": "com.amazonaws.computeoptimizer#LicenseConfiguration", + "traits": { + "smithy.api#documentation": "\n An object that describes the current configuration of an instance that runs on a license.\n
" + } + }, + "lookbackPeriodInDays": { + "target": "com.amazonaws.computeoptimizer#LookBackPeriodInDays", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "\n The number of days for which utilization metrics were analyzed for an instance that runs on a license.\n
" + } + }, + "lastRefreshTimestamp": { + "target": "com.amazonaws.computeoptimizer#LastRefreshTimestamp", + "traits": { + "smithy.api#documentation": "\n The timestamp of when the license recommendation was last generated.\n
" + } + }, + "finding": { + "target": "com.amazonaws.computeoptimizer#LicenseFinding", + "traits": { + "smithy.api#documentation": "\n The finding classification for an instance that runs on a license.\n
\nFindings include:
\n\n InsufficentMetrics — When Compute Optimizer detects that your CloudWatch\n Application Insights isn't enabled or is enabled with insufficient permissions.
\n NotOptimized — When Compute Optimizer detects that your EC2 infrastructure \n isn't using any of the SQL server license features you're paying for, a license is considered \n not optimized.
\n Optimized — When Compute Optimizer detects that all specifications of your \n license meet the performance requirements of your workload.
\n The reason for the finding classification for an instance that runs on a license.\n
\nFinding reason codes include:
\n\n Optimized — All specifications of your \n license meet the performance requirements of your workload.
\n LicenseOverprovisioned — A license is considered over-provisioned when your license can be \n downgraded while still meeting the performance requirements of your workload.
\n InvalidCloudwatchApplicationInsights — CloudWatch\n Application Insights isn't configured properly.
\n CloudwatchApplicationInsightsError — There is a CloudWatch\n Application Insights error.
\n An array of objects that describe the license recommendation options.\n
" + } + }, + "tags": { + "target": "com.amazonaws.computeoptimizer#Tags", + "traits": { + "smithy.api#documentation": "\n A list of tags assigned to an EC2 instance.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Describes a license recommendation for an EC2 instance.\n
" + } + }, + "com.amazonaws.computeoptimizer#LicenseRecommendationFilter": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.computeoptimizer#LicenseRecommendationFilterName", + "traits": { + "smithy.api#documentation": "The name of the filter.
\nSpecify Finding to return recommendations with a specific finding\n classification.
Specify FindingReasonCode to return recommendations with a specific\n finding reason code.
You can filter your license recommendations by tag:key \n and tag-key tags.
A tag:key is a key and value combination of a tag assigned to your \n license recommendations. Use the tag key in the filter name and the tag value \n as the filter value. For example, to find all license recommendations that have \n a tag with the key of Owner and the value of TeamA, \n specify tag:Owner for the filter name and TeamA for the filter value.
A tag-key is the key of a tag assigned to your license recommendations. Use \n this filter to find all of your license recommendations that have a tag with a \n specific key. This doesn’t consider the tag value. For example, you can find \n your license recommendations with a tag key value of Owner or without any tag \n keys assigned.
The value of the filter.
\nThe valid values for this parameter are as follows, depending on what you specify for\n the name parameter:
If you specify the name parameter as\n Finding, then specify Optimized, NotOptimized, or\n InsufficentMetrics.
If you specify the name parameter as\n FindingReasonCode, then specify Optimized,\n LicenseOverprovisioned, InvalidCloudwatchApplicationInsights, or\n CloudwatchApplicationInsightsError.
\n Describes a filter that returns a more specific list of license recommendations. Use this filter \n with the GetLicenseRecommendation action.\n
\n The rank of the license recommendation option.\n
\n\n The top recommendation option is ranked as 1.\n
\n The operating system of a license recommendation option.\n
" + } + }, + "licenseEdition": { + "target": "com.amazonaws.computeoptimizer#LicenseEdition", + "traits": { + "smithy.api#documentation": "\n The recommended edition of the license for the application that runs on the instance.\n
" + } + }, + "licenseModel": { + "target": "com.amazonaws.computeoptimizer#LicenseModel", + "traits": { + "smithy.api#documentation": "\n The recommended license type associated with the instance.\n
" + } + }, + "savingsOpportunity": { + "target": "com.amazonaws.computeoptimizer#SavingsOpportunity" + } + }, + "traits": { + "smithy.api#documentation": "\n Describes the recommendation options for licenses.\n
" + } + }, + "com.amazonaws.computeoptimizer#LicenseRecommendationOptions": { + "type": "list", + "member": { + "target": "com.amazonaws.computeoptimizer#LicenseRecommendationOption" + } + }, + "com.amazonaws.computeoptimizer#LicenseRecommendations": { + "type": "list", + "member": { + "target": "com.amazonaws.computeoptimizer#LicenseRecommendation" + } + }, + "com.amazonaws.computeoptimizer#LicenseVersion": { + "type": "string" + }, "com.amazonaws.computeoptimizer#LimitExceededException": { "type": "structure", "members": { @@ -6530,6 +7210,40 @@ } } }, + "com.amazonaws.computeoptimizer#MetricProviderArn": { + "type": "string" + }, + "com.amazonaws.computeoptimizer#MetricSource": { + "type": "structure", + "members": { + "provider": { + "target": "com.amazonaws.computeoptimizer#MetricSourceProvider", + "traits": { + "smithy.api#documentation": "\n The name of the metric source provider.\n
" + } + }, + "providerArn": { + "target": "com.amazonaws.computeoptimizer#MetricProviderArn", + "traits": { + "smithy.api#documentation": "\n The ARN of the metric source provider.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n The list of metric sources required to generate recommendations for commercial software licenses.\n
" + } + }, + "com.amazonaws.computeoptimizer#MetricSourceProvider": { + "type": "enum", + "members": { + "CloudWatchAppInsights": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CloudWatchApplicationInsights" + } + } + } + }, "com.amazonaws.computeoptimizer#MetricStatistic": { "type": "enum", "members": { @@ -6559,6 +7273,12 @@ "target": "com.amazonaws.computeoptimizer#MetricValue" } }, + "com.amazonaws.computeoptimizer#MetricsSource": { + "type": "list", + "member": { + "target": "com.amazonaws.computeoptimizer#MetricSource" + } + }, "com.amazonaws.computeoptimizer#MigrationEffort": { "type": "enum", "members": { @@ -6619,6 +7339,12 @@ "com.amazonaws.computeoptimizer#NullableMemoryReservation": { "type": "integer" }, + "com.amazonaws.computeoptimizer#NumberOfCores": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, "com.amazonaws.computeoptimizer#NumberOfInvocations": { "type": "long", "traits": { @@ -6628,6 +7354,9 @@ "com.amazonaws.computeoptimizer#NumberOfMemberAccountsOptedIn": { "type": "integer" }, + "com.amazonaws.computeoptimizer#OperatingSystem": { + "type": "string" + }, "com.amazonaws.computeoptimizer#OptInRequiredException": { "type": "structure", "members": { @@ -7063,6 +7792,12 @@ "traits": { "smithy.api#enumValue": "EcsService" } + }, + "LICENSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "License" + } } } }, @@ -7161,6 +7896,12 @@ "com.amazonaws.computeoptimizer#ResourceArn": { "type": "string" }, + "com.amazonaws.computeoptimizer#ResourceArns": { + "type": "list", + "member": { + "target": "com.amazonaws.computeoptimizer#ResourceArn" + } + }, "com.amazonaws.computeoptimizer#ResourceNotFoundException": { "type": "structure", "members": { @@ -7212,6 +7953,12 @@ "traits": { "smithy.api#enumValue": "EcsService" } + }, + "LICENSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "License" + } } } }, diff --git a/codegen/sdk/aws-models/config-service.json b/codegen/sdk/aws-models/config-service.json index 07c3bf0502c..d98e34a8d6b 100644 --- a/codegen/sdk/aws-models/config-service.json +++ b/codegen/sdk/aws-models/config-service.json @@ -14463,6 +14463,7 @@ "arnNamespace": "config", "cloudFormationName": "Config", "cloudTrailEventSource": "configservice.amazonaws.com", + "docId": "config-2014-11-12", "endpointPrefix": "config" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/cost-and-usage-report-service.json b/codegen/sdk/aws-models/cost-and-usage-report-service.json index 364859e7fe8..a58d5dd784a 100644 --- a/codegen/sdk/aws-models/cost-and-usage-report-service.json +++ b/codegen/sdk/aws-models/cost-and-usage-report-service.json @@ -52,6 +52,7 @@ "arnNamespace": "cur", "cloudFormationName": "CostandUsageReportService", "cloudTrailEventSource": "costandusagereportservice.amazonaws.com", + "docId": "cur-2017-01-06", "endpointPrefix": "cur" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/cost-explorer.json b/codegen/sdk/aws-models/cost-explorer.json index 59af09a0136..f2bb12892f3 100644 --- a/codegen/sdk/aws-models/cost-explorer.json +++ b/codegen/sdk/aws-models/cost-explorer.json @@ -154,6 +154,7 @@ "arnNamespace": "ce", "cloudFormationName": "CostExplorer", "cloudTrailEventSource": "costexplorer.amazonaws.com", + "docId": "ce-2017-10-25", "endpointPrefix": "ce" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/data-pipeline.json b/codegen/sdk/aws-models/data-pipeline.json index fee92fe329f..491529167ba 100644 --- a/codegen/sdk/aws-models/data-pipeline.json +++ b/codegen/sdk/aws-models/data-pipeline.json @@ -287,6 +287,7 @@ "arnNamespace": "datapipeline", "cloudFormationName": "DataPipeline", "cloudTrailEventSource": "datapipeline.amazonaws.com", + "docId": "datapipeline-2012-10-29", "endpointPrefix": "datapipeline" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/database-migration-service.json b/codegen/sdk/aws-models/database-migration-service.json index bcd6926bc86..a52cd5841bf 100644 --- a/codegen/sdk/aws-models/database-migration-service.json +++ b/codegen/sdk/aws-models/database-migration-service.json @@ -474,6 +474,7 @@ "arnNamespace": "dms", "cloudFormationName": "DMS", "cloudTrailEventSource": "databasemigrationservice.amazonaws.com", + "docId": "dms-2016-01-01", "endpointPrefix": "dms" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/datasync.json b/codegen/sdk/aws-models/datasync.json index d054e08b252..2cde9b70a89 100644 --- a/codegen/sdk/aws-models/datasync.json +++ b/codegen/sdk/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.
\nThe 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
Specifies a SAS token that provides permissions to access your Azure Blob Storage.
\nThe 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
Configures a task, which defines where and how DataSync transfers your\n data.
\nA 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).
\nIf 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.
\nConfigures a transfer task, which defines where and how DataSync moves your\n data.
\nA 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).
\nIf 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.
\nSpecifies 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.
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.
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.
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.
The status of the task execution.
\nFor 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
\nEach 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.
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.
\nEach 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.
\nFor 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).
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.
\nThere are several phases to a task execution. For more information, see Task execution statuses.
\nIf 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.
\nStarts an DataSync transfer task. For each task, you can only run one task\n execution at a time.
\nThere are several phases to a task execution. For more information, see Task execution statuses.
\nIf 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.
\nSpecifies 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\n SUMMARY_ONLY: Provides necessary details about your task, including the number of\n files, objects, and directories transferred and transfer duration.
\n STANDARD: Provides complete details about your task, including a full list of\n files, objects, and directories that were transferred, skipped, verified, and more.
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\n ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip,\n verify, and delete.
\n SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable\n to transfer, skip, verify, and delete.
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.
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.
\nFor 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.
\nCurrently, the only Option that you can modify with\n UpdateTaskExecution is \n BytesPerSecond\n , which throttles bandwidth for a running or queued\n task.
Updates the configuration of a running DataSync task execution.
\nCurrently, 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.
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/aws-models/detective.json b/codegen/sdk/aws-models/detective.json index 9ec12357bb0..4fcbfcac9e1 100644 --- a/codegen/sdk/aws-models/detective.json +++ b/codegen/sdk/aws-models/detective.json @@ -1952,7 +1952,8 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "^.+@(?:(?:(?!-)[A-Za-z0-9-]{1,62})?[A-Za-z0-9]{1}\\.)+[A-Za-z]{2,63}$" + "smithy.api#pattern": "^.+@(?:(?:(?!-)[A-Za-z0-9-]{1,62})?[A-Za-z0-9]{1}\\.)+[A-Za-z]{2,63}$", + "smithy.api#sensitive": {} } }, "com.amazonaws.detective#EmailMessage": { @@ -1961,7 +1962,8 @@ "smithy.api#length": { "min": 1, "max": 1000 - } + }, + "smithy.api#sensitive": {} } }, "com.amazonaws.detective#EnableOrganizationAdminAccount": { diff --git a/codegen/sdk/aws-models/device-farm.json b/codegen/sdk/aws-models/device-farm.json index 7a39a8823d7..2aee36c4bd4 100644 --- a/codegen/sdk/aws-models/device-farm.json +++ b/codegen/sdk/aws-models/device-farm.json @@ -2346,6 +2346,7 @@ "arnNamespace": "devicefarm", "cloudFormationName": "DeviceFarm", "cloudTrailEventSource": "devicefarm.amazonaws.com", + "docId": "devicefarm-2015-06-23", "endpointPrefix": "devicefarm" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/direct-connect.json b/codegen/sdk/aws-models/direct-connect.json index f7518d758ac..897ec293306 100644 --- a/codegen/sdk/aws-models/direct-connect.json +++ b/codegen/sdk/aws-models/direct-connect.json @@ -5207,6 +5207,7 @@ "arnNamespace": "directconnect", "cloudFormationName": "DirectConnect", "cloudTrailEventSource": "directconnect.amazonaws.com", + "docId": "directconnect-2012-10-25", "endpointPrefix": "directconnect" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/directory-service.json b/codegen/sdk/aws-models/directory-service.json index 8721c153e9e..e13320d38ba 100644 --- a/codegen/sdk/aws-models/directory-service.json +++ b/codegen/sdk/aws-models/directory-service.json @@ -3968,6 +3968,7 @@ "arnNamespace": "ds", "cloudFormationName": "DirectoryService", "cloudTrailEventSource": "directoryservice.amazonaws.com", + "docId": "ds-2015-04-16", "endpointPrefix": "ds" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/dynamodb-streams.json b/codegen/sdk/aws-models/dynamodb-streams.json index 7e33375ece7..17a1eb8b9f0 100644 --- a/codegen/sdk/aws-models/dynamodb-streams.json +++ b/codegen/sdk/aws-models/dynamodb-streams.json @@ -216,6 +216,7 @@ "arnNamespace": "dynamodb", "cloudFormationName": "DynamoDBStreams", "cloudTrailEventSource": "dynamodbstreams.amazonaws.com", + "docId": "streams-dynamodb-2012-08-10", "endpointPrefix": "streams.dynamodb" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/ec2.json b/codegen/sdk/aws-models/ec2.json index dcb2bb0b126..16cf8a51163 100644 --- a/codegen/sdk/aws-models/ec2.json +++ b/codegen/sdk/aws-models/ec2.json @@ -63584,6 +63584,102 @@ "traits": { "smithy.api#enumValue": "m7i-flex.8xlarge" } + }, + "m7a_medium": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.medium" + } + }, + "m7a_large": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.large" + } + }, + "m7a_xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.xlarge" + } + }, + "m7a_2xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.2xlarge" + } + }, + "m7a_4xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.4xlarge" + } + }, + "m7a_8xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.8xlarge" + } + }, + "m7a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.12xlarge" + } + }, + "m7a_16xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.16xlarge" + } + }, + "m7a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.24xlarge" + } + }, + "m7a_32xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.32xlarge" + } + }, + "m7a_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.48xlarge" + } + }, + "m7a_metal_48xl": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "m7a.metal-48xl" + } + }, + "hpc7a_12xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hpc7a.12xlarge" + } + }, + "hpc7a_24xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hpc7a.24xlarge" + } + }, + "hpc7a_48xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hpc7a.48xlarge" + } + }, + "hpc7a_96xlarge": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "hpc7a.96xlarge" + } } } }, diff --git a/codegen/sdk/aws-models/efs.json b/codegen/sdk/aws-models/efs.json index 654fb69a0db..4b84dddbc18 100644 --- a/codegen/sdk/aws-models/efs.json +++ b/codegen/sdk/aws-models/efs.json @@ -2702,6 +2702,7 @@ "arnNamespace": "elasticfilesystem", "cloudFormationName": "EFS", "cloudTrailEventSource": "efs.amazonaws.com", + "docId": "elasticfilesystem-2015-02-01", "endpointPrefix": "elasticfilesystem" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/elastic-beanstalk.json b/codegen/sdk/aws-models/elastic-beanstalk.json index 088e8ae3a15..b742fd91e62 100644 --- a/codegen/sdk/aws-models/elastic-beanstalk.json +++ b/codegen/sdk/aws-models/elastic-beanstalk.json @@ -184,6 +184,7 @@ "arnNamespace": "elasticbeanstalk", "cloudFormationName": "ElasticBeanstalk", "cloudTrailEventSource": "elasticbeanstalk.amazonaws.com", + "docId": "elasticbeanstalk-2010-12-01", "endpointPrefix": "elasticbeanstalk" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/elastic-load-balancing-v2.json b/codegen/sdk/aws-models/elastic-load-balancing-v2.json index da76f548dfe..8e54bd2d3e2 100644 --- a/codegen/sdk/aws-models/elastic-load-balancing-v2.json +++ b/codegen/sdk/aws-models/elastic-load-balancing-v2.json @@ -3087,6 +3087,7 @@ "arnNamespace": "elasticloadbalancing", "cloudFormationName": "ElasticLoadBalancingV2", "cloudTrailEventSource": "elasticloadbalancingv2.amazonaws.com", + "docId": "elasticloadbalancingv2-2015-12-01", "endpointPrefix": "elasticloadbalancing" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/elastic-load-balancing.json b/codegen/sdk/aws-models/elastic-load-balancing.json index 09444b61431..3e50cb0c8eb 100644 --- a/codegen/sdk/aws-models/elastic-load-balancing.json +++ b/codegen/sdk/aws-models/elastic-load-balancing.json @@ -2362,6 +2362,7 @@ "arnNamespace": "elasticloadbalancing", "cloudFormationName": "ElasticLoadBalancing", "cloudTrailEventSource": "elasticloadbalancing.amazonaws.com", + "docId": "elasticloadbalancing-2012-06-01", "endpointPrefix": "elasticloadbalancing" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/elastic-transcoder.json b/codegen/sdk/aws-models/elastic-transcoder.json index 36fe1c427ab..56fb6c74c61 100644 --- a/codegen/sdk/aws-models/elastic-transcoder.json +++ b/codegen/sdk/aws-models/elastic-transcoder.json @@ -1264,6 +1264,7 @@ "arnNamespace": "elastictranscoder", "cloudFormationName": "ElasticTranscoder", "cloudTrailEventSource": "elastictranscoder.amazonaws.com", + "docId": "elastictranscoder-2012-09-25", "endpointPrefix": "elastictranscoder" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/elasticsearch-service.json b/codegen/sdk/aws-models/elasticsearch-service.json index fc91574d7cb..055e35ee74f 100644 --- a/codegen/sdk/aws-models/elasticsearch-service.json +++ b/codegen/sdk/aws-models/elasticsearch-service.json @@ -512,6 +512,7 @@ "arnNamespace": "es", "cloudFormationName": "Elasticsearch", "cloudTrailEventSource": "elasticsearchservice.amazonaws.com", + "docId": "es-2015-01-01", "endpointPrefix": "es" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/emr.json b/codegen/sdk/aws-models/emr.json index e1ce947638e..942be6f9d05 100644 --- a/codegen/sdk/aws-models/emr.json +++ b/codegen/sdk/aws-models/emr.json @@ -2744,6 +2744,7 @@ "arnNamespace": "elasticmapreduce", "cloudFormationName": "EMR", "cloudTrailEventSource": "emr.amazonaws.com", + "docId": "elasticmapreduce-2009-03-31", "endpointPrefix": "elasticmapreduce" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/finspace-data.json b/codegen/sdk/aws-models/finspace-data.json index 7dce4ca3c8f..7a05fb6f548 100644 --- a/codegen/sdk/aws-models/finspace-data.json +++ b/codegen/sdk/aws-models/finspace-data.json @@ -133,6 +133,7 @@ "arnNamespace": "finspace-api", "cloudFormationName": "Finspacedata", "cloudTrailEventSource": "finspacedata.amazonaws.com", + "docId": "finspace-2020-07-13", "endpointPrefix": "finspace-api" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/fsx.json b/codegen/sdk/aws-models/fsx.json index f22591de037..1c512d484e5 100644 --- a/codegen/sdk/aws-models/fsx.json +++ b/codegen/sdk/aws-models/fsx.json @@ -2395,7 +2395,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon FSx for Lustre data repository association (DRA). A data\n repository association is a link between a directory on the file system and\n an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository\n associations on a file system. Data repository associations are supported\n on all FSx for Lustre 2.12 and newer file systems, excluding\n scratch_1 deployment type.
Each data repository association must have a unique Amazon FSx file\n system directory and a unique S3 bucket or prefix associated with it. You\n can configure a data repository association for automatic import only,\n for automatic export only, or for both. To learn more about linking a\n data repository to your file system, see \n Linking your file system to an S3 bucket.
\n\n CreateDataRepositoryAssociation isn't supported\n on Amazon File Cache resources. To create a DRA on Amazon File Cache,\n use the CreateFileCache operation.
Creates an Amazon FSx for Lustre data repository association (DRA). A data\n repository association is a link between a directory on the file system and\n an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository\n associations on a file system. Data repository associations are supported\n on all FSx for Lustre 2.12 and 2.15 file systems, excluding\n scratch_1 deployment type.
Each data repository association must have a unique Amazon FSx file\n system directory and a unique S3 bucket or prefix associated with it. You\n can configure a data repository association for automatic import only,\n for automatic export only, or for both. To learn more about linking a\n data repository to your file system, see \n Linking your file system to an S3 bucket.
\n\n CreateDataRepositoryAssociation isn't supported\n on Amazon File Cache resources. To create a DRA on Amazon File Cache,\n use the CreateFileCache operation.
Creates an Amazon FSx for Lustre data repository task.\n A CreateDataRepositoryTask operation will fail if a data\n repository is not linked to the FSx file system.
You use import and export data repository tasks to perform bulk operations between your\n FSx for Lustre file system and its linked data repositories. An example of a data repository\n task is exporting any data and metadata changes, including POSIX metadata, to files, directories,\n and symbolic links (symlinks) from your FSx file system to a linked data repository.
\nYou use release data repository tasks to release data from your file system for files that\n are archived to S3. The metadata of released files remains on the file system so users or applications\n can still access released files by reading the files again, which will restore data from\n Amazon S3 to the FSx for Lustre file system.
\nTo learn more about data repository tasks, see \n Data Repository Tasks. \n To learn more about linking a data repository to your file system, see \n Linking your file system to an S3 bucket.
", + "smithy.api#documentation": "Creates an Amazon FSx for Lustre data repository task.\n A CreateDataRepositoryTask operation will fail if a data\n repository is not linked to the FSx file system.
You use import and export data repository tasks to perform bulk operations between your\n FSx for Lustre file system and its linked data repositories. An example of a data repository\n task is exporting any data and metadata changes, including POSIX metadata, to files, directories,\n and symbolic links (symlinks) from your FSx file system to a linked data repository.
\nYou use release data repository tasks to release data from your file system for files that\n are exported to S3. The metadata of released files remains on the file system so users or applications\n can still access released files by reading the files again, which will restore data from\n Amazon S3 to the FSx for Lustre file system.
\nTo learn more about data repository tasks, see \n Data Repository Tasks. \n To learn more about linking a data repository to your file system, see \n Linking your file system to an S3 bucket.
", "smithy.api#idempotent": {} } }, @@ -2509,14 +2509,14 @@ "Type": { "target": "com.amazonaws.fsx#DataRepositoryTaskType", "traits": { - "smithy.api#documentation": "Specifies the type of data repository task to create.
\n\n EXPORT_TO_REPOSITORY tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.
\n IMPORT_METADATA_FROM_REPOSITORY tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
\n RELEASE_DATA_FROM_FILESYSTEM tasks release files in\n your Amazon FSx for Lustre file system that are archived and that meet\n your specified release criteria.
\n AUTO_RELEASE_DATA tasks automatically release files from\n an Amazon File Cache resource.
Specifies the type of data repository task to create.
\n\n EXPORT_TO_REPOSITORY tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.
\n IMPORT_METADATA_FROM_REPOSITORY tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
\n RELEASE_DATA_FROM_FILESYSTEM tasks release files in\n your Amazon FSx for Lustre file system that have been exported to a linked\n S3 bucket and that meet your specified release criteria.
\n AUTO_RELEASE_DATA tasks automatically release files from\n an Amazon File Cache resource.
A list of paths for the data repository task to use when the task is processed.\n If a path that you provide isn't valid, the task fails. If you don't provide\n paths, the default behavior is to export all files to S3 (for export tasks), import\n all files from S3 (for import tasks), or release all archived files that meet the\n last accessed time criteria (for release tasks).
\nFor export tasks, the list contains paths on the FSx for Lustre file system\n from which the files are exported to the Amazon S3 bucket. The default path is the\n file system root directory. The paths you provide need to be relative to the mount\n point of the file system. If the mount point is /mnt/fsx and\n /mnt/fsx/path1 is a directory or file on the file system you want\n to export, then the path to provide is path1.
For import tasks, the list contains paths in the Amazon S3 bucket\n from which POSIX metadata changes are imported to the FSx for Lustre file system.\n The path can be an S3 bucket or prefix in the format\n s3://myBucket/myPrefix (where myPrefix is optional).\n
For release tasks, the list contains directory or file paths on the\n FSx for Lustre file system from which to release archived files. If a directory is\n specified, files within the directory are released. If a file path is specified,\n only that file is released. To release all archived files in the file system,\n specify a forward slash (/) as the path.
\nA file must also meet the last accessed time criteria\n specified in for the\n file to be released.
\nA list of paths for the data repository task to use when the task is processed.\n If a path that you provide isn't valid, the task fails. If you don't provide\n paths, the default behavior is to export all files to S3 (for export tasks), import\n all files from S3 (for import tasks), or release all exported files that meet the\n last accessed time criteria (for release tasks).
\nFor export tasks, the list contains paths on the FSx for Lustre file system\n from which the files are exported to the Amazon S3 bucket. The default path is the\n file system root directory. The paths you provide need to be relative to the mount\n point of the file system. If the mount point is /mnt/fsx and\n /mnt/fsx/path1 is a directory or file on the file system you want\n to export, then the path to provide is path1.
For import tasks, the list contains paths in the Amazon S3 bucket\n from which POSIX metadata changes are imported to the FSx for Lustre file system.\n The path can be an S3 bucket or prefix in the format\n s3://myBucket/myPrefix (where myPrefix is optional).\n
For release tasks, the list contains directory or file paths on the\n FSx for Lustre file system from which to release exported files. If a directory is\n specified, files within the directory are released. If a file path is specified,\n only that file is released. To release all exported files in the file system,\n specify a forward slash (/) as the path.
\nA file must also meet the last accessed time criteria\n specified in for the\n file to be released.
\nSets the version for the Amazon FSx for Lustre file system that you're\n creating from a backup. Valid values are 2.10 and 2.12.
You don't need to specify FileSystemTypeVersion because it will\n be applied using the backup's FileSystemTypeVersion setting.\n If you choose to specify FileSystemTypeVersion when creating from backup, the\n value must match the backup's FileSystemTypeVersion setting.
Sets the version for the Amazon FSx for Lustre file system that you're\n creating from a backup. Valid values are 2.10, 2.12,\n and 2.15.
You don't need to specify FileSystemTypeVersion because it will\n be applied using the backup's FileSystemTypeVersion setting.\n If you choose to specify FileSystemTypeVersion when creating from backup, the\n value must match the backup's FileSystemTypeVersion setting.
(Multi-AZ only) Specifies the virtual private cloud (VPC) route tables in which your\n file system's endpoints will be created. You should specify all VPC route tables\n associated with the subnets in which your clients are located. By default, Amazon FSx\n selects your VPC's default route table.
" + "smithy.api#documentation": "(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules\n for routing traffic to the correct file server. You should specify all virtual private cloud\n (VPC) route tables associated with the subnets in which your clients are located. By default,\n Amazon FSx selects your VPC's default route table.
" } }, "ThroughputCapacity": { @@ -3092,14 +3092,14 @@ "DeploymentType": { "target": "com.amazonaws.fsx#OpenZFSDeploymentType", "traits": { - "smithy.api#documentation": "Specifies the file system deployment type. Single AZ deployment types are configured\n for redundancy within a single Availability Zone in an Amazon Web Services Region .\n Valid values are the following:
\n\n MULTI_AZ_1- Creates file systems with high availability that are configured for Multi-AZ redundancy to tolerate temporary unavailability in Availability Zones (AZs).\n Multi_AZ_1 is available in the following Amazon Web Services Regions:
\n SINGLE_AZ_1- (Default) Creates file systems with throughput capacities of 64 - 4,096 MB/s.\n Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx \n for OpenZFS is available.
\n SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s\n using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia), US East (Ohio), \n US West (Oregon), and Europe (Ireland) Amazon Web Services Regions.
For more information, see: Deployment type availability\n and File system performance\n in the Amazon FSx for OpenZFS User Guide.
", + "smithy.api#documentation": "Specifies the file system deployment type. Single AZ deployment types are configured\n for redundancy within a single Availability Zone in an Amazon Web Services Region .\n Valid values are the following:
\n\n MULTI_AZ_1- Creates file systems with high availability that are configured\n for Multi-AZ redundancy to tolerate temporary unavailability in Availability Zones (AZs).\n Multi_AZ_1 is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon),\n Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland) Amazon Web Services Regions.
\n SINGLE_AZ_1- Creates file systems with throughput capacities of 64 - 4,096 MB/s.\n Single_AZ_1 is available in all Amazon Web Services Regions where Amazon FSx \n for OpenZFS is available.
\n SINGLE_AZ_2- Creates file systems with throughput capacities of 160 - 10,240 MB/s\n using an NVMe L2ARC cache. Single_AZ_2 is available only in the US East (N. Virginia),\n US East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland)\n Amazon Web Services Regions.
For more information, see Deployment type availability\n and File system performance\n in the Amazon FSx for OpenZFS User Guide.
", "smithy.api#required": {} } }, "ThroughputCapacity": { "target": "com.amazonaws.fsx#MegabytesPerSecond", "traits": { - "smithy.api#documentation": "Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows:
\nFor SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.
For SINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.
You pay for additional throughput capacity that you provision.
", + "smithy.api#documentation": "Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows:
\nFor MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640,\n 1280, 2560, 3840, 5120, 7680, or 10240 MBps.
For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.
You pay for additional throughput capacity that you provision.
", "smithy.api#required": {} } }, @@ -3130,7 +3130,7 @@ "RouteTableIds": { "target": "com.amazonaws.fsx#RouteTableIds", "traits": { - "smithy.api#documentation": "(Multi-AZ only) Specifies the virtual private cloud (VPC) route tables in which your\n file system's endpoints will be created. You should specify all VPC route tables\n associated with the subnets in which your clients are located. By default, Amazon FSx\n selects your VPC's default route table.
" + "smithy.api#documentation": "(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules\n for routing traffic to the correct file server. You should specify all virtual private cloud\n (VPC) route tables associated with the subnets in which your clients are located. By default,\n Amazon FSx selects your VPC's default route table.
" } } }, @@ -3205,7 +3205,7 @@ "FileSystemTypeVersion": { "target": "com.amazonaws.fsx#FileSystemTypeVersion", "traits": { - "smithy.api#documentation": "(Optional) For FSx for Lustre file systems, sets the Lustre version for the\n file system that you're creating. Valid values are 2.10 and\n 2.12:
2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
\n2.12 is supported by all Lustre deployment types. 2.12 is \n required when setting FSx for Lustre DeploymentType to \n PERSISTENT_2.
Default value = 2.10, except when DeploymentType is set to \n PERSISTENT_2, then the default is 2.12.
If you set FileSystemTypeVersion to 2.10 for a \n PERSISTENT_2 Lustre deployment type, the CreateFileSystem \n operation fails.
(Optional) For FSx for Lustre file systems, sets the Lustre version\n for the file system that you're creating. Valid values are 2.10, \n 2.12m and 2.15:
2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.
\n2.12 and 2.15 are supported by all Lustre deployment types. 2.12\n or 2.15 is required when setting FSx for Lustre DeploymentType\n to PERSISTENT_2.
Default value = 2.10, except when DeploymentType is set to \n PERSISTENT_2, then the default is 2.12.
If you set FileSystemTypeVersion to 2.10 for a \n PERSISTENT_2 Lustre deployment type, the CreateFileSystem \n operation fails.
The configuration of a data repository association that links\n an Amazon FSx for Lustre file system to an Amazon S3 bucket\n or an Amazon File Cache resource to an Amazon S3 bucket or an NFS file system.\n The data repository association configuration object is returned\n in the response of the following operations:
\n\n CreateDataRepositoryAssociation\n
\n UpdateDataRepositoryAssociation\n
\n DescribeDataRepositoryAssociations\n
Data repository associations are supported on Amazon File Cache resources and\n all FSx for Lustre 2.12 and newer file systems, excluding\n scratch_1 deployment type.
The configuration of a data repository association that links\n an Amazon FSx for Lustre file system to an Amazon S3 bucket\n or an Amazon File Cache resource to an Amazon S3 bucket or an NFS file system.\n The data repository association configuration object is returned\n in the response of the following operations:
\n\n CreateDataRepositoryAssociation\n
\n UpdateDataRepositoryAssociation\n
\n DescribeDataRepositoryAssociations\n
Data repository associations are supported on Amazon File Cache resources and\n all FSx for Lustre 2.12 and 2.15 file systems, excluding\n scratch_1 deployment type.
The type of data repository task.
\n\n EXPORT_TO_REPOSITORY tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.
\n IMPORT_METADATA_FROM_REPOSITORY tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
\n RELEASE_DATA_FROM_FILESYSTEM tasks release files in\n your Amazon FSx for Lustre file system that are archived and that meet\n your specified release criteria.
\n AUTO_RELEASE_DATA tasks automatically release files from\n an Amazon File Cache resource.
The type of data repository task.
\n\n EXPORT_TO_REPOSITORY tasks export from your\n Amazon FSx for Lustre file system to a linked data repository.
\n IMPORT_METADATA_FROM_REPOSITORY tasks import metadata\n changes from a linked S3 bucket to your Amazon FSx for Lustre file system.
\n RELEASE_DATA_FROM_FILESYSTEM tasks release files in\n your Amazon FSx for Lustre file system that have been exported to a\n linked S3 bucket and that meet your specified release criteria.
\n AUTO_RELEASE_DATA tasks automatically release files from\n an Amazon File Cache resource.
A description of the data repository task.
\nYou use import and export data repository tasks to perform\n bulk transfer operations between an Amazon FSx for Lustre file system\n and a linked data repository.
\nYou use release data repository tasks to release archived files\n from your Amazon FSx for Lustre file system.
\nAn Amazon File Cache resource uses a task to automatically\n release files from the cache.
\nTo learn more about data repository tasks, see \n Data Repository Tasks. \n
" + "smithy.api#documentation": "A description of the data repository task.
\nYou use import and export data repository tasks to perform\n bulk transfer operations between an Amazon FSx for Lustre file system\n and a linked data repository.
\nYou use release data repository tasks to release have been exported\n to a linked S3 bucketed files from your Amazon FSx for Lustre file system.
\nAn Amazon File Cache resource uses a task to automatically\n release files from the cache.
\nTo learn more about data repository tasks, see \n Data Repository Tasks. \n
" } }, "com.amazonaws.fsx#DataRepositoryTaskEnded": { @@ -4650,7 +4650,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a data repository association on an Amazon FSx for Lustre\n file system. Deleting the data repository association unlinks the\n file system from the Amazon S3 bucket. When deleting a data repository\n association, you have the option of deleting the data in the file system\n that corresponds to the data repository association. Data repository\n associations are supported on all FSx for Lustre 2.12 and newer file\n systems, excluding scratch_1 deployment type.
Deletes a data repository association on an Amazon FSx for Lustre\n file system. Deleting the data repository association unlinks the\n file system from the Amazon S3 bucket. When deleting a data repository\n association, you have the option of deleting the data in the file system\n that corresponds to the data repository association. Data repository\n associations are supported on all FSx for Lustre 2.12 and 2.15 file\n systems, excluding scratch_1 deployment type.
Deletes a file system. After deletion, the file system no longer exists, and its data\n is gone. Any existing automatic backups and snapshots are also deleted.
\nTo delete an Amazon FSx for NetApp ONTAP file system, first delete all the\n volumes and storage virtual machines (SVMs) on the file system. Then provide a\n FileSystemId value to the DeleFileSystem operation.
By default, when you delete an Amazon FSx for Windows File Server file system,\n a final backup is created upon deletion. This final backup isn't subject to the file\n system's retention policy, and must be manually deleted.
\nThe DeleteFileSystem operation returns while the file system has the\n DELETING status. You can check the file system deletion status by\n calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass the file system ID for a deleted file system, the\n DescribeFileSystems operation returns a FileSystemNotFound\n error.
If a data repository task is in a PENDING or EXECUTING state,\n deleting an Amazon FSx for Lustre file system will fail with an HTTP status\n code 400 (Bad Request).
The data in a deleted file system is also deleted and can't be recovered by\n any means.
\nDeletes a file system. After deletion, the file system no longer exists, and its data\n is gone. Any existing automatic backups and snapshots are also deleted.
\nTo delete an Amazon FSx for NetApp ONTAP file system, first delete all the\n volumes and storage virtual machines (SVMs) on the file system. Then provide a\n FileSystemId value to the DeleFileSystem operation.
By default, when you delete an Amazon FSx for Windows File Server file system,\n a final backup is created upon deletion. This final backup isn't subject to the file\n system's retention policy, and must be manually deleted.
\nTo delete an Amazon FSx for Lustre file system, first \n unmount\n it from every connected Amazon EC2 instance, then provide a FileSystemId\n value to the DeleFileSystem operation. By default, Amazon FSx will not\n take a final backup when the DeleteFileSystem operation is invoked. On file systems\n not linked to an Amazon S3 bucket, set SkipFinalBackup to false\n to take a final backup of the file system you are deleting. Backups cannot be enabled on S3-linked\n file systems. To ensure all of your data is written back to S3 before deleting your file system,\n you can either monitor for the\n AgeOfOldestQueuedMessage\n metric to be zero (if using automatic export) or you can run an\n export data repository task.\n If you have automatic export enabled and want to use an export data repository task, you have\n to disable automatic export before executing the export data repository task.
The DeleteFileSystem operation returns while the file system has the\n DELETING status. You can check the file system deletion status by\n calling the DescribeFileSystems operation, which returns a list of file systems in your\n account. If you pass the file system ID for a deleted file system, the\n DescribeFileSystems operation returns a FileSystemNotFound\n error.
If a data repository task is in a PENDING or EXECUTING state,\n deleting an Amazon FSx for Lustre file system will fail with an HTTP status\n code 400 (Bad Request).
The data in a deleted file system is also deleted and can't be recovered by\n any means.
\nReturns the description of specific Amazon FSx for Lustre or Amazon File Cache\n data repository associations, if one or more AssociationIds values\n are provided in the request, or if filters are used in the request. Data repository\n associations are supported on Amazon File Cache resources and all FSx for Lustre\n 2.12 and newer file systems, excluding scratch_1 deployment type.
You can use filters to narrow the response to include just data repository\n associations for specific file systems (use the file-system-id filter with\n the ID of the file system) or caches (use the file-cache-id filter with\n the ID of the cache), or data repository associations for a specific repository type\n (use the data-repository-type filter with a value of S3\n or NFS). If you don't use filters, the response returns all data\n repository associations owned by your Amazon Web Services account in the Amazon Web Services Region\n of the endpoint that you're calling.
When retrieving all data repository associations, you can paginate the response by using\n the optional MaxResults parameter to limit the number of data repository associations\n returned in a response. If more data repository associations remain, a\n NextToken value is returned in the response. In this case, send a later\n request with the NextToken request parameter set to the value of\n NextToken from the last response.
Returns the description of specific Amazon FSx for Lustre or Amazon File Cache\n data repository associations, if one or more AssociationIds values\n are provided in the request, or if filters are used in the request. Data repository\n associations are supported on Amazon File Cache resources and all FSx for Lustre\n 2.12 and 2,15 file systems, excluding scratch_1 deployment type.
You can use filters to narrow the response to include just data repository\n associations for specific file systems (use the file-system-id filter with\n the ID of the file system) or caches (use the file-cache-id filter with\n the ID of the cache), or data repository associations for a specific repository type\n (use the data-repository-type filter with a value of S3\n or NFS). If you don't use filters, the response returns all data\n repository associations owned by your Amazon Web Services account in the Amazon Web Services Region\n of the endpoint that you're calling.
When retrieving all data repository associations, you can paginate the response by using\n the optional MaxResults parameter to limit the number of data repository associations\n returned in a response. If more data repository associations remain, a\n NextToken value is returned in the response. In this case, send a later\n request with the NextToken request parameter set to the value of\n NextToken from the last response.
An integer that represents the minimum amount of time (in days)\n since a file was last accessed in the file system. Only archived files\n with a MAX(atime, ctime, mtime) timestamp that is more than\n this amount of time in the past (relative to the task create time)\n will be released. The default of Value is 0.\n This is a required parameter.
If an archived file meets the last accessed time criteria,\n its file or directory path must also be specified in the Paths\n parameter of the operation\n in order for the file to be released.
An integer that represents the minimum amount of time (in days)\n since a file was last accessed in the file system. Only exported files\n with a MAX(atime, ctime, mtime) timestamp that is more than\n this amount of time in the past (relative to the task create time)\n will be released. The default of Value is 0.\n This is a required parameter.
If an exported file meets the last accessed time criteria,\n its file or directory path must also be specified in the Paths\n parameter of the operation\n in order for the file to be released.
Defines the minimum amount of time since last access for a \n file to be eligible for release. Only archived files that were\n last accessed or modified before this point-in-time are eligible\n to be released from the Amazon FSx for Lustre file system.
" + "smithy.api#documentation": "Defines the minimum amount of time since last access for a \n file to be eligible for release. Only files that have been\n exported to S3 and that were last accessed or modified before\n this point-in-time are eligible to be released from the\n Amazon FSx for Lustre file system.
" } }, "com.amazonaws.fsx#EndTime": { @@ -6764,7 +6764,7 @@ "FileSystemTypeVersion": { "target": "com.amazonaws.fsx#FileSystemTypeVersion", "traits": { - "smithy.api#documentation": "The Lustre version of the Amazon FSx for Lustre file system, either\n 2.10 or 2.12.
The Lustre version of the Amazon FSx for Lustre file system, which\n is 2.10, 2.12, or 2.15.
The deployment type of the FSx for Lustre file system. \n Scratch deployment type is designed for temporary storage\n and shorter-term processing of data.
\n\n SCRATCH_1 and SCRATCH_2 deployment types are best suited \n for when you need temporary storage and shorter-term processing of data. The \n SCRATCH_2 deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1.
The PERSISTENT_1 and PERSISTENT_2 deployment type is used\n for longer-term storage and workloads and encryption of data in transit.\n PERSISTENT_2 is built on Lustre v2.12 and offers higher\n PerUnitStorageThroughput (up to 1000 MB/s/TiB) along with a lower\n minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see \n FSx for Lustre deployment options.
The default is SCRATCH_1.
The deployment type of the FSx for Lustre file system. \n Scratch deployment type is designed for temporary storage\n and shorter-term processing of data.
\n\n SCRATCH_1 and SCRATCH_2 deployment types are best suited \n for when you need temporary storage and shorter-term processing of data. The \n SCRATCH_2 deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1.
The PERSISTENT_1 and PERSISTENT_2 deployment type is used\n for longer-term storage and workloads and encryption of data in transit.\n PERSISTENT_2 offers higher PerUnitStorageThroughput\n (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB).\n To learn more about FSx for Lustre deployment types, see \n FSx for Lustre deployment options.
The default is SCRATCH_1.
Defines the point-in-time since an archived file was last accessed,\n in order for that file to be eligible for release. Only files that were\n last accessed before this point-in-time are eligible to be released from\n the file system.
" + "smithy.api#documentation": "Defines the point-in-time since an exported file was last accessed,\n in order for that file to be eligible for release. Only files that were\n last accessed before this point-in-time are eligible to be released from\n the file system.
" } } }, "traits": { - "smithy.api#documentation": "The configuration that specifies a minimum amount of time since\n last access for an archived file to be eligible for release from an\n Amazon FSx for Lustre file system. Only files that were last\n accessed before this point-in-time can be released. For example, if\n you specify a last accessed time criteria of 9 days, only files that\n were last accessed 9.00001 or more days ago can be released.
\nOnly file data that has been archived can be released. Files that\n have not yet been archived, such as new or changed files that have\n not been exported, are not eligible for release. When files are\n released, their metadata stays on the file system, so they\n can still be accessed later. Users and applications can access a\n released file by reading the file again, which restores data from\n Amazon S3 to the FSx for Lustre file system.
\nIf a file meets the last accessed time criteria, its\n file or directory path must also be specified with the\n Paths parameter of the\n operation in order\n for the file to be released.
The configuration that specifies a minimum amount of time since\n last access for an exported file to be eligible for release from an\n Amazon FSx for Lustre file system. Only files that were last\n accessed before this point-in-time can be released. For example, if\n you specify a last accessed time criteria of 9 days, only files that\n were last accessed 9.00001 or more days ago can be released.
\nOnly file data that has been exported to S3 can be released. Files\n that have not yet been exported to S3, such as new or changed files\n that have not been exported, are not eligible for release. When files\n are released, their metadata stays on the file system, so they\n can still be accessed later. Users and applications can access a\n released file by reading the file again, which restores data from\n Amazon S3 to the FSx for Lustre file system.
\nIf a file meets the last accessed time criteria, its\n file or directory path must also be specified with the\n Paths parameter of the\n operation in order\n for the file to be released.
Updates the configuration of an existing data repository association\n on an Amazon FSx for Lustre file system. Data repository associations\n are supported on all FSx for Lustre 2.12 and newer file systems,\n excluding scratch_1 deployment type.
Updates the configuration of an existing data repository association\n on an Amazon FSx for Lustre file system. Data repository associations\n are supported on all FSx for Lustre 2.12 and 2.15 file systems,\n excluding scratch_1 deployment type.
Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.
\nFor FSx for Windows File Server file systems, you can update the following\n properties:
\n\n AuditLogConfiguration\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n SelfManagedActiveDirectoryConfiguration\n
\n StorageCapacity\n
\n StorageType\n
\n ThroughputCapacity\n
\n DiskIopsConfiguration\n
\n WeeklyMaintenanceStartTime\n
For FSx for Lustre file systems, you can update the following\n properties:
\n\n AutoImportPolicy\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DataCompressionType\n
\n LogConfiguration\n
\n LustreRootSquashConfiguration\n
\n StorageCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for ONTAP file systems, you can update the following\n properties:
\n\n AddRouteTableIds\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n FsxAdminPassword\n
\n RemoveRouteTableIds\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for OpenZFS file systems, you can update the following\n properties:
\n\n AutomaticBackupRetentionDays\n
\n CopyTagsToBackups\n
\n CopyTagsToVolumes\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
Use this operation to update the configuration of an existing Amazon FSx file\n system. You can update multiple properties in a single request.
\nFor FSx for Windows File Server file systems, you can update the following\n properties:
\n\n AuditLogConfiguration\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n SelfManagedActiveDirectoryConfiguration\n
\n StorageCapacity\n
\n StorageType\n
\n ThroughputCapacity\n
\n DiskIopsConfiguration\n
\n WeeklyMaintenanceStartTime\n
For FSx for Lustre file systems, you can update the following\n properties:
\n\n AutoImportPolicy\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DataCompressionType\n
\n LogConfiguration\n
\n LustreRootSquashConfiguration\n
\n StorageCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for ONTAP file systems, you can update the following\n properties:
\n\n AddRouteTableIds\n
\n AutomaticBackupRetentionDays\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n FsxAdminPassword\n
\n RemoveRouteTableIds\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
For FSx for OpenZFS file systems, you can update the following\n properties:
\n\n AddRouteTableIds\n
\n AutomaticBackupRetentionDays\n
\n CopyTagsToBackups\n
\n CopyTagsToVolumes\n
\n DailyAutomaticBackupStartTime\n
\n DiskIopsConfiguration\n
\n RemoveRouteTableIds\n
\n StorageCapacity\n
\n ThroughputCapacity\n
\n WeeklyMaintenanceStartTime\n
The throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second\u2028 (MB/s). Valid values depend on the DeploymentType you choose, as follows:
\nFor SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.
For SINGLE_AZ_2, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s.
The throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second\u2028 (MB/s). Valid values depend on the DeploymentType you choose, as follows:
\nFor MULTI_AZ_1 and SINGLE_AZ_2, valid values are 160, 320, 640,\n 1280, 2560, 3840, 5120, 7680, or 10240 MBps.
For SINGLE_AZ_1, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.
The Glue version determines the versions of Apache Spark and Python that Glue supports. \n The GlueVersion must be greater than 2.0.
" } + }, + "NumberOfWorkers": { + "target": "com.amazonaws.glue#NullableInteger", + "traits": { + "smithy.api#documentation": "The number of workers of a defined WorkerType to use for the session.
The type of predefined worker that is allocated when a session runs. Accepts a value of G.1X, G.2X, G.4X, or G.8X for Spark sessions. Accepts the value Z.2X for Ray sessions.
The date and time that this session is completed.
" + } + }, + "ExecutionTime": { + "target": "com.amazonaws.glue#NullableDouble", + "traits": { + "smithy.api#documentation": "The total time the session ran for.
" + } + }, + "DPUSeconds": { + "target": "com.amazonaws.glue#NullableDouble", + "traits": { + "smithy.api#documentation": "The DPUs consumed by the session (formula: ExecutionTime * MaxCapacity).
" + } + }, + "IdleTimeout": { + "target": "com.amazonaws.glue#IdleTimeout", + "traits": { + "smithy.api#documentation": "The number of minutes when idle before the session times out.
" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/iot-1click-devices-service.json b/codegen/sdk/aws-models/iot-1click-devices-service.json index aa8f3f6f2a0..598653219e8 100644 --- a/codegen/sdk/aws-models/iot-1click-devices-service.json +++ b/codegen/sdk/aws-models/iot-1click-devices-service.json @@ -682,6 +682,7 @@ "arnNamespace": "iot1click", "cloudFormationName": "IoT1ClickDevicesService", "cloudTrailEventSource": "iot1clickdevicesservice.amazonaws.com", + "docId": "devices-2018-05-14", "endpointPrefix": "devices.iot1click" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/iot-1click-projects.json b/codegen/sdk/aws-models/iot-1click-projects.json index 5a773dc8784..941ea127e32 100644 --- a/codegen/sdk/aws-models/iot-1click-projects.json +++ b/codegen/sdk/aws-models/iot-1click-projects.json @@ -88,6 +88,7 @@ "arnNamespace": "iot1click", "cloudFormationName": "IoT1Click", "cloudTrailEventSource": "iot1clickprojects.amazonaws.com", + "docId": "iot1click-projects-2018-05-14", "endpointPrefix": "projects.iot1click" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/iot-data-plane.json b/codegen/sdk/aws-models/iot-data-plane.json index 31e823f2348..1a0d5601267 100644 --- a/codegen/sdk/aws-models/iot-data-plane.json +++ b/codegen/sdk/aws-models/iot-data-plane.json @@ -380,6 +380,7 @@ "arnNamespace": "iotdata", "cloudFormationName": "IoTDataPlane", "cloudTrailEventSource": "iotdataplane.amazonaws.com", + "docId": "iot-data-2015-05-28", "endpointPrefix": "data-ats.iot" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/iot-events-data.json b/codegen/sdk/aws-models/iot-events-data.json index dd6859837ea..4506d51c59f 100644 --- a/codegen/sdk/aws-models/iot-events-data.json +++ b/codegen/sdk/aws-models/iot-events-data.json @@ -1642,6 +1642,7 @@ "arnNamespace": "ioteventsdata", "cloudFormationName": "IoTEventsData", "cloudTrailEventSource": "ioteventsdata.amazonaws.com", + "docId": "iotevents-data-2018-10-23", "endpointPrefix": "data.iotevents" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/iot-events.json b/codegen/sdk/aws-models/iot-events.json index a7fdc410375..062e345b480 100644 --- a/codegen/sdk/aws-models/iot-events.json +++ b/codegen/sdk/aws-models/iot-events.json @@ -2705,6 +2705,7 @@ "arnNamespace": "iotevents", "cloudFormationName": "IoTEvents", "cloudTrailEventSource": "iotevents.amazonaws.com", + "docId": "iotevents-2018-07-27", "endpointPrefix": "iotevents" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/iot-jobs-data-plane.json b/codegen/sdk/aws-models/iot-jobs-data-plane.json index 06df32a9889..497a337f008 100644 --- a/codegen/sdk/aws-models/iot-jobs-data-plane.json +++ b/codegen/sdk/aws-models/iot-jobs-data-plane.json @@ -309,6 +309,7 @@ "arnNamespace": "iot-jobs-data", "cloudFormationName": "IoTJobsDataPlane", "cloudTrailEventSource": "iotjobsdataplane.amazonaws.com", + "docId": "iot-jobs-data-2017-09-29", "endpointPrefix": "data.jobs.iot" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/iot-wireless.json b/codegen/sdk/aws-models/iot-wireless.json index e5c6ed6c9fa..26831b943ae 100644 --- a/codegen/sdk/aws-models/iot-wireless.json +++ b/codegen/sdk/aws-models/iot-wireless.json @@ -15408,6 +15408,7 @@ "arnNamespace": "iotwireless", "cloudFormationName": "IoTWireless", "cloudTrailEventSource": "iotwireless.amazonaws.com", + "docId": "iotwireless-2020-11-22", "endpointPrefix": "api.iotwireless" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/kinesis-analytics-v2.json b/codegen/sdk/aws-models/kinesis-analytics-v2.json index 078ec48714b..e8c3a11dcd0 100644 --- a/codegen/sdk/aws-models/kinesis-analytics-v2.json +++ b/codegen/sdk/aws-models/kinesis-analytics-v2.json @@ -3685,6 +3685,7 @@ "arnNamespace": "kinesisanalytics", "cloudFormationName": "KinesisAnalyticsV2", "cloudTrailEventSource": "kinesisanalyticsv2.amazonaws.com", + "docId": "kinesisanalyticsv2-2018-05-23", "endpointPrefix": "kinesisanalytics" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/kinesis-analytics.json b/codegen/sdk/aws-models/kinesis-analytics.json index b639eb07a1f..f72ca07d2de 100644 --- a/codegen/sdk/aws-models/kinesis-analytics.json +++ b/codegen/sdk/aws-models/kinesis-analytics.json @@ -1932,6 +1932,7 @@ "arnNamespace": "kinesisanalytics", "cloudFormationName": "KinesisAnalytics", "cloudTrailEventSource": "kinesisanalytics.amazonaws.com", + "docId": "kinesisanalytics-2015-08-14", "endpointPrefix": "kinesisanalytics" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/kinesis-video.json b/codegen/sdk/aws-models/kinesis-video.json index 164994cb4b4..1edd9ca070c 100644 --- a/codegen/sdk/aws-models/kinesis-video.json +++ b/codegen/sdk/aws-models/kinesis-video.json @@ -1828,6 +1828,7 @@ "arnNamespace": "kinesisvideo", "cloudFormationName": "KinesisVideo", "cloudTrailEventSource": "kinesisvideo.amazonaws.com", + "docId": "kinesisvideo-2017-09-30", "endpointPrefix": "kinesisvideo" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/lex-model-building-service.json b/codegen/sdk/aws-models/lex-model-building-service.json index d60c3b05e0f..10d77b5f4f6 100644 --- a/codegen/sdk/aws-models/lex-model-building-service.json +++ b/codegen/sdk/aws-models/lex-model-building-service.json @@ -166,6 +166,7 @@ "arnNamespace": "lex", "cloudFormationName": "LexModelBuildingService", "cloudTrailEventSource": "lexmodelbuildingservice.amazonaws.com", + "docId": "lex-models-2017-04-19", "endpointPrefix": "models.lex" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/lex-models-v2.json b/codegen/sdk/aws-models/lex-models-v2.json index 74e0ce765d0..9cdde682d53 100644 --- a/codegen/sdk/aws-models/lex-models-v2.json +++ b/codegen/sdk/aws-models/lex-models-v2.json @@ -12408,6 +12408,7 @@ "arnNamespace": "lex", "cloudFormationName": "LexModelsV2", "cloudTrailEventSource": "lexmodelsv2.amazonaws.com", + "docId": "models.lex.v2-2020-08-07", "endpointPrefix": "models-v2-lex" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/lex-runtime-service.json b/codegen/sdk/aws-models/lex-runtime-service.json index 04ec63d0c95..f292ef82197 100644 --- a/codegen/sdk/aws-models/lex-runtime-service.json +++ b/codegen/sdk/aws-models/lex-runtime-service.json @@ -55,6 +55,7 @@ "arnNamespace": "lex", "cloudFormationName": "LexRuntimeService", "cloudTrailEventSource": "lexruntimeservice.amazonaws.com", + "docId": "runtime.lex-2016-11-28", "endpointPrefix": "runtime.lex" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/lex-runtime-v2.json b/codegen/sdk/aws-models/lex-runtime-v2.json index eae809093cf..c3835852a55 100644 --- a/codegen/sdk/aws-models/lex-runtime-v2.json +++ b/codegen/sdk/aws-models/lex-runtime-v2.json @@ -58,6 +58,7 @@ "arnNamespace": "lex", "cloudFormationName": "LexRuntimeV2", "cloudTrailEventSource": "lexruntimev2.amazonaws.com", + "docId": "runtime.lex.v2-2020-08-07", "endpointPrefix": "runtime-v2-lex" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/machine-learning.json b/codegen/sdk/aws-models/machine-learning.json index 252d12487b6..9a751001301 100644 --- a/codegen/sdk/aws-models/machine-learning.json +++ b/codegen/sdk/aws-models/machine-learning.json @@ -217,6 +217,7 @@ "arnNamespace": "machinelearning", "cloudFormationName": "MachineLearning", "cloudTrailEventSource": "machinelearning.amazonaws.com", + "docId": "machinelearning-2014-12-12", "endpointPrefix": "machinelearning" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/marketplace-commerce-analytics.json b/codegen/sdk/aws-models/marketplace-commerce-analytics.json index 5c75c6a50f7..994e17cce26 100644 --- a/codegen/sdk/aws-models/marketplace-commerce-analytics.json +++ b/codegen/sdk/aws-models/marketplace-commerce-analytics.json @@ -333,6 +333,7 @@ "arnNamespace": "marketplacecommerceanalytics", "cloudFormationName": "MarketplaceCommerceAnalytics", "cloudTrailEventSource": "marketplacecommerceanalytics.amazonaws.com", + "docId": "marketplacecommerceanalytics-2015-07-01", "endpointPrefix": "marketplacecommerceanalytics" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/marketplace-entitlement-service.json b/codegen/sdk/aws-models/marketplace-entitlement-service.json index f9767016de9..b8dab8047a0 100644 --- a/codegen/sdk/aws-models/marketplace-entitlement-service.json +++ b/codegen/sdk/aws-models/marketplace-entitlement-service.json @@ -43,6 +43,7 @@ "arnNamespace": "aws-marketplace", "cloudFormationName": "MarketplaceEntitlementService", "cloudTrailEventSource": "marketplaceentitlementservice.amazonaws.com", + "docId": "entitlement.marketplace-2017-01-11", "endpointPrefix": "entitlement.marketplace" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/marketplace-metering.json b/codegen/sdk/aws-models/marketplace-metering.json index c6be978941b..fa5cb0ff6e1 100644 --- a/codegen/sdk/aws-models/marketplace-metering.json +++ b/codegen/sdk/aws-models/marketplace-metering.json @@ -52,6 +52,7 @@ "arnNamespace": "aws-marketplace", "cloudFormationName": "MarketplaceMetering", "cloudTrailEventSource": "marketplacemetering.amazonaws.com", + "docId": "meteringmarketplace-2016-01-14", "endpointPrefix": "metering.marketplace" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/mediaconvert.json b/codegen/sdk/aws-models/mediaconvert.json index 864cba48135..9438c477c8a 100644 --- a/codegen/sdk/aws-models/mediaconvert.json +++ b/codegen/sdk/aws-models/mediaconvert.json @@ -1097,6 +1097,84 @@ "traits": { "smithy.api#enumValue": "VHR" } + }, + "TBL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TBL" + } + }, + "TBC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TBC" + } + }, + "TBR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TBR" + } + }, + "RSL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RSL" + } + }, + "RSR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RSR" + } + }, + "LW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LW" + } + }, + "RW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RW" + } + }, + "LFE2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LFE2" + } + }, + "LT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LT" + } + }, + "RT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RT" + } + }, + "HI": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HI" + } + }, + "NAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAR" + } + }, + "M": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "M" + } } }, "traits": { @@ -1186,6 +1264,12 @@ "traits": { "smithy.api#enumValue": "PASSTHROUGH" } + }, + "FLAC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLAC" + } } }, "traits": { @@ -1237,6 +1321,13 @@ "smithy.api#jsonName": "eac3Settings" } }, + "FlacSettings": { + "target": "com.amazonaws.mediaconvert#FlacSettings", + "traits": { + "smithy.api#documentation": "Required when you set Codec, under AudioDescriptions>CodecSettings, to the value FLAC.", + "smithy.api#jsonName": "flacSettings" + } + }, "Mp2Settings": { "target": "com.amazonaws.mediaconvert#Mp2Settings", "traits": { @@ -1791,7 +1882,7 @@ "MaxAbrBitrate": { "target": "com.amazonaws.mediaconvert#__integerMin100000Max100000000", "traits": { - "smithy.api#documentation": "Optional. The maximum target bit rate used in your automated ABR stack. Use this value to set an upper limit on the bandwidth consumed by the highest-quality rendition. This is the rendition that is delivered to viewers with the fastest internet connections. If you don't specify a value, MediaConvert uses 8,000,000 (8 mb/s) by default.", + "smithy.api#documentation": "Specify the maximum average bitrate for MediaConvert to use in your automated ABR stack. If you don't specify a value, MediaConvert uses 8,000,000 (8 mb/s) by default. The average bitrate of your highest-quality rendition will be equal to or below this value, depending on the quality, complexity, and resolution of your content. Note that the instantaneous maximum bitrate may vary above the value that you specify.", "smithy.api#jsonName": "maxAbrBitrate" } }, @@ -1805,7 +1896,7 @@ "MinAbrBitrate": { "target": "com.amazonaws.mediaconvert#__integerMin100000Max100000000", "traits": { - "smithy.api#documentation": "Optional. The minimum target bitrate used in your automated ABR stack. Use this value to set a lower limit on the bitrate of video delivered to viewers with slow internet connections. If you don't specify a value, MediaConvert uses 600,000 (600 kb/s) by default.", + "smithy.api#documentation": "Specify the minimum average bitrate for MediaConvert to use in your automated ABR stack. If you don't specify a value, MediaConvert uses 600,000 (600 kb/s) by default. The average bitrate of your lowest-quality rendition will be near this value. Note that the instantaneous minimum bitrate may vary below the value that you specify.", "smithy.api#jsonName": "minAbrBitrate" } }, @@ -1900,6 +1991,26 @@ "smithy.api#documentation": "Specify the Bit depth. You can choose 8-bit or 10-bit." } }, + "com.amazonaws.mediaconvert#Av1FilmGrainSynthesis": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + }, + "traits": { + "smithy.api#documentation": "Film grain synthesis replaces film grain present in your content with similar quality synthesized AV1 film grain. We recommend that you choose Enabled to reduce the bandwidth of your QVBR quality level 5, 6, 7, or 8 outputs. For QVBR quality level 9 or 10 outputs we recommend that you keep the default value, Disabled. When you include Film grain synthesis, you cannot include the Noise reducer preprocessor." + } + }, "com.amazonaws.mediaconvert#Av1FramerateControl": { "type": "enum", "members": { @@ -1999,6 +2110,13 @@ "smithy.api#jsonName": "bitDepth" } }, + "FilmGrainSynthesis": { + "target": "com.amazonaws.mediaconvert#Av1FilmGrainSynthesis", + "traits": { + "smithy.api#documentation": "Film grain synthesis replaces film grain present in your content with similar quality synthesized AV1 film grain. We recommend that you choose Enabled to reduce the bandwidth of your QVBR quality level 5, 6, 7, or 8 outputs. For QVBR quality level 9 or 10 outputs we recommend that you keep the default value, Disabled. When you include Film grain synthesis, you cannot include the Noise reducer preprocessor.", + "smithy.api#jsonName": "filmGrainSynthesis" + } + }, "FramerateControl": { "target": "com.amazonaws.mediaconvert#Av1FramerateControl", "traits": { @@ -8707,6 +8825,35 @@ "smithy.api#documentation": "When you use the setting Time delta to adjust the sync between your sidecar captions and your video, use this setting to specify the units for the delta that you specify. When you don't specify a value for Time delta units, MediaConvert uses seconds by default." } }, + "com.amazonaws.mediaconvert#FlacSettings": { + "type": "structure", + "members": { + "BitDepth": { + "target": "com.amazonaws.mediaconvert#__integerMin16Max24", + "traits": { + "smithy.api#documentation": "Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track.", + "smithy.api#jsonName": "bitDepth" + } + }, + "Channels": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max8", + "traits": { + "smithy.api#documentation": "Specify the number of channels in this output audio track. Choosing Mono on the console gives you 1 output channel; choosing Stereo gives you 2. In the API, valid values are between 1 and 8.", + "smithy.api#jsonName": "channels" + } + }, + "SampleRate": { + "target": "com.amazonaws.mediaconvert#__integerMin22050Max48000", + "traits": { + "smithy.api#documentation": "Sample rate in hz.", + "smithy.api#jsonName": "sampleRate" + } + } + }, + "traits": { + "smithy.api#documentation": "Required when you set Codec, under AudioDescriptions>CodecSettings, to the value FLAC." + } + }, "com.amazonaws.mediaconvert#FontScript": { "type": "enum", "members": { @@ -8836,7 +8983,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieve the JSON for a specific completed transcoding job.", + "smithy.api#documentation": "Retrieve the JSON for a specific transcoding job.", "smithy.api#http": { "method": "GET", "uri": "/2017-08-29/jobs/{Id}", @@ -16117,6 +16264,20 @@ "smithy.api#jsonName": "programNumber" } }, + "PtsOffset": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max3600", + "traits": { + "smithy.api#documentation": "Manually specify the initial PTS offset, in seconds, when you set PTS offset to Seconds. Enter an integer from 0 to 3600. Leave blank to keep the default value 2.", + "smithy.api#jsonName": "ptsOffset" + } + }, + "PtsOffsetMode": { + "target": "com.amazonaws.mediaconvert#TsPtsOffset", + "traits": { + "smithy.api#documentation": "Specify the initial presentation timestamp (PTS) offset for your transport stream output. To let MediaConvert automatically determine the initial PTS offset: Keep the default value, Auto. We recommend that you choose Auto for the widest player compatibility. The initial PTS will be at least two seconds and vary depending on your output's bitrate, HRD buffer size and HRD buffer initial fill percentage. To manually specify an initial PTS offset: Choose Seconds. Then specify the number of seconds with PTS offset.", + "smithy.api#jsonName": "ptsOffsetMode" + } + }, "RateMode": { "target": "com.amazonaws.mediaconvert#M2tsRateMode", "traits": { @@ -16386,6 +16547,20 @@ "smithy.api#jsonName": "programNumber" } }, + "PtsOffset": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max3600", + "traits": { + "smithy.api#documentation": "Manually specify the initial PTS offset, in seconds, when you set PTS offset to Seconds. Enter an integer from 0 to 3600. Leave blank to keep the default value 2.", + "smithy.api#jsonName": "ptsOffset" + } + }, + "PtsOffsetMode": { + "target": "com.amazonaws.mediaconvert#TsPtsOffset", + "traits": { + "smithy.api#documentation": "Specify the initial presentation timestamp (PTS) offset for your transport stream output. To let MediaConvert automatically determine the initial PTS offset: Keep the default value, Auto. We recommend that you choose Auto for the widest player compatibility. The initial PTS will be at least two seconds and vary depending on your output's bitrate, HRD buffer size and HRD buffer initial fill percentage. To manually specify an initial PTS offset: Choose Seconds. Then specify the number of seconds with PTS offset.", + "smithy.api#jsonName": "ptsOffsetMode" + } + }, "Scte35Pid": { "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { @@ -21157,6 +21332,13 @@ "smithy.api#documentation": "Settings for how your job outputs are encrypted as they are uploaded to Amazon S3.", "smithy.api#jsonName": "encryption" } + }, + "StorageClass": { + "target": "com.amazonaws.mediaconvert#S3StorageClass", + "traits": { + "smithy.api#documentation": "Specify the S3 storage class to use for this destination.", + "smithy.api#jsonName": "storageClass" + } } }, "traits": { @@ -21244,6 +21426,56 @@ "smithy.api#documentation": "Specify how you want your data keys managed. AWS uses data keys to encrypt your content. AWS also encrypts the data keys themselves, using a customer master key (CMK), and then stores the encrypted data keys alongside your encrypted content. Use this setting to specify which AWS service manages the CMK. For simplest set up, choose Amazon S3. If you want your master key to be managed by AWS Key Management Service (KMS), choose AWS KMS. By default, when you choose AWS KMS, KMS uses the AWS managed customer master key (CMK) associated with Amazon S3 to encrypt your data keys. You can optionally choose to specify a different, customer managed CMK. Do so by specifying the Amazon Resource Name (ARN) of the key for the setting KMS ARN." } }, + "com.amazonaws.mediaconvert#S3StorageClass": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "REDUCED_REDUNDANCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDUCED_REDUNDANCY" + } + }, + "STANDARD_IA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD_IA" + } + }, + "ONEZONE_IA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONEZONE_IA" + } + }, + "INTELLIGENT_TIERING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTELLIGENT_TIERING" + } + }, + "GLACIER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GLACIER" + } + }, + "DEEP_ARCHIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEEP_ARCHIVE" + } + } + }, + "traits": { + "smithy.api#documentation": "Specify the S3 storage class to use for this destination." + } + }, "com.amazonaws.mediaconvert#SampleRangeConversion": { "type": "enum", "members": { @@ -22002,6 +22234,26 @@ "smithy.api#documentation": "Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings." } }, + "com.amazonaws.mediaconvert#TsPtsOffset": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "SECONDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECONDS" + } + } + }, + "traits": { + "smithy.api#documentation": "Specify the initial presentation timestamp (PTS) offset for your transport stream output. To let MediaConvert automatically determine the initial PTS offset: Keep the default value, Auto. We recommend that you choose Auto for the widest player compatibility. The initial PTS will be at least two seconds and vary depending on your output's bitrate, HRD buffer size and HRD buffer initial fill percentage. To manually specify an initial PTS offset: Choose Seconds. Then specify the number of seconds with PTS offset." + } + }, "com.amazonaws.mediaconvert#TtmlDestinationSettings": { "type": "structure", "members": { @@ -25185,6 +25437,15 @@ } } }, + "com.amazonaws.mediaconvert#__integerMin1Max8": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 8 + } + } + }, "com.amazonaws.mediaconvert#__integerMin22050Max48000": { "type": "integer", "traits": { diff --git a/codegen/sdk/aws-models/medialive.json b/codegen/sdk/aws-models/medialive.json index 49c8257c71e..0ba0210997c 100644 --- a/codegen/sdk/aws-models/medialive.json +++ b/codegen/sdk/aws-models/medialive.json @@ -276,6 +276,26 @@ "smithy.api#documentation": "Aac Vbr Quality" } }, + "com.amazonaws.medialive#Ac3AttenuationControl": { + "type": "enum", + "members": { + "ATTENUATE_3_DB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTENUATE_3_DB" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + }, + "traits": { + "smithy.api#documentation": "Ac3 Attenuation Control" + } + }, "com.amazonaws.medialive#Ac3BitstreamMode": { "type": "enum", "members": { @@ -475,6 +495,13 @@ "smithy.api#documentation": "When set to \"followInput\", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.", "smithy.api#jsonName": "metadataControl" } + }, + "AttenuationControl": { + "target": "com.amazonaws.medialive#Ac3AttenuationControl", + "traits": { + "smithy.api#documentation": "Applies a 3 dB attenuation to the surround channels. Applies only when the coding mode parameter is CODING_MODE_3_2_LFE.", + "smithy.api#jsonName": "attenuationControl" + } } }, "traits": { @@ -12037,6 +12064,32 @@ "smithy.api#documentation": "Settings to configure an action so that it occurs as soon as possible." } }, + "com.amazonaws.medialive#IncludeFillerNalUnits": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "DROP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DROP" + } + }, + "INCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUDE" + } + } + }, + "traits": { + "smithy.api#documentation": "Include Filler Nal Units" + } + }, "com.amazonaws.medialive#Input": { "type": "structure", "members": { @@ -15577,6 +15630,26 @@ "smithy.api#documentation": "M2ts Timed Metadata Behavior" } }, + "com.amazonaws.medialive#M3u8KlvBehavior": { + "type": "enum", + "members": { + "NO_PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_PASSTHROUGH" + } + }, + "PASSTHROUGH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSTHROUGH" + } + } + }, + "traits": { + "smithy.api#documentation": "M3u8 Klv Behavior" + } + }, "com.amazonaws.medialive#M3u8NielsenId3Behavior": { "type": "enum", "members": { @@ -15758,6 +15831,20 @@ "smithy.api#documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.", "smithy.api#jsonName": "videoPid" } + }, + "KlvBehavior": { + "target": "com.amazonaws.medialive#M3u8KlvBehavior", + "traits": { + "smithy.api#documentation": "If set to passthrough, passes any KLV data from the input source to this output.", + "smithy.api#jsonName": "klvBehavior" + } + }, + "KlvDataPids": { + "target": "com.amazonaws.medialive#__string", + "traits": { + "smithy.api#documentation": "Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).", + "smithy.api#jsonName": "klvDataPids" + } } }, "traits": { @@ -20062,6 +20149,13 @@ "smithy.api#documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.", "smithy.api#jsonName": "restartDelay" } + }, + "IncludeFillerNalUnits": { + "target": "com.amazonaws.medialive#IncludeFillerNalUnits", + "traits": { + "smithy.api#documentation": "Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate). Controls whether the RTMP output stream is padded (with FILL NAL units) in order to achieve a constant bit rate that is truly constant. When there is no padding, the bandwidth varies (up to the bitrate value in the codec settings). We recommend that you choose Auto.", + "smithy.api#jsonName": "includeFillerNalUnits" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/mediatailor.json b/codegen/sdk/aws-models/mediatailor.json index c52a0692854..ff181eaf8b5 100644 --- a/codegen/sdk/aws-models/mediatailor.json +++ b/codegen/sdk/aws-models/mediatailor.json @@ -7,7 +7,7 @@ "AccessType": { "target": "com.amazonaws.mediatailor#AccessType", "traits": { - "smithy.api#documentation": "The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.
\n S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
\n• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
\n• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
" + "smithy.api#documentation": "The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location.
\n S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.
Before you can use S3_SIGV4, you must meet these requirements:
• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.
\n• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.
\n• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
\n\n AUTODETECT_SIGV4 - AWS Signature Version 4 authentication for a set of supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style access. If your source location base URL is a MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the resource where your source content is stored.
Before you can use AUTODETECT_SIGV4 with a MediaPackage Version 2 endpoint, you must meet these requirements:
• You must grant MediaTailor access to your MediaPackage endpoint by granting mediatailor.amazonaws.com principal access in an Origin Access policy on the endpoint.
• Your MediaTailor source location base URL must be a MediaPackage V2 endpoint.
\n• The caller of the API must have mediapackagev2:GetObject IAM permissions to read all top level manifests referenced by the MediaTailor source packaging configurations.
Before you can use AUTODETECT_SIGV4 with an Amazon S3 bucket, you must meet these requirements:
• You must grant MediaTailor access to your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For more information about configuring access in IAM, see Access management in the IAM User Guide..
• The mediatailor.amazonaws.com service principal must have permissions to read all top-level manifests referenced by the VodSource packaging configurations.
• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.
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": "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.
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.
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.
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.
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.
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.
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.
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.
The job Id of the completed model-transform job. You must supply\n either the mlModelTrainingJobId or the mlModelTransformJobId.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
\nNeptune 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.
The fast reset action. One of the following values:
\n\n \n initiateDatabaseReset\n – \n This action generates a unique token needed to actually perform the \n fast reset.
\n \n performDatabaseReset\n – \n This action uses the token generated by the initiateDatabaseReset action\n to actually perform the fast reset.
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.
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.
Executes a Gremlin Explain query.
\nAmazon 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.
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.
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.
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.
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.
A text blob containing the openCypher explain results.
Executes an openCypher query. See Accessing\n the Neptune Graph with openCypher for more information.
\nNeptune 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.
\nThe 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.
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.
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-.
Set to reader if the instance is a read-replica,\n or to writer if the instance is the primary instance.
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.
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).
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.
\nSee 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).
Flag indicating whether or not to include a list of errors\n encountered (TRUE or FALSE; the default\n is FALSE).
The list of errors is paged. The page and errorsPerPage\n parameters allow you to page through all the errors.
The error page number (a positive integer; the default is 1).\n Only valid when the errors parameter is set to\n TRUE.
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.
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.
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.
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.
\nWith 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.
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.
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.
The range for limit is 1 to 100,000, with a\n default of 10.
Can be one of:
\n\n AT_SEQUENCE_NUMBER – \n Indicates that reading should start from the event sequence number\n specified jointly by the commitNum and\n opNum parameters.
\n AFTER_SEQUENCE_NUMBER – \n Indicates that reading should start right after the event sequence number\n specified jointly by the commitNum and opNum\n parameters.
\n TRIM_HORIZON – \n Indicates that reading should start at the last untrimmed record in the system,\n which is the oldest unexpired (not yet deleted) record in the change-log stream.
\n LATEST – \n Indicates that reading should start at the most recent record in the system,\n which is the latest unexpired (not yet deleted) record in the change-log stream.
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.
The operation sequence number within the specified commit to\n start reading from in the change-log stream data. The default is 1.
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.
\nAn 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:
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.
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.
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.
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.
\nWith 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.
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.
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.
The range for limit is 1 to 100,000, with a\n default of 10.
Can be one of:
\n\n AT_SEQUENCE_NUMBER – \n Indicates that reading should start from the event sequence number\n specified jointly by the commitNum and\n opNum parameters.
\n AFTER_SEQUENCE_NUMBER – \n Indicates that reading should start right after the event sequence number\n specified jointly by the commitNum and opNum\n parameters.
\n TRIM_HORIZON – \n Indicates that reading should start at the last untrimmed record in the system,\n which is the oldest unexpired (not yet deleted) record in the change-log stream.
\n LATEST – \n Indicates that reading should start at the most recent record in the system,\n which is the latest unexpired (not yet deleted) record in the change-log stream.
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.
The operation sequence number within the specified commit to\n start reading from in the change-log stream data. The default is 1.
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.
\nAn 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:
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.
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;
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.
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).
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.
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.
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.
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.
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.
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\n \n v1\n - \n Vertex label for Gremlin, or node label for openCypher.
\n \n vp\n - \n Vertex properties for Gremlin, or node properties for openCypher.
\n \n e\n - \n Edge and edge label for Gremlin, or relationship and relationship type\n for openCypher.
\n \n ep\n - \n Edge properties for Gremlin, or relationship properties for openCypher.
The property name. For element labels, this is label.
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.
If this is an edge (type = e), the ID of the\n corresponding to vertex or target node.
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.
This field is only present when the requested mode is\n DETAILED. It contains a list of edge structures.
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.
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.
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.
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.
The URI can be in any of the following formats.
\n\n s3://(bucket_name)/(object-key-name)\n
\n https://s3.amazonaws.com/(bucket_name)/(object-key-name)\n
\n https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)\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.
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 Allowed values\n
\n\n \n csv\n for the Gremlin CSV data format.
\n \n opencypher\n for the\n openCypher CSV data format.
\n \n ntriples\n for the\n N-Triples RDF data format.
\n \n nquads\n for the\n N-Quads RDF data format.
\n \n rdfxml\n for the\n RDF\\XML RDF data format.
\n \n turtle\n for the\n Turtle RDF data format.
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 Default value: AUTO.
\n \n
\n\n RESUME – In RESUME mode,\n the loader looks for a previous load from this source, and if it finds\n one, resumes that load job. If no previous load job is found, the loader stops.
The loader avoids reloading files that were successfully loaded in\n a previous job. It only tries to process failed files. If you dropped\n previously loaded data from your Neptune cluster, that data is not\n reloaded in this mode. If a previous load job loaded all files from the\n same source successfully, nothing is reloaded, and the loader returns\n success.
\n\n NEW – In NEW mode, the\n creates a new load request regardless of any previous loads. You\n can use this mode to reload all the data from a source after dropping\n previously loaded data from your Neptune cluster, or to load new data\n available at the same source.
\n AUTO – In AUTO mode,\n the loader looks for a previous load job from the same source, and if it\n finds one, resumes that job, just as in RESUME mode.
If the loader doesn't find a previous load job from the same\n source, it loads all data from the source, just as in NEW\n mode.
\n \n failOnError\n – A flag to toggle a\n complete stop on an error.
\n Allowed values: \"TRUE\", \"FALSE\".
\n Default value: \"TRUE\".
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.
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.
The optional parallelism parameter can be set\n to reduce the number of threads used by the bulk load process.
\n Allowed values:
\n\n LOW – The number of threads used is the\n number of available vCPUs divided by 8.
\n MEDIUM – The number of threads used is the\n number of available vCPUs divided by 2.
\n HIGH – The number of threads used is the\n same as the number of available vCPUs.
\n OVERSUBSCRIBE – The number of threads used is the\n number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all\n available resources.
This does not mean, however, that the OVERSUBSCRIBE setting\n results in 100% CPU utilization. Because the load operation is I/O bound, the\n highest CPU utilization to expect is in the 60% to 70% range.
\n Default value: HIGH\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.
\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 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).
The default is https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph.
\n \n baseUri\n – \n The base URI for RDF/XML and Turtle formats.
The default is https://aws.amazon.com/neptune/default.
\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.
If allowEmptyStrings is set to true,\n the loader treats empty strings as valid property values and loads\n them accordingly.
\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 Allowed values: \"TRUE\", \"FALSE\".
\n Default value: \"FALSE\".
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.
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.
This is an optional flag parameter\n that indicates whether the load request can be queued up or not.
\nYou 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\".
If the queueRequest parameter is omitted or set to \"FALSE\",\n the load request will fail if another load job is already running.
\n Allowed values: \"TRUE\", \"FALSE\".
\n Default value: \"FALSE\".
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.
\nNeptune 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.
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:
Submit load-job-A and load-job-B one after\n another in any order, and save their load-ids.
Submit load-job-C with the load-ids of the\n two jobs in its dependencies field:
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.
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).
When userProvidedEdgeIds is absent or set to True,\n an :ID column must be present in every relationship file in the load.
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.
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.
Creates a new Neptune ML data processing job for processing the\n graph data exported from Neptune for training. See The\n dataprocessing command.
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.
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.
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.
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.
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.
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.
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.
The job ID of a completed model-training job. You must include either\n dataProcessingJobId and a mlModelTrainingJobId,\n or a trainingJobName.
The name of a completed SageMaker training job. You must include either\n dataProcessingJobId and a mlModelTrainingJobId,\n or a trainingJobName.
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:
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 signatureCount - The total number of signatures\n across all characteristic sets.
\n instanceCount - The total number of\n characteristic-set instances.
\n predicateCount - The total number of unique predicates.
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/aws-models/network-firewall.json b/codegen/sdk/aws-models/network-firewall.json index fdc5f0fc1ba..288cc7c81cc 100644 --- a/codegen/sdk/aws-models/network-firewall.json +++ b/codegen/sdk/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.
\nAfter you create a TLS inspection configuration, you associate it with a firewall policy.
\nTo update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.
\nTo manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
\nTo 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.
\nAfter you create a TLS inspection configuration, you associate it with a new firewall policy.
\nTo update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.
\nTo manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
\nTo 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.
\nNetwork Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
\nTo 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.
\nNetwork Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
\nTo 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.
\nNetwork Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
\nTo 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.
\nNetwork Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
\nTo 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": { @@ -4263,7 +4269,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 2048 + "max": 4096 }, "smithy.api#pattern": "^[0-9A-Za-z:\\/+=]+$" } @@ -4828,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.
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.
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.
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.
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.
\nThe actions for a stateful rule are defined as follows:
\n\n PASS - Permits the packets to go to the\n intended destination.
\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 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.
\nYou 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 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 REJECT isn't currently available for use with IMAP and FTP protocols.
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.
\nThe actions for a stateful rule are defined as follows:
\n\n PASS - Permits the packets to go to the\n intended destination.
\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 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.
\nYou 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.
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.
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.
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.
\nNetwork Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
\nTo 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.
\nNetwork Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
\nTo 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": { @@ -6472,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.
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.
\nNetwork Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
\nTo 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.
\nNetwork Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
\nTo 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/aws-models/omics.json b/codegen/sdk/aws-models/omics.json index c946df3bd5b..6197c459506 100644 --- a/codegen/sdk/aws-models/omics.json +++ b/codegen/sdk/aws-models/omics.json @@ -6247,6 +6247,12 @@ "traits": { "smithy.api#documentation": "\n The computational accelerator used to run the workflow. \n
" } + }, + "retentionMode": { + "target": "com.amazonaws.omics#RunRetentionMode", + "traits": { + "smithy.api#documentation": "The run's retention mode.
" + } } }, "traits": { @@ -12790,6 +12796,25 @@ "target": "com.amazonaws.omics#RunResourceDigest" } }, + "com.amazonaws.omics#RunRetentionMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "name": "RETAIN", + "value": "RETAIN" + }, + { + "name": "REMOVE", + "value": "REMOVE" + } + ], + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, "com.amazonaws.omics#RunRoleArn": { "type": "string", "traits": { @@ -14179,7 +14204,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a run.
", + "smithy.api#documentation": "Starts a workflow run. To duplicate a run, specify the run's ID and a role ARN. The\n remaining parameters are copied from the previous run.
\nThe total number of runs in your account is subject to a quota per Region. To avoid\n needing to delete runs manually, you can set the retention mode to REMOVE.\n Runs with this setting are deleted automatically when the run quoata is exceeded.
The run's workflows type.
" + "smithy.api#documentation": "The run's workflow type.
" } }, "runId": { "target": "com.amazonaws.omics#RunId", "traits": { - "smithy.api#documentation": "The run's ID.
" + "smithy.api#documentation": "The ID of a run to duplicate.
" } }, "roleArn": { @@ -14281,6 +14306,12 @@ "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } + }, + "retentionMode": { + "target": "com.amazonaws.omics#RunRetentionMode", + "traits": { + "smithy.api#documentation": "The retention mode for the run.
" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/organizations.json b/codegen/sdk/aws-models/organizations.json index 76ad507a1f0..9b2a8435eda 100644 --- a/codegen/sdk/aws-models/organizations.json +++ b/codegen/sdk/aws-models/organizations.json @@ -224,7 +224,7 @@ "name": "organizations" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Organizations is a web service that enables you to consolidate your multiple\n Amazon Web Services accounts into an organization and centrally manage your\n accounts and their resources.
\nThis guide provides descriptions of the Organizations operations. For more\n information about using this service, see the Organizations User Guide.
\n\n Support and feedback for Organizations\n
\nWe welcome your feedback. Send your comments to feedback-awsorganizations@amazon.com or post your feedback and questions in\n the Organizations support forum. For\n more information about the Amazon Web Services support forums, see Forums Help.
\n\n Endpoint to call When using the CLI or the Amazon Web Services\n SDK\n
\nFor the current release of Organizations, specify the us-east-1 region\n for all Amazon Web Services API and CLI calls made from the commercial Amazon Web Services Regions outside of\n China. If calling from one of the Amazon Web Services Regions in China, then specify\n cn-northwest-1. You can do this in the CLI by using these parameters\n and commands:
Use the following parameter with each command to specify both the endpoint and\n its region:
\n\n --endpoint-url https://organizations.us-east-1.amazonaws.com\n (from commercial Amazon Web Services Regions outside of China)\n
or
\n\n --endpoint-url\n https://organizations.cn-northwest-1.amazonaws.com.cn\n (from Amazon Web Services Regions in China)\n
Use the default endpoint, but configure your default region with this\n command:
\n\n aws configure set default.region us-east-1\n (from commercial Amazon Web Services Regions outside of China)\n
or
\n\n aws configure set default.region cn-northwest-1\n (from Amazon Web Services Regions in China)\n
Use the following parameter with each command to specify the endpoint:
\n\n --region us-east-1\n (from commercial Amazon Web Services Regions outside of China)\n
or
\n\n --region cn-northwest-1\n (from Amazon Web Services Regions in China)\n
\n Recording API Requests\n
\nOrganizations supports CloudTrail, a service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected\n by CloudTrail, you can determine which requests the Organizations service received, who made the\n request and when, and so on. For more about Organizations and its support for CloudTrail, see\n Logging\n Organizations Events with CloudTrail in the Organizations User Guide.\n To learn more about CloudTrail, including how to turn it on and find your log files, see the\n CloudTrail User Guide.
", + "smithy.api#documentation": "Organizations is a web service that enables you to consolidate your multiple\n Amazon Web Services accounts into an organization and centrally manage your\n accounts and their resources.
\nThis guide provides descriptions of the Organizations operations. For more\n information about using this service, see the Organizations User Guide.
\n\n Support and feedback for Organizations\n
\nWe welcome your feedback. Send your comments to feedback-awsorganizations@amazon.com or post your feedback and questions in\n the Organizations support forum. For\n more information about the Amazon Web Services support forums, see Forums Help.
\n\n Endpoint to call When using the CLI or the Amazon Web Services\n SDK\n
\nFor the current release of Organizations, specify the us-east-1 region\n for all Amazon Web Services API and CLI calls made from the commercial Amazon Web Services Regions outside of\n China. If calling from one of the Amazon Web Services Regions in China, then specify\n cn-northwest-1. You can do this in the CLI by using these parameters\n and commands:
Use the following parameter with each command to specify both the endpoint and\n its region:
\n\n --endpoint-url https://organizations.us-east-1.amazonaws.com\n (from commercial Amazon Web Services Regions outside of China)\n
or
\n\n --endpoint-url\n https://organizations.cn-northwest-1.amazonaws.com.cn\n (from Amazon Web Services Regions in China)\n
Use the default endpoint, but configure your default region with this\n command:
\n\n aws configure set default.region us-east-1\n (from commercial Amazon Web Services Regions outside of China)\n
or
\n\n aws configure set default.region cn-northwest-1\n (from Amazon Web Services Regions in China)\n
Use the following parameter with each command to specify the endpoint:
\n\n --region us-east-1\n (from commercial Amazon Web Services Regions outside of China)\n
or
\n\n --region cn-northwest-1\n (from Amazon Web Services Regions in China)\n
\n Recording API Requests\n
\nOrganizations supports CloudTrail, a service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected\n by CloudTrail, you can determine which requests the Organizations service received, who made the\n request and when, and so on. For more about Organizations and its support for CloudTrail, see\n Logging\n Organizations API calls with CloudTrail in the\n Organizations User Guide. To learn more about CloudTrail, including how to turn it\n on and find your log files, see the CloudTrail User Guide.
", "smithy.api#title": "AWS Organizations", "smithy.api#xmlNamespace": { "uri": "http://organizations.amazonaws.com/doc/2016-11-28/" @@ -1313,7 +1313,7 @@ } ], "traits": { - "smithy.api#documentation": "Sends a response to the originator of a handshake agreeing to the action proposed by\n the handshake request.
\nYou can only call this operation by the following principals when they also have the\n relevant IAM permissions:
\n\n Invitation to join or Approve all features request handshakes: only a principal from\n the member account.
\nThe user who calls the API for an invitation to join must have the\n organizations:AcceptHandshake permission. If you enabled all\n features in the organization, the user must also have the\n iam:CreateServiceLinkedRole permission so that Organizations can\n create the required service-linked role named AWSServiceRoleForOrganizations. For\n more information, see Organizations and Service-Linked Roles in the\n Organizations User Guide.
\n Enable all features final confirmation\n handshake: only a principal from the management account.
\nFor more information about invitations, see Inviting an\n Amazon Web Services account to join your organization in the\n Organizations User Guide. For more information about requests to\n enable all features in the organization, see Enabling all features in your organization in\n the Organizations User Guide.\n
\nAfter you accept a handshake, it continues to appear in the results of relevant APIs\n for only 30 days. After that, it's deleted.
" + "smithy.api#documentation": "Sends a response to the originator of a handshake agreeing to the action proposed by\n the handshake request.
\nYou can only call this operation by the following principals when they also have the\n relevant IAM permissions:
\n\n Invitation to join or Approve all features request handshakes: only a principal from\n the member account.
\nThe user who calls the API for an invitation to join must have the\n organizations:AcceptHandshake permission. If you enabled all\n features in the organization, the user must also have the\n iam:CreateServiceLinkedRole permission so that Organizations can\n create the required service-linked role named AWSServiceRoleForOrganizations. For\n more information, see Organizations and service-linked roles in the\n Organizations User Guide.
\n Enable all features final confirmation\n handshake: only a principal from the management account.
\nFor more information about invitations, see Inviting an\n Amazon Web Services account to join your organization in the\n Organizations User Guide. For more information about requests to\n enable all features in the organization, see Enabling all features in your organization in\n the Organizations User Guide.
\nAfter you accept a handshake, it continues to appear in the results of relevant APIs\n for only 30 days. After that, it's deleted.
" } }, "com.amazonaws.organizations#AcceptHandshakeRequest": { @@ -1353,7 +1353,7 @@ } }, "traits": { - "smithy.api#documentation": "You don't have permissions to perform the requested operation. The user or role that\n is making the request must have at least one IAM permissions policy attached that\n grants the required permissions. For more information, see Access Management in the\n IAM User Guide.\n
", + "smithy.api#documentation": "You don't have permissions to perform the requested operation. The user or role that\n is making the request must have at least one IAM permissions policy attached that\n grants the required permissions. For more information, see Access Management in the\n IAM User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -1539,7 +1539,7 @@ } }, "traits": { - "smithy.api#documentation": "You can't invite an existing account to your organization until you verify that you\n own the email address associated with the management account. For more information, see\n Email Address\n Verification in the Organizations User Guide.\n
", + "smithy.api#documentation": "You can't invite an existing account to your organization until you verify that you\n own the email address associated with the management account. For more information, see\n Email address\n verification in the Organizations User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -1665,7 +1665,7 @@ } ], "traits": { - "smithy.api#documentation": "Attaches a policy to a root, an organizational unit (OU), or an individual account.\n How the policy affects accounts depends on the type of policy. Refer to the\n Organizations User Guide for information about each policy type:
\n\n BACKUP_POLICY\n
\n\n TAG_POLICY\n
\nThis operation can be called only from the organization's management account.
", + "smithy.api#documentation": "Attaches a policy to a root, an organizational unit (OU), or an individual account.\n How the policy affects accounts depends on the type of policy. Refer to the\n Organizations User Guide for information about each policy type:
\n\n BACKUP_POLICY\n
\n\n TAG_POLICY\n
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
", "smithy.api#examples": [ { "title": "To attach a policy to an OU", @@ -1883,7 +1883,7 @@ } ], "traits": { - "smithy.api#documentation": "Closes an Amazon Web Services member account within an organization. You can close an account when\n all\n features are enabled . You can't close the management account with this API.\n This is an asynchronous request that Amazon Web Services performs in the background. Because\n CloseAccount operates asynchronously, it can return a successful\n completion message even though account closure might still be in progress. You need to\n wait a few minutes before the account is fully closed. To check the status of the\n request, do one of the following:
Use the AccountId that you sent in the CloseAccount\n request to provide as a parameter to the DescribeAccount\n operation.
While the close account request is in progress, Account status will indicate\n PENDING_CLOSURE. When the close account request completes, the status will\n change to SUSPENDED.
\nCheck the CloudTrail log for the CloseAccountResult event that gets\n published after the account closes successfully. For information on using CloudTrail\n with Organizations, see Logging and monitoring in Organizations in the\n Organizations User Guide.\n
You can close only 10% of member accounts, between 10 and 200, within a\n rolling 30 day period. This quota is not bound by a calendar month, but\n starts when you close an account.
\nAfter you reach this limit, you can close additional accounts in the\n Billing console. For more information, see Closing an\n account in the Amazon Web Services Billing and Cost Management User Guide.
\nTo reinstate a closed account, contact Amazon Web Services Support within the 90-day\n grace period while the account is in SUSPENDED status.
\nIf the Amazon Web Services account you attempt to close is linked to an Amazon Web Services GovCloud\n (US) account, the CloseAccount request will close both\n accounts. To learn important pre-closure details, see \n Closing an Amazon Web Services GovCloud (US) account in the \n Amazon Web Services GovCloud User Guide.
For more information about closing accounts, see Closing an\n Amazon Web Services account in the Organizations User Guide.\n
" + "smithy.api#documentation": "Closes an Amazon Web Services member account within an organization. You can close an account when\n all\n features are enabled . You can't close the management account with this API.\n This is an asynchronous request that Amazon Web Services performs in the background. Because\n CloseAccount operates asynchronously, it can return a successful\n completion message even though account closure might still be in progress. You need to\n wait a few minutes before the account is fully closed. To check the status of the\n request, do one of the following:
Use the AccountId that you sent in the CloseAccount\n request to provide as a parameter to the DescribeAccount\n operation.
While the close account request is in progress, Account status will indicate\n PENDING_CLOSURE. When the close account request completes, the status will\n change to SUSPENDED.
\nCheck the CloudTrail log for the CloseAccountResult event that gets\n published after the account closes successfully. For information on using CloudTrail\n with Organizations, see Logging and monitoring in Organizations in the\n Organizations User Guide.
You can close only 10% of member accounts, between 10 and 200, within a\n rolling 30 day period. This quota is not bound by a calendar month, but\n starts when you close an account. After you reach this limit, you can close\n additional accounts. For more information, see Closing a member\n account in your organization in the\n Organizations User Guide.\n
\nTo reinstate a closed account, contact Amazon Web Services Support within the 90-day\n grace period while the account is in SUSPENDED status.
\nIf the Amazon Web Services account you attempt to close is linked to an Amazon Web Services GovCloud\n (US) account, the CloseAccount request will close both\n accounts. To learn important pre-closure details, see \n Closing an Amazon Web Services GovCloud (US) account in the \n Amazon Web Services GovCloud User Guide.
Performing this operation violates a minimum or maximum value limit. For example,\n attempting to remove the last service control policy (SCP) from an OU or root, inviting\n or creating too many accounts to the organization, or attaching too many policies to an\n account, OU, or root. This exception includes a reason that contains additional\n information about the violated limit:
\nSome of the reasons in the following list might not be applicable to this specific\n API or operation.
\nACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management\n account from the organization. You can't remove the management account. Instead,\n after you remove all member accounts, delete the organization itself.
\nACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an\n account from the organization that doesn't yet have enough information to exist\n as a standalone account. This account requires you to first complete phone\n verification. Follow the steps at Removing a member account from your organization in the\n Organizations User Guide.\n
\nACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of\n accounts that you can create in one day.
\nACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your account isn't fully active. You must complete the account setup before you create an organization.
\nACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number\n of accounts in an organization. If you need more accounts, contact Amazon Web Services Support to\n request an increase in your limit.
\nOr the number of invitations that you tried to send would cause you to exceed\n the limit of accounts in your organization. Send fewer invitations or contact\n Amazon Web Services Support to request an increase in the number of accounts.
\nDeleted and closed accounts still count toward your limit.
\nIf you get this exception when running a command immediately after\n creating the organization, wait one hour and try again. After an hour, if\n the command continues to fail with this error, contact Amazon Web Services\n Support.
\nCANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register\n the management account of the organization as a delegated administrator for an\n Amazon Web Services service integrated with Organizations. You can designate only a member account as a\n delegated administrator.
\nCANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management\n account. To close the management account for the organization, you must first\n either remove or close all member accounts in the organization. Follow standard\n account closure process using root credentials.
\nCANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an\n account that is registered as a delegated administrator for a service integrated\n with your organization. To complete this operation, you must first deregister\n this account as a delegated administrator.
\nCLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the\n past 30 days.
\nCLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of\n accounts that you can close at a time.
\nCREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an\n organization in the specified region, you must enable all features mode.
\nDELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an\n Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has\n a delegated administrator. To complete this operation, you must first deregister\n any existing delegated administrators for this service.
\nEMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for\n a limited period of time. You must resubmit the request and generate a new\n verfication code.
\nHANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of\n handshakes that you can send in one day.
\nINVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported\n payment method is associated with the account. Amazon Web Services does not support cards\n issued by financial institutions in Russia or Belarus. For more information, see\n Managing your\n Amazon Web Services payments.
\nMASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in\n this organization, you first must migrate the organization's management account\n to the marketplace that corresponds to the management account's address. For\n example, accounts with India addresses must be associated with the AISPL\n marketplace. All accounts in an organization must be associated with the same\n marketplace.
\nMASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services /> Regions\n in China. To create an organization, the master must have a valid business\n license. For more information, contact customer support.
\nMASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must\n first provide a valid contact address and phone number for the management\n account. Then try the operation again.
\nMASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the\n management account must have an associated account in the Amazon Web Services GovCloud\n (US-West) Region. For more information, see Organizations\n in the \n Amazon Web Services GovCloud User Guide.\n
\nMASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with\n this management account, you first must associate a valid payment instrument,\n such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet\n been provided in the Organizations User Guide.\n
\nMAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to\n register more delegated administrators than allowed for the service principal.\n
\nMAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number\n of policies of a certain type that can be attached to an entity at one\n time.
\nMAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this\n resource.
\nMEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with\n this member account, you first must associate a valid payment instrument, such\n as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet\n been provided in the Organizations User Guide.\n
\nMIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy\n from an entity that would cause the entity to have fewer than the minimum number\n of policies of a certain type required.
\nORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation\n that requires the organization to be configured to support all features. An\n organization that supports only consolidated billing features can't perform this\n operation.
\nOU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many\n levels deep.
\nOU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you\n can have in an organization.
\nPOLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger\n than the maximum size.
\nPOLICY_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of policies\n that you can have in an organization.
\nSERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated\n administrator before you enabled service access. Call the\n EnableAWSServiceAccess API first.
TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags\n that are not compliant with the tag policy requirements for this account.
\nWAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, there is a waiting\n period before you can remove it from the organization. If you get an error that\n indicates that a wait period is required, try again in a few days.
\nPerforming this operation violates a minimum or maximum value limit. For example,\n attempting to remove the last service control policy (SCP) from an OU or root, inviting\n or creating too many accounts to the organization, or attaching too many policies to an\n account, OU, or root. This exception includes a reason that contains additional\n information about the violated limit:
\nSome of the reasons in the following list might not be applicable to this specific\n API or operation.
\nACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management\n account from the organization. You can't remove the management account. Instead,\n after you remove all member accounts, delete the organization itself.
\nACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an\n account from the organization that doesn't yet have enough information to exist\n as a standalone account. This account requires you to first complete phone\n verification. Follow the steps at Removing a member account from your organization in the\n Organizations User Guide.
\nACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of\n accounts that you can create in one day.
\nACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your\n account isn't fully active. You must complete the account setup before you\n create an organization.
\nACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number\n of accounts in an organization. If you need more accounts, contact Amazon Web Services Support to\n request an increase in your limit.
\nOr the number of invitations that you tried to send would cause you to exceed\n the limit of accounts in your organization. Send fewer invitations or contact\n Amazon Web Services Support to request an increase in the number of accounts.
\nDeleted and closed accounts still count toward your limit.
\nIf you get this exception when running a command immediately after\n creating the organization, wait one hour and try again. After an hour, if\n the command continues to fail with this error, contact Amazon Web Services Support.
\nCANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot\n register a suspended account as a delegated administrator.
\nCANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register\n the management account of the organization as a delegated administrator for an\n Amazon Web Services service integrated with Organizations. You can designate only a member account as a\n delegated administrator.
\nCANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management\n account. To close the management account for the organization, you must first\n either remove or close all member accounts in the organization. Follow standard\n account closure process using root credentials.
\nCANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an\n account that is registered as a delegated administrator for a service integrated\n with your organization. To complete this operation, you must first deregister\n this account as a delegated administrator.
\nCLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the\n past 30 days.
\nCLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of\n accounts that you can close at a time.
\nCREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an\n organization in the specified region, you must enable all features mode.
\nDELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an\n Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has\n a delegated administrator. To complete this operation, you must first deregister\n any existing delegated administrators for this service.
\nEMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for\n a limited period of time. You must resubmit the request and generate a new\n verfication code.
\nHANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of\n handshakes that you can send in one day.
\nINVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported\n payment method is associated with the account. Amazon Web Services does not support cards\n issued by financial institutions in Russia or Belarus. For more information, see\n Managing your\n Amazon Web Services payments.
\nMASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in\n this organization, you first must migrate the organization's management account\n to the marketplace that corresponds to the management account's address. For\n example, accounts with India addresses must be associated with the AISPL\n marketplace. All accounts in an organization must be associated with the same\n marketplace.
\nMASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services /> Regions\n in China. To create an organization, the master must have a valid business\n license. For more information, contact customer support.
\nMASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must\n first provide a valid contact address and phone number for the management\n account. Then try the operation again.
\nMASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the\n management account must have an associated account in the Amazon Web Services GovCloud\n (US-West) Region. For more information, see Organizations\n in the \n Amazon Web Services GovCloud User Guide.
\nMASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with\n this management account, you first must associate a valid payment instrument,\n such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in\n the Organizations User Guide.
\nMAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to\n register more delegated administrators than allowed for the service principal.\n
\nMAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number\n of policies of a certain type that can be attached to an entity at one\n time.
\nMAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this\n resource.
\nMEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with\n this member account, you first must associate a valid payment instrument, such\n as a credit card, with the account. For more information, see Considerations before removing an account from an organization in\n the Organizations User Guide.
\nMIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy\n from an entity that would cause the entity to have fewer than the minimum number\n of policies of a certain type required.
\nORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation\n that requires the organization to be configured to support all features. An\n organization that supports only consolidated billing features can't perform this\n operation.
\nOU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many\n levels deep.
\nOU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you\n can have in an organization.
\nPOLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger\n than the maximum size.
\nPOLICY_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of policies\n that you can have in an organization.
\nSERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated\n administrator before you enabled service access. Call the\n EnableAWSServiceAccess API first.
TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags\n that are not compliant with the tag policy requirements for this account.
\nWAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, there is a waiting\n period before you can remove it from the organization. If you get an error that\n indicates that a wait period is required, try again in a few days.
\nCreates an Amazon Web Services account that is automatically a member of the organization whose\n credentials made the request. This is an asynchronous request that Amazon Web Services performs in the\n background. Because CreateAccount operates asynchronously, it can return a\n successful completion message even though account initialization might still be in\n progress. You might need to wait a few minutes before you can successfully access the\n account. To check the status of the request, do one of the following:
Use the Id value of the CreateAccountStatus response\n element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.
Check the CloudTrail log for the CreateAccountResult event. For\n information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the\n Organizations User Guide.\n
The user who calls the API to create an account must have the\n organizations:CreateAccount permission. If you enabled all features in\n the organization, Organizations creates the required service-linked role named\n AWSServiceRoleForOrganizations. For more information, see Organizations and Service-Linked Roles in the\n Organizations User Guide.
If the request includes tags, then the requester must have the\n organizations:TagResource permission.
Organizations preconfigures the new member account with a role (named\n OrganizationAccountAccessRole by default) that grants users in the\n management account administrator permissions in the new member account. Principals in\n the management account can assume the role. Organizations clones the company name and address\n information for the new account from the organization's management account.
This operation can be called only from the organization's management account.
\nFor more information about creating accounts, see Creating an Amazon Web Services account in\n Your Organization in the Organizations User Guide.\n
\nWhen you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required for the account to operate\n as a standalone account, such as a payment method and signing the end user\n license agreement (EULA) is not automatically\n collected. If you must remove an account from your organization later, you\n can do so only after you provide the missing information. Follow the steps\n at To leave an organization as a member account in the\n Organizations User Guide.
\nIf you get an exception that indicates that you exceeded your account\n limits for the organization, contact Amazon Web Services Support.
\nIf you get an exception that indicates that the operation failed because\n your organization is still initializing, wait one hour and then try again.\n If the error persists, contact Amazon Web Services Support.
\nUsing CreateAccount to create multiple temporary accounts\n isn't recommended. You can only close an account from the Billing and Cost Management console, and\n you must be signed in as the root user. For information on the requirements\n and process for closing an account, see Closing an\n Amazon Web Services account in the\n Organizations User Guide.
When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting\n Access to Your Billing Information and Tools.
\nCreates an Amazon Web Services account that is automatically a member of the organization whose\n credentials made the request. This is an asynchronous request that Amazon Web Services performs in the\n background. Because CreateAccount operates asynchronously, it can return a\n successful completion message even though account initialization might still be in\n progress. You might need to wait a few minutes before you can successfully access the\n account. To check the status of the request, do one of the following:
Use the Id value of the CreateAccountStatus response\n element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.
Check the CloudTrail log for the CreateAccountResult event. For\n information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the\n Organizations User Guide.
The user who calls the API to create an account must have the\n organizations:CreateAccount permission. If you enabled all features in\n the organization, Organizations creates the required service-linked role named\n AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the\n Organizations User Guide.
If the request includes tags, then the requester must have the\n organizations:TagResource permission.
Organizations preconfigures the new member account with a role (named\n OrganizationAccountAccessRole by default) that grants users in the\n management account administrator permissions in the new member account. Principals in\n the management account can assume the role. Organizations clones the company name and address\n information for the new account from the organization's management account.
This operation can be called only from the organization's management account.
\nFor more information about creating accounts, see Creating\n a member account in your organization in the\n Organizations User Guide.
\nWhen you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required for the account to operate\n as a standalone account, such as a payment method and signing the end user\n license agreement (EULA) is not automatically\n collected. If you must remove an account from your organization later, you\n can do so only after you provide the missing information. For more\n information, see Considerations before removing an account from an organization\n in the Organizations User Guide.
\nIf you get an exception that indicates that you exceeded your account\n limits for the organization, contact Amazon Web Services Support.
\nIf you get an exception that indicates that the operation failed because\n your organization is still initializing, wait one hour and then try again.\n If the error persists, contact Amazon Web Services Support.
\nUsing CreateAccount to create multiple temporary accounts\n isn't recommended. You can only close an account from the Billing and Cost Management console, and\n you must be signed in as the root user. For information on the requirements\n and process for closing an account, see Closing a member\n account in your organization in the\n Organizations User Guide.
When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting access to\n your billing information and tools.
\nThe name of an IAM role that Organizations automatically preconfigures in the new member\n account. This role trusts the management account, allowing users in the management\n account to assume the role, as permitted by the management account administrator. The\n role has administrator permissions in the new member account.
\nIf you don't specify this parameter, the role name defaults to\n OrganizationAccountAccessRole.
For more information about how to use this role to access the member account, see the\n following links:
\n\n Accessing and Administering the Member Accounts in Your\n Organization in the Organizations User Guide\n
\nSteps 2 and 3 in Tutorial:\n Delegate Access Across Amazon Web Services accounts Using IAM Roles in the\n IAM User Guide\n
\nThe regex pattern that \n is used to validate this parameter. The pattern can include uppercase \n letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-
" + "smithy.api#documentation": "The name of an IAM role that Organizations automatically preconfigures in the new member\n account. This role trusts the management account, allowing users in the management\n account to assume the role, as permitted by the management account administrator. The\n role has administrator permissions in the new member account.
\nIf you don't specify this parameter, the role name defaults to\n OrganizationAccountAccessRole.
For more information about how to use this role to access the member account, see the\n following links:
\n\n Creating the OrganizationAccountAccessRole in an invited member\n account in the Organizations User Guide\n
\nSteps 2 and 3 in IAM Tutorial:\n Delegate access across Amazon Web Services accounts using IAM roles in the\n IAM User Guide\n
\nThe regex pattern that \n is used to validate this parameter. The pattern can include uppercase \n letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-
" } }, "IamUserAccessToBilling": { "target": "com.amazonaws.organizations#IAMUserAccessToBilling", "traits": { - "smithy.api#documentation": "If set to ALLOW, the new account enables IAM users to access account\n billing information if they have the required permissions. If set\n to DENY, only the root user of the new account can access account billing\n information. For more information, see Activating\n Access to the Billing and Cost Management Console in the\n Amazon Web Services Billing and Cost Management User Guide.
If you don't specify this parameter, the value defaults to ALLOW, and\n IAM users and roles with the required permissions can access billing information for\n the new account.
If set to ALLOW, the new account enables IAM users to access account\n billing information if they have the required permissions. If set\n to DENY, only the root user of the new account can access account billing\n information. For more information, see About IAM\n access to the Billing and Cost Management console in the\n Amazon Web Services Billing and Cost Management User Guide.
If you don't specify this parameter, the value defaults to ALLOW, and\n IAM users and roles with the required permissions can access billing information for\n the new account.
A structure that contains details about the request to create an account. This\n response structure might not be fully populated when you first receive it because\n account creation is an asynchronous process. You can pass the returned\n CreateAccountStatus ID as a parameter to DescribeCreateAccountStatus to get status about the progress of the\n request at later times. You can also check the CloudTrail log for the\n CreateAccountResult event. For more information, see Monitoring the\n Activity in Your Organization in the\n Organizations User Guide.
A structure that contains details about the request to create an account. This\n response structure might not be fully populated when you first receive it because\n account creation is an asynchronous process. You can pass the returned\n CreateAccountStatus ID as a parameter to DescribeCreateAccountStatus to get status about the progress of the\n request at later times. You can also check the CloudTrail log for the\n CreateAccountResult event. For more information, see Logging and monitoring in Organizations in the\n Organizations User Guide.
This action is available if all of the following are true:
\nYou're authorized to create accounts in the Amazon Web Services GovCloud (US) Region. For\n more information on the Amazon Web Services GovCloud (US) Region, see the \n Amazon Web Services GovCloud User Guide.\n
\nYou already have an account in the Amazon Web Services GovCloud (US) Region that is paired\n with a management account of an organization in the commercial Region.
\nYou call this action from the management account of your organization in the\n commercial Region.
\nYou have the organizations:CreateGovCloudAccount permission.\n
Organizations automatically creates the required service-linked role named\n AWSServiceRoleForOrganizations. For more information, see Organizations and Service-Linked Roles in the\n Organizations User Guide.\n
Amazon Web Services automatically enables CloudTrail for Amazon Web Services GovCloud (US) accounts, but you should also\n do the following:
\nVerify that CloudTrail is enabled to store logs.
\nCreate an Amazon S3 bucket for CloudTrail log storage.
\nFor more information, see Verifying CloudTrail Is\n Enabled in the Amazon Web Services GovCloud User Guide.\n
\nIf the request includes tags, then the requester must have the\n organizations:TagResource permission. The tags are attached to the\n commercial account associated with the GovCloud account, rather than the GovCloud\n account itself. To add tags to the GovCloud account, call the TagResource operation in the GovCloud Region after the new GovCloud\n account exists.
You call this action from the management account of your organization in the\n commercial Region to create a standalone Amazon Web Services account in the Amazon Web Services GovCloud (US)\n Region. After the account is created, the management account of an organization in the\n Amazon Web Services GovCloud (US) Region can invite it to that organization. For more information on\n inviting standalone accounts in the Amazon Web Services GovCloud (US) to join an organization, see\n Organizations in the\n Amazon Web Services GovCloud User Guide.\n
\nCalling CreateGovCloudAccount is an asynchronous request that Amazon Web Services\n performs in the background. Because CreateGovCloudAccount operates\n asynchronously, it can return a successful completion message even though account\n initialization might still be in progress. You might need to wait a few minutes before\n you can successfully access the account. To check the status of the request, do one of\n the following:
Use the OperationId response element from this operation to\n provide as a parameter to the DescribeCreateAccountStatus\n operation.
Check the CloudTrail log for the CreateAccountResult event. For\n information on using CloudTrail with Organizations, see Monitoring the Activity in Your\n Organization in the Organizations User Guide.\n
When you call the CreateGovCloudAccount action, you create two accounts:\n a standalone account in the Amazon Web Services GovCloud (US) Region and an associated account in the\n commercial Region for billing and support purposes. The account in the commercial Region\n is automatically a member of the organization whose credentials made the request. Both\n accounts are associated with the same email address.
A role is created in the new account in the commercial Region that allows the\n management account in the organization in the commercial Region to assume it. An Amazon Web Services\n GovCloud (US) account is then created and associated with the commercial account that\n you just created. A role is also created in the new Amazon Web Services GovCloud (US) account that can\n be assumed by the Amazon Web Services GovCloud (US) account that is associated with the management\n account of the commercial organization. For more information and to view a diagram that\n explains how account access works, see Organizations in the\n Amazon Web Services GovCloud User Guide.\n
\nFor more information about creating accounts, see Creating\n an Amazon Web Services account in Your Organization in the\n Organizations User Guide.\n
\nWhen you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required for the account to operate as\n a standalone account is not automatically collected.\n This includes a payment method and signing the end user license agreement\n (EULA). If you must remove an account from your organization later, you can\n do so only after you provide the missing information. Follow the steps at\n To leave an organization as a member account in the\n Organizations User Guide.\n
\nIf you get an exception that indicates that you exceeded your account\n limits for the organization, contact Amazon Web Services Support.
\nIf you get an exception that indicates that the operation failed because\n your organization is still initializing, wait one hour and then try again.\n If the error persists, contact Amazon Web Services Support.
\nUsing CreateGovCloudAccount to create multiple temporary\n accounts isn't recommended. You can only close an account from the Amazon Web Services\n Billing and Cost Management console, and you must be signed in as the root user. For information on\n the requirements and process for closing an account, see Closing an\n Amazon Web Services account in the\n Organizations User Guide.
When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting\n Access to Your Billing Information and Tools.
\nThis action is available if all of the following are true:
\nYou're authorized to create accounts in the Amazon Web Services GovCloud (US) Region. For\n more information on the Amazon Web Services GovCloud (US) Region, see the \n Amazon Web Services GovCloud User Guide.\n
\nYou already have an account in the Amazon Web Services GovCloud (US) Region that is paired\n with a management account of an organization in the commercial Region.
\nYou call this action from the management account of your organization in the\n commercial Region.
\nYou have the organizations:CreateGovCloudAccount permission.\n
Organizations automatically creates the required service-linked role named\n AWSServiceRoleForOrganizations. For more information, see Organizations and service-linked roles in the\n Organizations User Guide.
Amazon Web Services automatically enables CloudTrail for Amazon Web Services GovCloud (US) accounts, but you should also\n do the following:
\nVerify that CloudTrail is enabled to store logs.
\nCreate an Amazon S3 bucket for CloudTrail log storage.
\nFor more information, see Verifying CloudTrail Is\n Enabled in the Amazon Web Services GovCloud User Guide.\n
\nIf the request includes tags, then the requester must have the\n organizations:TagResource permission. The tags are attached to the\n commercial account associated with the GovCloud account, rather than the GovCloud\n account itself. To add tags to the GovCloud account, call the TagResource operation in the GovCloud Region after the new GovCloud\n account exists.
You call this action from the management account of your organization in the\n commercial Region to create a standalone Amazon Web Services account in the Amazon Web Services GovCloud (US)\n Region. After the account is created, the management account of an organization in the\n Amazon Web Services GovCloud (US) Region can invite it to that organization. For more information on\n inviting standalone accounts in the Amazon Web Services GovCloud (US) to join an organization, see\n Organizations in the\n Amazon Web Services GovCloud User Guide.
\nCalling CreateGovCloudAccount is an asynchronous request that Amazon Web Services\n performs in the background. Because CreateGovCloudAccount operates\n asynchronously, it can return a successful completion message even though account\n initialization might still be in progress. You might need to wait a few minutes before\n you can successfully access the account. To check the status of the request, do one of\n the following:
Use the OperationId response element from this operation to\n provide as a parameter to the DescribeCreateAccountStatus\n operation.
Check the CloudTrail log for the CreateAccountResult event. For\n information on using CloudTrail with Organizations, see Logging and\n monitoring in Organizations in the\n Organizations User Guide.
When you call the CreateGovCloudAccount action, you create two accounts:\n a standalone account in the Amazon Web Services GovCloud (US) Region and an associated account in the\n commercial Region for billing and support purposes. The account in the commercial Region\n is automatically a member of the organization whose credentials made the request. Both\n accounts are associated with the same email address.
A role is created in the new account in the commercial Region that allows the\n management account in the organization in the commercial Region to assume it. An Amazon Web Services\n GovCloud (US) account is then created and associated with the commercial account that\n you just created. A role is also created in the new Amazon Web Services GovCloud (US) account that can\n be assumed by the Amazon Web Services GovCloud (US) account that is associated with the management\n account of the commercial organization. For more information and to view a diagram that\n explains how account access works, see Organizations in the\n Amazon Web Services GovCloud User Guide.
\nFor more information about creating accounts, see Creating\n a member account in your organization in the\n Organizations User Guide.
\nWhen you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required for the account to operate as\n a standalone account is not automatically collected.\n This includes a payment method and signing the end user license agreement\n (EULA). If you must remove an account from your organization later, you can\n do so only after you provide the missing information. For more information,\n see Considerations before removing an account from an organization\n in the Organizations User Guide.
\nIf you get an exception that indicates that you exceeded your account\n limits for the organization, contact Amazon Web Services Support.
\nIf you get an exception that indicates that the operation failed because\n your organization is still initializing, wait one hour and then try again.\n If the error persists, contact Amazon Web Services Support.
\nUsing CreateGovCloudAccount to create multiple temporary\n accounts isn't recommended. You can only close an account from the Amazon Web Services\n Billing and Cost Management console, and you must be signed in as the root user. For information on\n the requirements and process for closing an account, see Closing a member\n account in your organization in the\n Organizations User Guide.
When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting\n access to your billing information and tools.
\n(Optional)
\nThe name of an IAM role that Organizations automatically preconfigures in the new member\n accounts in both the Amazon Web Services GovCloud (US) Region and in the commercial Region. This role\n trusts the management account, allowing users in the management account to assume the\n role, as permitted by the management account administrator. The role has administrator\n permissions in the new member account.
\nIf you don't specify this parameter, the role name defaults to\n OrganizationAccountAccessRole.
For more information about how to use this role to access the member account, see\n Accessing and Administering the Member Accounts in Your Organization in the\n Organizations User Guide and steps 2 and 3 in Tutorial: Delegate Access Across Amazon Web Services accounts Using IAM Roles in the\n IAM User Guide.\n
\nThe regex pattern that \n is used to validate this parameter. The pattern can include uppercase \n letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-
" + "smithy.api#documentation": "(Optional)
\nThe name of an IAM role that Organizations automatically preconfigures in the new member\n accounts in both the Amazon Web Services GovCloud (US) Region and in the commercial Region. This role\n trusts the management account, allowing users in the management account to assume the\n role, as permitted by the management account administrator. The role has administrator\n permissions in the new member account.
\nIf you don't specify this parameter, the role name defaults to\n OrganizationAccountAccessRole.
For more information about how to use this role to access the member account, see the\n following links:
\n\n Creating the OrganizationAccountAccessRole in an invited member\n account in the Organizations User Guide\n
\nSteps 2 and 3 in IAM Tutorial:\n Delegate access across Amazon Web Services accounts using IAM roles in the\n IAM User Guide\n
\nThe regex pattern that \n is used to validate this parameter. The pattern can include uppercase \n letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-
" } }, "IamUserAccessToBilling": { "target": "com.amazonaws.organizations#IAMUserAccessToBilling", "traits": { - "smithy.api#documentation": "If set to ALLOW, the new linked account in the commercial Region enables\n IAM users to access account billing information if they have the\n required permissions. If set to DENY, only the root user of the new account\n can access account billing information. For more information, see Activating\n Access to the Billing and Cost Management Console in the\n Amazon Web Services Billing and Cost Management User Guide.\n
If you don't specify this parameter, the value defaults to ALLOW, and\n IAM users and roles with the required permissions can access billing information for\n the new account.
If set to ALLOW, the new linked account in the commercial Region enables\n IAM users to access account billing information if they have the\n required permissions. If set to DENY, only the root user of the new account\n can access account billing information. For more information, see About IAM\n access to the Billing and Cost Management console in the\n Amazon Web Services Billing and Cost Management User Guide.
If you don't specify this parameter, the value defaults to ALLOW, and\n IAM users and roles with the required permissions can access billing information for\n the new account.
Creates an Amazon Web Services organization. The account whose user is calling the\n CreateOrganization operation automatically becomes the management account of the new organization.
This operation must be called using credentials from the account that is to become the\n new organization's management account. The principal must also have the relevant IAM\n permissions.
\nBy default (or if you set the FeatureSet parameter to ALL),\n the new organization is created with all features enabled and service control policies\n automatically enabled in the root. If you instead choose to create the organization\n supporting only the consolidated billing features by setting the FeatureSet\n parameter to CONSOLIDATED_BILLING\", no policy types are enabled by default,\n and you can't use organization policies
Creates an Amazon Web Services organization. The account whose user is calling the\n CreateOrganization operation automatically becomes the management account of the new organization.
This operation must be called using credentials from the account that is to become the\n new organization's management account. The principal must also have the relevant IAM\n permissions.
\nBy default (or if you set the FeatureSet parameter to ALL),\n the new organization is created with all features enabled and service control policies\n automatically enabled in the root. If you instead choose to create the organization\n supporting only the consolidated billing features by setting the FeatureSet\n parameter to CONSOLIDATED_BILLING, no policy types are enabled by default\n and you can't use organization policies.
Specifies the feature set supported by the new organization. Each feature set supports\n different levels of functionality.
\n\n CONSOLIDATED_BILLING: All member accounts have their bills\n consolidated to and paid by the management account. For more information, see\n Consolidated billing in the\n Organizations User Guide.\n
The consolidated billing feature subset isn't available for organizations in\n the Amazon Web Services GovCloud (US) Region.
\n\n ALL: In addition to all the features supported by the\n consolidated billing feature set, the management account can also apply any\n policy type to any member account in the organization. For more information, see\n All\n features in the Organizations User Guide.\n
Specifies the feature set supported by the new organization. Each feature set supports\n different levels of functionality.
\n\n CONSOLIDATED_BILLING: All member accounts have their bills\n consolidated to and paid by the management account. For more information, see\n Consolidated billing in the\n Organizations User Guide.
The consolidated billing feature subset isn't available for organizations in\n the Amazon Web Services GovCloud (US) Region.
\n\n ALL: In addition to all the features supported by the\n consolidated billing feature set, the management account can also apply any\n policy type to any member account in the organization. For more information, see\n All\n features in the Organizations User Guide.
Creates an organizational unit (OU) within a root or parent OU. An OU is a container\n for accounts that enables you to organize your accounts to apply policies according to\n your business requirements. The number of levels deep that you can nest OUs is dependent\n upon the policy types enabled for that root. For service control policies, the limit is\n five.
\nFor more information about OUs, see Managing Organizational Units in the\n Organizations User Guide.\n
\nIf the request includes tags, then the requester must have the\n organizations:TagResource permission.
This operation can be called only from the organization's management account.
", + "smithy.api#documentation": "Creates an organizational unit (OU) within a root or parent OU. An OU is a container\n for accounts that enables you to organize your accounts to apply policies according to\n your business requirements. The number of levels deep that you can nest OUs is dependent\n upon the policy types enabled for that root. For service control policies, the limit is\n five.
\nFor more information about OUs, see Managing organizational units (OUs) in the\n Organizations User Guide.
\nIf the request includes tags, then the requester must have the\n organizations:TagResource permission.
This operation can be called only from the organization's management account.
", "smithy.api#examples": [ { "title": "To create a new organization unit", @@ -2807,7 +2807,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a policy of a specified type that you can attach to a root, an organizational\n unit (OU), or an individual Amazon Web Services account.
\nFor more information about policies and their use, see Managing\n Organization Policies.
\nIf the request includes tags, then the requester must have the\n organizations:TagResource permission.
This operation can be called only from the organization's management account.
", + "smithy.api#documentation": "Creates a policy of a specified type that you can attach to a root, an organizational\n unit (OU), or an individual Amazon Web Services account.
\nFor more information about policies and their use, see Managing\n Organizations policies.
\nIf the request includes tags, then the requester must have the\n organizations:TagResource permission.
This operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
", "smithy.api#examples": [ { "title": "To create a service control policy", @@ -3232,7 +3232,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified policy from your organization. Before you perform this\n operation, you must first detach the policy from all organizational units (OUs), roots,\n and accounts.
\nThis operation can be called only from the organization's management account.
", + "smithy.api#documentation": "Deletes the specified policy from your organization. Before you perform this\n operation, you must first detach the policy from all organizational units (OUs), roots,\n and accounts.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
", "smithy.api#examples": [ { "title": "To delete a policy", @@ -3559,7 +3559,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the contents of the effective policy for specified policy type and account.\n The effective policy is the aggregation of any policies of the specified type that the\n account inherits, plus any policy of that type that is directly attached to the\n account.
\nThis operation applies only to policy types other than service\n control policies (SCPs).
\nFor more information about policy inheritance, see How Policy Inheritance\n Works in the Organizations User Guide.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
" + "smithy.api#documentation": "Returns the contents of the effective policy for specified policy type and account.\n The effective policy is the aggregation of any policies of the specified type that the\n account inherits, plus any policy of that type that is directly attached to the\n account.
\nThis operation applies only to policy types other than service\n control policies (SCPs).
\nFor more information about policy inheritance, see Understanding management policy\n inheritance in the Organizations User Guide.
\nThis operation can be called from any account in the organization.
" } }, "com.amazonaws.organizations#DescribeEffectivePolicyRequest": { @@ -3966,7 +3966,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves information about a resource policy.
\nYou can only call this operation from the organization's management account or by a\n member account that is a delegated administrator for an Amazon Web Services service.
" + "smithy.api#documentation": "Retrieves information about a resource policy.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
" } }, "com.amazonaws.organizations#DescribeResourcePolicyResponse": { @@ -4043,7 +4043,7 @@ } ], "traits": { - "smithy.api#documentation": "Detaches a policy from a target root, organizational unit (OU), or account.
\nIf the policy being detached is a service control policy (SCP), the changes to\n permissions for Identity and Access Management (IAM) users and roles in affected accounts are\n immediate.
\nEvery root, OU, and account must have at least one SCP attached. If you want to\n replace the default FullAWSAccess policy with an SCP that limits the\n permissions that can be delegated, you must attach the replacement SCP before you can\n remove the default SCP. This is the authorization strategy of an \"allow list\". If you instead attach a second SCP and\n leave the FullAWSAccess SCP still attached, and specify \"Effect\":\n \"Deny\" in the second SCP to override the \"Effect\": \"Allow\" in\n the FullAWSAccess policy (or any other attached SCP), you're using the\n authorization strategy of a \"deny list\".
This operation can be called only from the organization's management account.
", + "smithy.api#documentation": "Detaches a policy from a target root, organizational unit (OU), or account.
\nIf the policy being detached is a service control policy (SCP), the changes to\n permissions for Identity and Access Management (IAM) users and roles in affected accounts are\n immediate.
\nEvery root, OU, and account must have at least one SCP attached. If you want to\n replace the default FullAWSAccess policy with an SCP that limits the\n permissions that can be delegated, you must attach the replacement SCP before you can\n remove the default SCP. This is the authorization strategy of an \"allow list\". If you instead attach a second SCP and\n leave the FullAWSAccess SCP still attached, and specify \"Effect\":\n \"Deny\" in the second SCP to override the \"Effect\": \"Allow\" in\n the FullAWSAccess policy (or any other attached SCP), you're using the\n authorization strategy of a \"deny list\".
This operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
", "smithy.api#examples": [ { "title": "To detach a policy from a root, OU, or account", @@ -4113,7 +4113,7 @@ } ], "traits": { - "smithy.api#documentation": "Disables the integration of an Amazon Web Services service (the service that is specified by\n ServicePrincipal) with Organizations. When you disable integration, the\n specified service no longer can create a service-linked role in\n new accounts in your organization. This means the service can't\n perform operations on your behalf on any new accounts in your organization. The service\n can still perform operations in older accounts until the service completes its clean-up\n from Organizations.
We \n strongly recommend\n that\n you don't use this command to disable integration between Organizations and the specified\n Amazon Web Services service. Instead, use the console or commands that are provided by the\n specified service. This lets the trusted service perform any required initialization\n when enabling trusted access, such as creating any required resources and any\n required clean up of resources when disabling trusted access.
\nFor information about how to disable trusted service access to your organization\n using the trusted service, see the Learn more link\n under the Supports Trusted Access column at Amazon Web Services services that you can use with Organizations. on this page.
\nIf you disable access by using this command, it causes the following actions to\n occur:
\nThe service can no longer create a service-linked role in the accounts in\n your organization. This means that the service can't perform operations on\n your behalf on any new accounts in your organization. The service can still\n perform operations in older accounts until the service completes its\n clean-up from Organizations.
\nThe service can no longer perform tasks in the member accounts in the\n organization, unless those operations are explicitly permitted by the IAM\n policies that are attached to your roles. This includes any data aggregation\n from the member accounts to the management account, or to a delegated\n administrator account, where relevant.
\nSome services detect this and clean up any remaining data or resources\n related to the integration, while other services stop accessing the\n organization but leave any historical data and configuration in place to\n support a possible re-enabling of the integration.
\nUsing the other service's console or commands to disable the integration ensures\n that the other service is aware that it can clean up any resources that are required\n only for the integration. How the service cleans up its resources in the\n organization's accounts depends on that service. For more information, see the\n documentation for the other Amazon Web Services service.
\nAfter you perform the DisableAWSServiceAccess operation, the specified\n service can no longer perform operations in your organization's accounts
For more information about integrating other services with Organizations, including the\n list of services that work with Organizations, see Integrating Organizations with Other\n Amazon Web Services Services in the Organizations User Guide.\n
\nThis operation can be called only from the organization's management account.
" + "smithy.api#documentation": "Disables the integration of an Amazon Web Services service (the service that is specified by\n ServicePrincipal) with Organizations. When you disable integration, the\n specified service no longer can create a service-linked role in\n new accounts in your organization. This means the service can't\n perform operations on your behalf on any new accounts in your organization. The service\n can still perform operations in older accounts until the service completes its clean-up\n from Organizations.
We \n strongly recommend\n that\n you don't use this command to disable integration between Organizations and the specified\n Amazon Web Services service. Instead, use the console or commands that are provided by the\n specified service. This lets the trusted service perform any required initialization\n when enabling trusted access, such as creating any required resources and any\n required clean up of resources when disabling trusted access.
\nFor information about how to disable trusted service access to your organization\n using the trusted service, see the Learn more link\n under the Supports Trusted Access column at Amazon Web Services services that you can use with Organizations. on this page.
\nIf you disable access by using this command, it causes the following actions to\n occur:
\nThe service can no longer create a service-linked role in the accounts in\n your organization. This means that the service can't perform operations on\n your behalf on any new accounts in your organization. The service can still\n perform operations in older accounts until the service completes its\n clean-up from Organizations.
\nThe service can no longer perform tasks in the member accounts in the\n organization, unless those operations are explicitly permitted by the IAM\n policies that are attached to your roles. This includes any data aggregation\n from the member accounts to the management account, or to a delegated\n administrator account, where relevant.
\nSome services detect this and clean up any remaining data or resources\n related to the integration, while other services stop accessing the\n organization but leave any historical data and configuration in place to\n support a possible re-enabling of the integration.
\nUsing the other service's console or commands to disable the integration ensures\n that the other service is aware that it can clean up any resources that are required\n only for the integration. How the service cleans up its resources in the\n organization's accounts depends on that service. For more information, see the\n documentation for the other Amazon Web Services service.
\nAfter you perform the DisableAWSServiceAccess operation, the specified\n service can no longer perform operations in your organization's accounts
For more information about integrating other services with Organizations, including the\n list of services that work with Organizations, see Using Organizations with other\n Amazon Web Services services in the Organizations User Guide.
\nThis operation can be called only from the organization's management account.
" } }, "com.amazonaws.organizations#DisableAWSServiceAccessRequest": { @@ -4175,7 +4175,7 @@ } ], "traits": { - "smithy.api#documentation": "Disables an organizational policy type in a root. A policy of a certain type can be\n attached to entities in a root only if that type is enabled in the root. After you\n perform this operation, you no longer can attach policies of the specified type to that\n root or to any organizational unit (OU) or account in that root. You can undo this by\n using the EnablePolicyType operation.
\nThis is an asynchronous request that Amazon Web Services performs in the background. If you disable\n a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. Amazon Web Services recommends that you\n first use ListRoots to see the status of policy types for a specified\n root, and then use this operation.
\nThis operation can be called only from the organization's management account.
\nTo view the status of available policy types in the organization, use DescribeOrganization.
", + "smithy.api#documentation": "Disables an organizational policy type in a root. A policy of a certain type can be\n attached to entities in a root only if that type is enabled in the root. After you\n perform this operation, you no longer can attach policies of the specified type to that\n root or to any organizational unit (OU) or account in that root. You can undo this by\n using the EnablePolicyType operation.
\nThis is an asynchronous request that Amazon Web Services performs in the background. If you disable\n a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. Amazon Web Services recommends that you\n first use ListRoots to see the status of policy types for a specified\n root, and then use this operation.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
\nTo view the status of available policy types in the organization, use DescribeOrganization.
", "smithy.api#examples": [ { "title": "To disable a policy type in a root", @@ -4410,7 +4410,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables the integration of an Amazon Web Services service (the service that is specified by\n ServicePrincipal) with Organizations. When you enable integration, you allow\n the specified service to create a service-linked role in\n all the accounts in your organization. This allows the service to perform operations on\n your behalf in your organization and its accounts.
We recommend that you enable integration between Organizations and the specified Amazon Web Services\n service by using the console or commands that are provided by the specified service.\n Doing so ensures that the service is aware that it can create the resources that are\n required for the integration. How the service creates those resources in the\n organization's accounts depends on that service. For more information, see the\n documentation for the other Amazon Web Services service.
\nFor more information about enabling services to integrate with Organizations, see Integrating\n Organizations with Other Amazon Web Services Services in the\n Organizations User Guide.\n
\nYou can only call this operation from the organization's management account and only\n if the organization has enabled all\n features.
" + "smithy.api#documentation": "Enables the integration of an Amazon Web Services service (the service that is specified by\n ServicePrincipal) with Organizations. When you enable integration, you allow\n the specified service to create a service-linked role in\n all the accounts in your organization. This allows the service to perform operations on\n your behalf in your organization and its accounts.
We recommend that you enable integration between Organizations and the specified Amazon Web Services\n service by using the console or commands that are provided by the specified service.\n Doing so ensures that the service is aware that it can create the resources that are\n required for the integration. How the service creates those resources in the\n organization's accounts depends on that service. For more information, see the\n documentation for the other Amazon Web Services service.
\nFor more information about enabling services to integrate with Organizations, see Using\n Organizations with other Amazon Web Services services in the\n Organizations User Guide.
\nYou can only call this operation from the organization's management account and only\n if the organization has enabled all\n features.
" } }, "com.amazonaws.organizations#EnableAWSServiceAccessRequest": { @@ -4460,7 +4460,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables all features in an organization. This enables the use of organization policies\n that can restrict the services and actions that can be called in each account. Until you\n enable all features, you have access only to consolidated billing, and you can't use any\n of the advanced account administration features that Organizations supports. For more\n information, see Enabling All Features in Your Organization in the\n Organizations User Guide.\n
\nThis operation is required only for organizations that were created explicitly\n with only the consolidated billing features enabled. Calling this operation sends a\n handshake to every invited account in the organization. The feature set change can\n be finalized and the additional features enabled only after all administrators in\n the invited accounts approve the change by accepting the handshake.
\nAfter you enable all features, you can separately enable or disable individual policy\n types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use\n ListRoots.
\nAfter all invited member accounts accept the handshake, you finalize the feature set\n change by accepting the handshake that contains \"Action\":\n \"ENABLE_ALL_FEATURES\". This completes the change.
After you enable all features in your organization, the management account in the\n organization can apply policies on all member accounts. These policies can restrict what\n users and even administrators in those accounts can do. The management account can apply\n policies that prevent accounts from leaving the organization. Ensure that your account\n administrators are aware of this.
\nThis operation can be called only from the organization's management account.
", + "smithy.api#documentation": "Enables all features in an organization. This enables the use of organization policies\n that can restrict the services and actions that can be called in each account. Until you\n enable all features, you have access only to consolidated billing, and you can't use any\n of the advanced account administration features that Organizations supports. For more\n information, see Enabling all features in your organization in the\n Organizations User Guide.
\nThis operation is required only for organizations that were created explicitly\n with only the consolidated billing features enabled. Calling this operation sends a\n handshake to every invited account in the organization. The feature set change can\n be finalized and the additional features enabled only after all administrators in\n the invited accounts approve the change by accepting the handshake.
\nAfter you enable all features, you can separately enable or disable individual policy\n types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use\n ListRoots.
\nAfter all invited member accounts accept the handshake, you finalize the feature set\n change by accepting the handshake that contains \"Action\":\n \"ENABLE_ALL_FEATURES\". This completes the change.
After you enable all features in your organization, the management account in the\n organization can apply policies on all member accounts. These policies can restrict what\n users and even administrators in those accounts can do. The management account can apply\n policies that prevent accounts from leaving the organization. Ensure that your account\n administrators are aware of this.
\nThis operation can be called only from the organization's management account.
", "smithy.api#examples": [ { "title": "To enable all features in an organization", @@ -4559,7 +4559,7 @@ } ], "traits": { - "smithy.api#documentation": "Enables a policy type in a root. After you enable a policy type in a root, you can\n attach policies of that type to the root, any organizational unit (OU), or account in\n that root. You can undo this by using the DisablePolicyType\n operation.
\nThis is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services\n recommends that you first use ListRoots to see the status of policy\n types for a specified root, and then use this operation.
\nThis operation can be called only from the organization's management account.
\nYou can enable a policy type in a root only if that policy type is available in the\n organization. To view the status of available policy types in the organization, use\n DescribeOrganization.
", + "smithy.api#documentation": "Enables a policy type in a root. After you enable a policy type in a root, you can\n attach policies of that type to the root, any organizational unit (OU), or account in\n that root. You can undo this by using the DisablePolicyType\n operation.
\nThis is an asynchronous request that Amazon Web Services performs in the background. Amazon Web Services\n recommends that you first use ListRoots to see the status of policy\n types for a specified root, and then use this operation.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
\nYou can enable a policy type in a root only if that policy type is available in the\n organization. To view the status of available policy types in the organization, use\n DescribeOrganization.
", "smithy.api#examples": [ { "title": "To enable a policy type in a root", @@ -4758,7 +4758,7 @@ } }, "traits": { - "smithy.api#documentation": "The requested operation would violate the constraint identified in the reason\n code.
\nSome of the reasons in the following list might not be applicable to this specific\n API or operation:
\nACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number\n of accounts in an organization. Note that deleted and closed accounts still\n count toward your limit.
\nIf you get this exception immediately after creating the organization,\n wait one hour and try again. If after an hour it continues to fail with this\n error, contact Amazon Web Services Support.
\nALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the\n invited account is already a member of an organization.
\nHANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of\n handshakes that you can send in one day.
\nINVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You can't issue new invitations to\n join an organization while it's in the process of enabling all features. You can\n resume inviting accounts after you finalize the process when all accounts have\n agreed to the change.
\nORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid\n because the organization has already enabled all features.
\nORGANIZATION_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION: The handshake request\n is invalid because the organization has already started the process to enable\n all features.
\nORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the\n account is from a different marketplace than the accounts in the organization.\n For example, accounts with India addresses must be associated with the AISPL\n marketplace. All accounts in an organization must be from the same\n marketplace.
\nORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change\n the membership of an account too quickly after its previous change.
\nPAYMENT_INSTRUMENT_REQUIRED: You can't complete the operation with an account\n that doesn't have a payment instrument, such as a credit card, associated with\n it.
\nThe requested operation would violate the constraint identified in the reason\n code.
\nSome of the reasons in the following list might not be applicable to this specific\n API or operation:
\nACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number\n of accounts in an organization. Note that deleted and closed accounts still\n count toward your limit.
\nIf you get this exception immediately after creating the organization,\n wait one hour and try again. If after an hour it continues to fail with this\n error, contact Amazon Web Services\n Support.
\nALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the\n invited account is already a member of an organization.
\nHANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of\n handshakes that you can send in one day.
\nINVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You can't issue new invitations to\n join an organization while it's in the process of enabling all features. You can\n resume inviting accounts after you finalize the process when all accounts have\n agreed to the change.
\nORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid\n because the organization has already enabled all features.
\nORGANIZATION_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION: The handshake request\n is invalid because the organization has already started the process to enable\n all features.
\nORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the\n account is from a different marketplace than the accounts in the organization.\n For example, accounts with India addresses must be associated with the AISPL\n marketplace. All accounts in an organization must be from the same\n marketplace.
\nORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change\n the membership of an account too quickly after its previous change.
\nPAYMENT_INSTRUMENT_REQUIRED: You can't complete the operation with an account\n that doesn't have a payment instrument, such as a credit card, associated with\n it.
\nSends an invitation to another account to join your organization as a member account.\n Organizations sends email on your behalf to the email address that is associated with the\n other account's owner. The invitation is implemented as a Handshake\n whose details are in the response.
\nYou can invite Amazon Web Services accounts only from the same seller as the management\n account. For example, if your organization's management account was created\n by Amazon Internet Services Pvt. Ltd (AISPL), an Amazon Web Services seller in India, you\n can invite only other AISPL accounts to your organization. You can't combine\n accounts from AISPL and Amazon Web Services or from any other Amazon Web Services seller. For more\n information, see Consolidated\n Billing in India.
\nIf you receive an exception that indicates that you exceeded your account\n limits for the organization or that the operation failed because your\n organization is still initializing, wait one hour and then try again. If the\n error persists after an hour, contact Amazon Web Services Support.
\nIf the request includes tags, then the requester must have the\n organizations:TagResource permission.
This operation can be called only from the organization's management account.
", + "smithy.api#documentation": "Sends an invitation to another account to join your organization as a member account.\n Organizations sends email on your behalf to the email address that is associated with the\n other account's owner. The invitation is implemented as a Handshake\n whose details are in the response.
\nYou can invite Amazon Web Services accounts only from the same seller as the management\n account. For example, if your organization's management account was created\n by Amazon Internet Services Pvt. Ltd (AISPL), an Amazon Web Services seller in India, you\n can invite only other AISPL accounts to your organization. You can't combine\n accounts from AISPL and Amazon Web Services or from any other Amazon Web Services seller. For more\n information, see Consolidated\n billing in India.
\nIf you receive an exception that indicates that you exceeded your account\n limits for the organization or that the operation failed because your\n organization is still initializing, wait one hour and then try again. If the\n error persists after an hour, contact Amazon Web Services Support.
\nIf the request includes tags, then the requester must have the\n organizations:TagResource permission.
This operation can be called only from the organization's management account.
", "smithy.api#examples": [ { "title": "To invite an account to join an organization", @@ -5484,7 +5484,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes a member account from its parent organization. This version of the operation\n is performed by the account that wants to leave. To remove a member account as a user in\n the management account, use RemoveAccountFromOrganization\n instead.
\nThis operation can be called only from a member account in the organization.
\nThe management account in an organization with all features enabled can\n set service control policies (SCPs) that can restrict what administrators of\n member accounts can do. This includes preventing them from successfully\n calling LeaveOrganization and leaving the organization.
You can leave an organization as a member account only if the account is\n configured with the information required to operate as a standalone account.\n When you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required of standalone accounts is\n not automatically collected. For each account that\n you want to make standalone, you must perform the following steps. If any of\n the steps are already completed for this account, that step doesn't\n appear.
\nChoose a support plan
\nProvide and verify the required contact information
\nProvide a current payment method
\nAmazon Web Services uses the payment method to charge for any billable (not free tier)\n Amazon Web Services activity that occurs while the account isn't attached to an\n organization. Follow the steps at To leave an organization when all required account information has not\n yet been provided in the\n Organizations User Guide.\n
\nThe account that you want to leave must not be a delegated administrator\n account for any Amazon Web Services service enabled for your organization. If the account\n is a delegated administrator, you must first change the delegated\n administrator account to another account that is remaining in the\n organization.
\nYou can leave an organization only after you enable IAM user access to\n billing in your account. For more information, see Activating Access to the Billing and Cost Management Console in the\n Amazon Web Services Billing and Cost Management User Guide.\n
\nAfter the account leaves the organization, all tags that were attached to\n the account object in the organization are deleted. Amazon Web Services accounts outside\n of an organization do not support tags.
\nA newly created account has a waiting period before it can be removed from\n its organization. If you get an error that indicates that a wait period is\n required, then try again in a few days.
\nRemoves a member account from its parent organization. This version of the operation\n is performed by the account that wants to leave. To remove a member account as a user in\n the management account, use RemoveAccountFromOrganization\n instead.
\nThis operation can be called only from a member account in the organization.
\nThe management account in an organization with all features enabled can\n set service control policies (SCPs) that can restrict what administrators of\n member accounts can do. This includes preventing them from successfully\n calling LeaveOrganization and leaving the organization.
You can leave an organization as a member account only if the account is\n configured with the information required to operate as a standalone account.\n When you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required of standalone accounts is\n not automatically collected. For each account that\n you want to make standalone, you must perform the following steps. If any of\n the steps are already completed for this account, that step doesn't\n appear.
\nChoose a support plan
\nProvide and verify the required contact information
\nProvide a current payment method
\nAmazon Web Services uses the payment method to charge for any billable (not free tier)\n Amazon Web Services activity that occurs while the account isn't attached to an\n organization. For more information, see Considerations before removing an account from an organization\n in the Organizations User Guide.
\nThe account that you want to leave must not be a delegated administrator\n account for any Amazon Web Services service enabled for your organization. If the account\n is a delegated administrator, you must first change the delegated\n administrator account to another account that is remaining in the\n organization.
\nYou can leave an organization only after you enable IAM user access to\n billing in your account. For more information, see About IAM\n access to the Billing and Cost Management console in the\n Amazon Web Services Billing and Cost Management User Guide.
\nAfter the account leaves the organization, all tags that were attached to\n the account object in the organization are deleted. Amazon Web Services accounts outside\n of an organization do not support tags.
\nA newly created account has a waiting period before it can be removed from\n its organization. If you get an error that indicates that a wait period is\n required, then try again in a few days.
\nIf you are using an organization principal to call\n LeaveOrganization across multiple accounts, you can only do\n this up to 5 accounts per second in a single organization.
Returns a list of the Amazon Web Services services that you enabled to integrate with your\n organization. After a service on this list creates the resources that it requires for\n the integration, it can perform operations on your organization and its accounts.
\nFor more information about integrating other services with Organizations, including the\n list of services that currently work with Organizations, see Integrating Organizations with Other\n Amazon Web Services Services in the Organizations User Guide.\n
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
", + "smithy.api#documentation": "Returns a list of the Amazon Web Services services that you enabled to integrate with your\n organization. After a service on this list creates the resources that it requires for\n the integration, it can perform operations on your organization and its accounts.
\nFor more information about integrating other services with Organizations, including the\n list of services that currently work with Organizations, see Using Organizations with other\n Amazon Web Services services in the Organizations User Guide.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -7215,7 +7215,7 @@ } }, "traits": { - "smithy.api#documentation": "The provided policy document doesn't meet the requirements of the specified policy\n type. For example, the syntax might be incorrect. For details about service control\n policy syntax, see Service Control Policy\n Syntax in the Organizations User Guide.\n
", + "smithy.api#documentation": "The provided policy document doesn't meet the requirements of the specified policy\n type. For example, the syntax might be incorrect. For details about service control\n policy syntax, see SCP syntax in the\n Organizations User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -7354,7 +7354,7 @@ "FeatureSet": { "target": "com.amazonaws.organizations#OrganizationFeatureSet", "traits": { - "smithy.api#documentation": "Specifies the functionality that currently is available to the organization. If set to\n \"ALL\", then all features are enabled and policies can be applied to accounts in the\n organization. If set to \"CONSOLIDATED_BILLING\", then only consolidated billing\n functionality is available. For more information, see Enabling All Features\n in Your Organization in the Organizations User Guide.
" + "smithy.api#documentation": "Specifies the functionality that currently is available to the organization. If set to\n \"ALL\", then all features are enabled and policies can be applied to accounts in the\n organization. If set to \"CONSOLIDATED_BILLING\", then only consolidated billing\n functionality is available. For more information, see Enabling all features\n in your organization in the Organizations User Guide.
" } }, "MasterAccountArn": { @@ -7423,7 +7423,7 @@ } }, "traits": { - "smithy.api#documentation": "The organization isn't empty. To delete an organization, you must first remove all\n accounts except the management account, delete all OUs, and delete all policies.
", + "smithy.api#documentation": "The organization isn't empty. To delete an organization, you must first remove all\n accounts except the management account.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -7844,7 +7844,7 @@ } }, "traits": { - "smithy.api#documentation": "You can't use the specified policy type with the feature set currently enabled for\n this organization. For example, you can enable SCPs only after you enable all features\n in the organization. For more information, see Managing\n Organizations Policiesin the Organizations User Guide.\n
", + "smithy.api#documentation": "You can't use the specified policy type with the feature set currently enabled for\n this organization. For example, you can enable SCPs only after you enable all features\n in the organization. For more information, see Managing\n Organizations policiesin the Organizations User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -7857,7 +7857,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified policy type isn't currently enabled in this root. You can't attach\n policies of the specified type to entities in a root until you enable that type in the\n root. For more information, see Enabling All Features\n in Your Organization in the Organizations User Guide.\n
", + "smithy.api#documentation": "The specified policy type isn't currently enabled in this root. You can't attach\n policies of the specified type to entities in a root until you enable that type in the\n root. For more information, see Enabling all features\n in your organization in the Organizations User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -7955,7 +7955,7 @@ "Content": { "target": "com.amazonaws.organizations#ResourcePolicyContent", "traits": { - "smithy.api#documentation": "If provided, the new content for the resource policy. The text must be correctly\n formatted JSON that complies with the syntax for the resource policy's type. For more\n information, see Service Control Policy Syntax in the\n Organizations User Guide.\n
", + "smithy.api#documentation": "If provided, the new content for the resource policy. The text must be correctly\n formatted JSON that complies with the syntax for the resource policy's type. For more\n information, see SCP syntax in the\n Organizations User Guide.
", "smithy.api#required": {} } }, @@ -8088,7 +8088,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specified account from the organization.
\nThe removed account becomes a standalone account that isn't a member of any\n organization. It's no longer subject to any policies and is responsible for its own bill\n payments. The organization's management account is no longer charged for any expenses\n accrued by the member account after it's removed from the organization.
\nThis operation can be called only from the organization's management account. Member accounts can remove themselves with LeaveOrganization instead.
\nYou can remove an account from your organization only if the account is\n configured with the information required to operate as a standalone account.\n When you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required of standalone accounts is\n not automatically collected. For an account that\n you want to make standalone, you must choose a support plan, provide and\n verify the required contact information, and provide a current payment\n method. Amazon Web Services uses the payment method to charge for any billable (not free\n tier) Amazon Web Services activity that occurs while the account isn't attached to an\n organization. To remove an account that doesn't yet have this information,\n you must sign in as the member account and follow the steps at To leave an organization when all required account information has not\n yet been provided in the\n Organizations User Guide.\n
\nThe account that you want to leave must not be a delegated administrator\n account for any Amazon Web Services service enabled for your organization. If the account\n is a delegated administrator, you must first change the delegated\n administrator account to another account that is remaining in the\n organization.
\nAfter the account leaves the organization, all tags that were attached to\n the account object in the organization are deleted. Amazon Web Services accounts outside\n of an organization do not support tags.
\nRemoves the specified account from the organization.
\nThe removed account becomes a standalone account that isn't a member of any\n organization. It's no longer subject to any policies and is responsible for its own bill\n payments. The organization's management account is no longer charged for any expenses\n accrued by the member account after it's removed from the organization.
\nThis operation can be called only from the organization's management account. Member accounts can remove themselves with LeaveOrganization instead.
\nYou can remove an account from your organization only if the account is\n configured with the information required to operate as a standalone account.\n When you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required of standalone accounts is\n not automatically collected. For more information,\n see Considerations before removing an account from an organization\n in the Organizations User Guide.
\nThe account that you want to leave must not be a delegated administrator\n account for any Amazon Web Services service enabled for your organization. If the account\n is a delegated administrator, you must first change the delegated\n administrator account to another account that is remaining in the\n organization.
\nAfter the account leaves the organization, all tags that were attached to\n the account object in the organization are deleted. Amazon Web Services accounts outside\n of an organization do not support tags.
\nAdds one or more tags to the specified resource.
\nCurrently, you can attach tags to the following resources in Organizations.
\nAmazon Web Services account
\nOrganization root
\nOrganizational unit (OU)
\nPolicy (any type)
\nThis operation can be called only from the organization's management account.
" + "smithy.api#documentation": "Adds one or more tags to the specified resource.
\nCurrently, you can attach tags to the following resources in Organizations.
\nAmazon Web Services account
\nOrganization root
\nOrganizational unit (OU)
\nPolicy (any type)
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
" } }, "com.amazonaws.organizations#TagResourceRequest": { @@ -8499,7 +8499,7 @@ } }, "traits": { - "smithy.api#documentation": "You have sent too many requests in too short a period of time. The quota helps protect\n against denial-of-service attacks. Try again later.
\nFor information about quotas that affect Organizations, see Quotas for Organizationsin the\n Organizations User Guide.\n
", + "smithy.api#documentation": "You have sent too many requests in too short a period of time. The quota helps protect\n against denial-of-service attacks. Try again later.
\nFor information about quotas that affect Organizations, see Quotas for Organizations in the\n Organizations User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -8552,7 +8552,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes any tags with the specified keys from the specified resource.
\nYou can attach tags to the following resources in Organizations.
\nAmazon Web Services account
\nOrganization root
\nOrganizational unit (OU)
\nPolicy (any type)
\nThis operation can be called only from the organization's management account.
" + "smithy.api#documentation": "Removes any tags with the specified keys from the specified resource.
\nYou can attach tags to the following resources in Organizations.
\nAmazon Web Services account
\nOrganization root
\nOrganizational unit (OU)
\nPolicy (any type)
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
" } }, "com.amazonaws.organizations#UntagResourceRequest": { @@ -8714,7 +8714,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing policy with a new name, description, or content. If you don't\n supply any parameter, that value remains unchanged. You can't change a policy's\n type.
\nThis operation can be called only from the organization's management account.
", + "smithy.api#documentation": "Updates an existing policy with a new name, description, or content. If you don't\n supply any parameter, that value remains unchanged. You can't change a policy's\n type.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
", "smithy.api#examples": [ { "title": "To update the details of a policy", @@ -8766,7 +8766,7 @@ "Content": { "target": "com.amazonaws.organizations#PolicyContent", "traits": { - "smithy.api#documentation": "If provided, the new content for the policy. The text must be correctly formatted JSON\n that complies with the syntax for the policy's type. For more information, see Service\n Control Policy Syntax in the Organizations User Guide.\n
" + "smithy.api#documentation": "If provided, the new content for the policy. The text must be correctly formatted JSON\n that complies with the syntax for the policy's type. For more information, see SCP\n syntax in the Organizations User Guide.
" } } }, diff --git a/codegen/sdk/aws-models/pca-connector-ad.json b/codegen/sdk/aws-models/pca-connector-ad.json new file mode 100644 index 00000000000..4c5f430d38d --- /dev/null +++ b/codegen/sdk/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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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/aws-models/quicksight.json b/codegen/sdk/aws-models/quicksight.json index 6cae8f4b304..1fc65ee85d9 100644 --- a/codegen/sdk/aws-models/quicksight.json +++ b/codegen/sdk/aws-models/quicksight.json @@ -323,6 +323,13 @@ "smithy.api#pattern": "^[\\w\\-]+|(\\$LATEST)|(\\$PUBLISHED)$" } }, + "com.amazonaws.quicksight#AllSheetsFilterScopeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "The configuration for applying a filter to all sheets. You can apply this filter to all visuals on every sheet.
\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.
" + } + }, "com.amazonaws.quicksight#AmazonElasticsearchParameters": { "type": "structure", "members": { @@ -6732,7 +6739,7 @@ "MemberId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID of the asset (the dashboard, analysis, or dataset).
", + "smithy.api#documentation": "The ID of the asset that you want to add to the folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6740,7 +6747,7 @@ "MemberType": { "target": "com.amazonaws.quicksight#MemberType", "traits": { - "smithy.api#documentation": "The type of the member, including DASHBOARD, ANALYSIS, and DATASET.
The member type of the asset that you want to add to a folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6825,6 +6832,12 @@ "traits": { "smithy.api#documentation": "Tags for the folder.
" } + }, + "SharingModel": { + "target": "com.amazonaws.quicksight#SharingModel", + "traits": { + "smithy.api#documentation": "An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.
The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.
", + "smithy.api#documentation": "The ID of the asset that you want to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13140,7 +13153,7 @@ "MemberType": { "target": "com.amazonaws.quicksight#MemberType", "traits": { - "smithy.api#documentation": "The type of the member, including DASHBOARD, ANALYSIS, and DATASET\n
The member type of the asset that you want to delete from a folder.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -16655,6 +16668,9 @@ { "target": "com.amazonaws.quicksight#InternalFailureException" }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, { "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, @@ -16674,6 +16690,12 @@ "method": "GET", "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/permissions", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Permissions", + "pageSize": "MaxResults" } } }, @@ -16695,6 +16717,28 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The namespace of the folder whose permissions you want described.
", + "smithy.api#httpQuery": "namespace" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The maximum number of results to be returned per request.
", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "A pagination token for the next set of results.
", + "smithy.api#httpQuery": "next-token" + } } }, "traits": { @@ -16735,6 +16779,12 @@ "traits": { "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The pagination token for the next set of results, or null if there are no more results.
" + } } }, "traits": { @@ -16780,6 +16830,9 @@ { "target": "com.amazonaws.quicksight#InternalFailureException" }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, { "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, @@ -16799,6 +16852,12 @@ "method": "GET", "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/resolved-permissions", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Permissions", + "pageSize": "MaxResults" } } }, @@ -16820,6 +16879,28 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The namespace of the folder whose permissions you want described.
", + "smithy.api#httpQuery": "namespace" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The maximum number of results to be returned per request.
", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "A pagination token for the next set of results.
", + "smithy.api#httpQuery": "next-token" + } } }, "traits": { @@ -16860,6 +16941,12 @@ "traits": { "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "A pagination token for the next set of results, or null if there are no more results.
" + } } }, "traits": { @@ -20650,6 +20737,12 @@ "traits": { "smithy.api#documentation": "The configuration for applying a filter to specific sheets.
" } + }, + "AllSheets": { + "target": "com.amazonaws.quicksight#AllSheetsFilterScopeConfiguration", + "traits": { + "smithy.api#documentation": "The configuration for applying a filter to all sheets.
" + } } }, "traits": { @@ -20884,6 +20977,12 @@ "traits": { "smithy.api#documentation": "The time that the folder was last updated.
" } + }, + "SharingModel": { + "target": "com.amazonaws.quicksight#SharingModel", + "traits": { + "smithy.api#documentation": "The sharing scope of the folder.
" + } } }, "traits": { @@ -21066,6 +21165,12 @@ "traits": { "smithy.api#documentation": "The time that the folder was last updated.
" } + }, + "SharingModel": { + "target": "com.amazonaws.quicksight#SharingModel", + "traits": { + "smithy.api#documentation": "The sharing scope of the folder.
" + } } }, "traits": { @@ -21257,8 +21362,7 @@ "Time": { "target": "com.amazonaws.quicksight#DimensionField", "traits": { - "smithy.api#documentation": "The time field that is used in a computation.
", - "smithy.api#required": {} + "smithy.api#documentation": "The time field that is used in a computation.
" } }, "Value": { @@ -23431,8 +23535,7 @@ "Time": { "target": "com.amazonaws.quicksight#DimensionField", "traits": { - "smithy.api#documentation": "The time field that is used in a computation.
", - "smithy.api#required": {} + "smithy.api#documentation": "The time field that is used in a computation.
" } }, "Value": { @@ -27167,6 +27270,12 @@ "method": "GET", "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FolderMemberList", + "pageSize": "MaxResults" } } }, @@ -27280,6 +27389,12 @@ "method": "GET", "uri": "/accounts/{AwsAccountId}/folders", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FolderSummaryList", + "pageSize": "MaxResults" } } }, @@ -29890,8 +30005,7 @@ "Time": { "target": "com.amazonaws.quicksight#DimensionField", "traits": { - "smithy.api#documentation": "The time field that is used in a computation.
", - "smithy.api#required": {} + "smithy.api#documentation": "The time field that is used in a computation.
" } }, "Value": { @@ -30035,22 +30149,19 @@ "Time": { "target": "com.amazonaws.quicksight#DimensionField", "traits": { - "smithy.api#documentation": "The time field that is used in a computation.
", - "smithy.api#required": {} + "smithy.api#documentation": "The time field that is used in a computation.
" } }, "FromValue": { "target": "com.amazonaws.quicksight#MeasureField", "traits": { - "smithy.api#documentation": "The field that is used in a metric comparison from value setup.
", - "smithy.api#required": {} + "smithy.api#documentation": "The field that is used in a metric comparison from value setup.
" } }, "TargetValue": { "target": "com.amazonaws.quicksight#MeasureField", "traits": { - "smithy.api#documentation": "The field that is used in a metric comparison to value setup.
", - "smithy.api#required": {} + "smithy.api#documentation": "The field that is used in a metric comparison to value setup.
" } } }, @@ -32228,8 +32339,7 @@ "Time": { "target": "com.amazonaws.quicksight#DimensionField", "traits": { - "smithy.api#documentation": "The time field that is used in a computation.
", - "smithy.api#required": {} + "smithy.api#documentation": "The time field that is used in a computation.
" } }, "Value": { @@ -32262,8 +32372,7 @@ "Time": { "target": "com.amazonaws.quicksight#DimensionField", "traits": { - "smithy.api#documentation": "The time field that is used in a computation.
", - "smithy.api#required": {} + "smithy.api#documentation": "The time field that is used in a computation.
" } }, "Value": { @@ -38135,6 +38244,12 @@ "method": "POST", "uri": "/accounts/{AwsAccountId}/search/folders", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FolderSummaryList", + "pageSize": "MaxResults" } } }, @@ -38952,6 +39067,23 @@ "smithy.api#documentation": "The shape conditional formatting of a filled map visual.
" } }, + "com.amazonaws.quicksight#SharingModel": { + "type": "enum", + "members": { + "ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT" + } + }, + "NAMESPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMESPACE" + } + } + } + }, "com.amazonaws.quicksight#Sheet": { "type": "structure", "members": { @@ -39829,14 +39961,14 @@ "SheetSelections": { "target": "com.amazonaws.quicksight#SnapshotFileSheetSelectionList", "traits": { - "smithy.api#documentation": "A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations or 1 configuration for PDF.
A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.
The format of the snapshot file to be generated. You can choose between CSV or PDF.
The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.
The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV and PDF format types.
", + "smithy.api#documentation": "The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.
", "smithy.api#required": {} } }, "SelectionScope": { "target": "com.amazonaws.quicksight#SnapshotFileSheetSelectionScope", "traits": { - "smithy.api#documentation": "The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.
\n\n ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.
\n SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV.
The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.
\n\n ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF.
\n SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.
\n A list of visual IDs that are located in the selected sheet. This structure supports tables and pivot tables. This structure is required if you are generating a CSV. You can add a maximum of 1 visual ID to this structure.\n
" + "smithy.api#documentation": "\n A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.\n
" } } }, @@ -39936,7 +40074,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 1 + "max": 5 } } }, @@ -39965,7 +40103,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 1 + "max": 5 } } }, @@ -40635,7 +40773,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts an asynchronous job that generates a dashboard snapshot. You can request one of the following format configurations per API call.
\n1 paginated PDF
\n5 CSVs
\nPoll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.
Starts an asynchronous job that generates a dashboard snapshot. You can request one of the following format configurations per API call.
\n1 paginated PDF
\n1 Excel workbook
\n5 CSVs
\nPoll job descriptions with a DescribeDashboardSnapshotJob API call. Once the job succeeds, use the DescribeDashboardSnapshotJobResult API to obtain the download URIs that the job generates.
The selected field options for the table field options.
" + "smithy.api#documentation": "The field options to be configured to a table.
" } }, "Order": { "target": "com.amazonaws.quicksight#FieldOrderList", "traits": { - "smithy.api#documentation": "The order of field IDs of the field options for a table visual.
" + "smithy.api#documentation": "The order of the field IDs that are configured as field options for a table visual.
" + } + }, + "PinnedFieldOptions": { + "target": "com.amazonaws.quicksight#TablePinnedFieldOptions", + "traits": { + "smithy.api#documentation": "The settings for the pinned columns of a table visual.
" } } }, "traits": { - "smithy.api#documentation": "The field options for a table visual.
" + "smithy.api#documentation": "The field options of a table visual.
" + } + }, + "com.amazonaws.quicksight#TableFieldOrderList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FieldId" + }, + "traits": { + "smithy.api#documentation": "A list of table field IDs.
", + "smithy.api#length": { + "min": 0, + "max": 201 + } } }, "com.amazonaws.quicksight#TableFieldURLConfiguration": { @@ -41700,6 +41857,20 @@ "smithy.api#documentation": "The paginated report options for a table visual.
" } }, + "com.amazonaws.quicksight#TablePinnedFieldOptions": { + "type": "structure", + "members": { + "PinnedLeftFields": { + "target": "com.amazonaws.quicksight#TableFieldOrderList", + "traits": { + "smithy.api#documentation": "A list of columns to be pinned to the left of a table visual.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The settings for the pinned columns of a table visual.
" + } + }, "com.amazonaws.quicksight#TableRowConditionalFormatting": { "type": "structure", "members": { @@ -43549,15 +43720,13 @@ "Time": { "target": "com.amazonaws.quicksight#DimensionField", "traits": { - "smithy.api#documentation": "The time field that is used in a computation.
", - "smithy.api#required": {} + "smithy.api#documentation": "The time field that is used in a computation.
" } }, "Category": { "target": "com.amazonaws.quicksight#DimensionField", "traits": { - "smithy.api#documentation": "The category field that is used in a computation.
", - "smithy.api#required": {} + "smithy.api#documentation": "The category field that is used in a computation.
" } }, "Value": { @@ -43620,8 +43789,7 @@ "Category": { "target": "com.amazonaws.quicksight#DimensionField", "traits": { - "smithy.api#documentation": "The category field that is used in a computation.
", - "smithy.api#required": {} + "smithy.api#documentation": "The category field that is used in a computation.
" } }, "Value": { @@ -44605,8 +44773,7 @@ "Value": { "target": "com.amazonaws.quicksight#MeasureField", "traits": { - "smithy.api#documentation": "The value field that is used in a computation.
", - "smithy.api#required": {} + "smithy.api#documentation": "The value field that is used in a computation.
" } } }, @@ -45192,8 +45359,7 @@ "Category": { "target": "com.amazonaws.quicksight#DimensionField", "traits": { - "smithy.api#documentation": "The category field that is used in a computation.
", - "smithy.api#required": {} + "smithy.api#documentation": "The category field that is used in a computation.
" } } }, diff --git a/codegen/sdk/aws-models/rds.json b/codegen/sdk/aws-models/rds.json index a47d66eaba8..1ab26457fa8 100644 --- a/codegen/sdk/aws-models/rds.json +++ b/codegen/sdk/aws-models/rds.json @@ -12156,7 +12156,13 @@ } ], "traits": { - "smithy.api#documentation": "Displays backups for both current and deleted DB clusters. For example, use this operation to find details \n about automated backups for previously deleted clusters. Current clusters are returned for both the \n DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.
All parameters are optional.
" + "smithy.api#documentation": "Displays backups for both current and deleted DB clusters. For example, use this operation to find details \n about automated backups for previously deleted clusters. Current clusters are returned for both the \n DescribeDBClusterAutomatedBackups and DescribeDBClusters operations.
All parameters are optional.
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "Marker", + "items": "DBClusterAutomatedBackups", + "pageSize": "MaxRecords" + } } }, "com.amazonaws.rds#DescribeDBClusterAutomatedBackupsMessage": { @@ -23743,7 +23749,7 @@ "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The version number of the database engine to use.
\nTo list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nExamples: 5.7.mysql_aurora.2.07.1, 8.0.mysql_aurora.3.02.0\n
The version number of the database engine to use.
\nTo list all of the available engine versions for aurora-mysql (Aurora MySQL), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nExamples: 5.7.mysql_aurora.2.12.0, 8.0.mysql_aurora.3.04.0\n
The version of the database that the backup files were created from.
\nMySQL versions 5.5, 5.6, and 5.7 are supported.
\nExample: 5.6.40, 5.7.28\n
The version of the database that the backup files were created from.
\nMySQL versions 5.7 and 8.0 are supported.
\nExample: 5.7.40, 8.0.28\n
Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.
\nNot every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming\n rules.
\nIf you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
\nBy default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.
\nIf you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of\n buckets.
In addition to s3:CreateBucket, the following permissions are required when\n your CreateBucket request includes specific headers:
\n Access control lists (ACLs) - If your CreateBucket request\n specifies access control list (ACL) permissions and the ACL is public-read, public-read-write,\n authenticated-read, or if you specify access permissions explicitly through any other\n ACL, both s3:CreateBucket and s3:PutBucketAcl permissions\n are needed. If the ACL for the CreateBucket request is private or if the request doesn't\n specify any ACLs, only s3:CreateBucket permission is needed.
\n Object Lock - If ObjectLockEnabledForBucket is set to true in your\n CreateBucket request,\n s3:PutBucketObjectLockConfiguration and\n s3:PutBucketVersioning permissions are required.
\n S3 Object Ownership - If your CreateBucket request includes the x-amz-object-ownership header, then the\n s3:PutBucketOwnershipControls permission is required. By default, ObjectOwnership is set to BucketOWnerEnforced and ACLs are disabled. We recommend keeping\n ACLs disabled, except in uncommon use cases where you must control access for each object individually. If you want to change the ObjectOwnership setting, you can use the \n x-amz-object-ownership header in your CreateBucket request to set the ObjectOwnership setting of your choice.\n For more information about S3 Object Ownership, see Controlling object\n ownership in the Amazon S3 User Guide.
\n S3 Block Public Access - If your specific use case requires granting public access to your S3 resources, you can disable Block Public Access. You can create a new bucket with Block Public Access enabled, then separately call the \n DeletePublicAccessBlock\n API. To use this operation, you must have the\n s3:PutBucketPublicAccessBlock permission. By default, all Block\n Public Access settings are enabled for new buckets. To avoid inadvertent exposure of\n your resources, we recommend keeping the S3 Block Public Access settings enabled. For more information about S3 Block Public Access, see Blocking public\n access to your Amazon S3 storage in the Amazon S3 User Guide.
If your CreateBucket request sets BucketOwnerEnforced for Amazon S3 Object Ownership\n and specifies a bucket ACL that provides access to an external Amazon Web Services account, your request fails with a 400 error and returns the InvalidBucketAcLWithObjectOwnership error code. For more information,\n see Setting Object\n Ownership on an existing bucket in the Amazon S3 User Guide.
The following operations are related to CreateBucket:
\n PutObject\n
\n\n DeleteBucket\n
\nThe 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": { diff --git a/codegen/sdk/aws-models/secrets-manager.json b/codegen/sdk/aws-models/secrets-manager.json index 3e2cc0e9225..6227ccf3a62 100644 --- a/codegen/sdk/aws-models/secrets-manager.json +++ b/codegen/sdk/aws-models/secrets-manager.json @@ -3272,6 +3272,7 @@ "arnNamespace": "secretsmanager", "cloudFormationName": "SecretsManager", "cloudTrailEventSource": "secretsmanager.amazonaws.com", + "docId": "secretsmanager-2017-10-17", "endpointPrefix": "secretsmanager" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/securitylake.json b/codegen/sdk/aws-models/securitylake.json index 666da09d9e9..c59d135c37e 100644 --- a/codegen/sdk/aws-models/securitylake.json +++ b/codegen/sdk/aws-models/securitylake.json @@ -468,6 +468,10 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a new security data lake", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], "aws.iam#requiredActions": [ "iam:CreateServiceLinkedRole", "iam:GetRole", @@ -710,6 +714,10 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a subscriber", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], "aws.iam#requiredActions": [ "iam:GetRole", "iam:PutRolePolicy", @@ -2454,7 +2462,8 @@ "outputToken": "nextToken", "pageSize": "maxResults", "items": "exceptions" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.securitylake#ListDataLakeExceptionsRequest": { @@ -2613,7 +2622,8 @@ "outputToken": "nextToken", "pageSize": "maxResults", "items": "sources" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.securitylake#ListLogSourcesRequest": { @@ -2901,7 +2911,9 @@ "com.amazonaws.securitylake#NextToken": { "type": "string", "traits": { - "smithy.api#pattern": "^[\\\\\\w\\-_:/.@=+]*$" + "smithy.api#length": { + "max": 2048 + } } }, "com.amazonaws.securitylake#NotificationConfiguration": { @@ -3141,6 +3153,23 @@ "aws.auth#sigv4": { "name": "securitylake" }, + "aws.iam#defineConditionKeys": { + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by the tags associated with the resource", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by tags that are passed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" + }, + "aws:TagKeys": { + "type": "ArrayOfString", + "documentation": "Filters access by tag keys that are passed in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" + } + }, "aws.iam#supportedPrincipalTypes": [ "Root", "IAMUser", @@ -4136,6 +4165,10 @@ } ], "traits": { + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], "smithy.api#documentation": "Adds or updates one or more tags that are associated with an Amazon Security Lake resource: a subscriber, or the data lake configuration for your \n Amazon Web Services account in a particular Amazon Web Services Region. A tag is a label that you can define and associate with \n Amazon Web Services resources. Each tag consists of a required tag key and an associated tag value. A \n tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a \n descriptor for a tag key. Tags can help you identify, categorize, and manage resources in different ways, such as by owner, environment, or other \n criteria. For more information, see \n Tagging Amazon Security Lake resources in the \n Amazon Security Lake User Guide.
", "smithy.api#http": { "method": "POST", @@ -4165,7 +4198,12 @@ } }, "traits": { - "smithy.api#input": {} + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.securitylake#DataLake" + } + ] } }, "com.amazonaws.securitylake#TagResourceResponse": { @@ -4254,6 +4292,9 @@ } ], "traits": { + "aws.iam#conditionKeys": [ + "aws:TagKeys" + ], "smithy.api#documentation": "Removes one or more tags (keys and values) from an Amazon Security Lake resource: a subscriber, or the data lake configuration for your \n Amazon Web Services account in a particular Amazon Web Services Region.
", "smithy.api#http": { "method": "DELETE", @@ -4284,7 +4325,12 @@ } }, "traits": { - "smithy.api#input": {} + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.securitylake#DataLake" + } + ] } }, "com.amazonaws.securitylake#UntagResourceResponse": { diff --git a/codegen/sdk/aws-models/serverlessapplicationrepository.json b/codegen/sdk/aws-models/serverlessapplicationrepository.json index 347b59c9418..2ad29cdbc40 100644 --- a/codegen/sdk/aws-models/serverlessapplicationrepository.json +++ b/codegen/sdk/aws-models/serverlessapplicationrepository.json @@ -1963,6 +1963,7 @@ "arnNamespace": "serverlessrepo", "cloudFormationName": "ServerlessApplicationRepository", "cloudTrailEventSource": "serverlessapplicationrepository.amazonaws.com", + "docId": "serverlessrepo-2017-09-08", "endpointPrefix": "serverlessrepo" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/service-catalog-appregistry.json b/codegen/sdk/aws-models/service-catalog-appregistry.json index 7dbff7e923c..ac9925afe86 100644 --- a/codegen/sdk/aws-models/service-catalog-appregistry.json +++ b/codegen/sdk/aws-models/service-catalog-appregistry.json @@ -112,6 +112,7 @@ "arnNamespace": "servicecatalog", "cloudFormationName": "ServiceCatalogAppRegistry", "cloudTrailEventSource": "servicecatalogappregistry.amazonaws.com", + "docId": "AWS242AppRegistry-2020-06-24", "endpointPrefix": "servicecatalog-appregistry" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/service-catalog.json b/codegen/sdk/aws-models/service-catalog.json index b8a67f2a1a6..3dd3ad023d8 100644 --- a/codegen/sdk/aws-models/service-catalog.json +++ b/codegen/sdk/aws-models/service-catalog.json @@ -310,6 +310,7 @@ "arnNamespace": "servicecatalog", "cloudFormationName": "ServiceCatalog", "cloudTrailEventSource": "servicecatalog.amazonaws.com", + "docId": "servicecatalog-2015-12-10", "endpointPrefix": "servicecatalog" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/service-quotas.json b/codegen/sdk/aws-models/service-quotas.json index 4cc25af83c5..adee3f8059d 100644 --- a/codegen/sdk/aws-models/service-quotas.json +++ b/codegen/sdk/aws-models/service-quotas.json @@ -37,7 +37,7 @@ } }, "traits": { - "smithy.api#documentation": "The action you attempted is not allowed unless Service Access with Service Quotas is\n enabled in your organization.
", + "smithy.api#documentation": "The action you attempted is not allowed unless Service Access with Service Quotas is enabled in\n your organization.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -65,6 +65,29 @@ "smithy.api#pattern": "^arn:aws(-[\\w]+)*:*:.+:[0-9]{12}:.+$" } }, + "com.amazonaws.servicequotas#AppliedLevelEnum": { + "type": "enum", + "members": { + "ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT" + } + }, + "RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, "com.amazonaws.servicequotas#AssociateServiceQuotaTemplate": { "type": "operation", "input": { @@ -100,7 +123,7 @@ } ], "traits": { - "smithy.api#documentation": "Associates your quota request template with your organization. When a new account is\n created in your organization, the quota increase requests in the template are automatically\n applied to the account. You can add a quota increase request for any adjustable quota to your\n template.
" + "smithy.api#documentation": "Associates your quota request template with your organization. When a new\n Amazon Web Services account is created in your organization, the quota increase requests in the\n template are automatically applied to the account. You can add a quota increase request\n for any adjustable quota to your template.
" } }, "com.amazonaws.servicequotas#AssociateServiceQuotaTemplateRequest": { @@ -171,7 +194,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the quota increase request for the specified quota from your quota request\n template.
" + "smithy.api#documentation": "Deletes the quota increase request for the specified quota from your quota request\n template.
" } }, "com.amazonaws.servicequotas#DeleteServiceQuotaIncreaseRequestFromTemplateRequest": { @@ -180,21 +203,21 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "The service identifier.
", + "smithy.api#documentation": "Specifies the service identifier. To find the service code value \n for an Amazon Web Services service, use the ListServices operation.
", "smithy.api#required": {} } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "The quota identifier.
", + "smithy.api#documentation": "Specifies the quota identifier. To find the quota code for a specific \n quota, use the ListServiceQuotas operation, and look for the\n QuotaCode response in the output for the quota you want.
The AWS Region.
", + "smithy.api#documentation": "Specifies the Amazon Web Services Region for which the request was made.
", "smithy.api#required": {} } } @@ -258,7 +281,7 @@ } ], "traits": { - "smithy.api#documentation": "Disables your quota request template. After a template is disabled, the quota increase\n requests in the template are not applied to new accounts in your organization. Disabling a\n quota request template does not apply its quota increase requests.
" + "smithy.api#documentation": "Disables your quota request template. After a template is disabled, the quota increase\n requests in the template are not applied to new Amazon Web Services accounts in your organization.\n Disabling a quota request template does not apply its quota increase requests.
" } }, "com.amazonaws.servicequotas#DisassociateServiceQuotaTemplateRequest": { @@ -313,7 +336,7 @@ "ErrorCode": { "target": "com.amazonaws.servicequotas#ErrorCode", "traits": { - "smithy.api#documentation": "Service Quotas returns the following error values:
\n\n DEPENDENCY_ACCESS_DENIED_ERROR - The caller does not have the required\n permissions to complete the action. To resolve the error, you must have permission to\n access the service or quota.
\n DEPENDENCY_THROTTLING_ERROR - The service is throttling Service\n Quotas.
\n DEPENDENCY_SERVICE_ERROR - The service is not available.
\n SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in Service\n Quotas.
Service Quotas returns the following error values:
\n\n DEPENDENCY_ACCESS_DENIED_ERROR - The caller does not have the\n required permissions to complete the action. To resolve the error, you must have\n permission to access the Amazon Web Service or quota.
\n DEPENDENCY_THROTTLING_ERROR - The Amazon Web Service is throttling\n Service Quotas.
\n DEPENDENCY_SERVICE_ERROR - The Amazon Web Service is not\n available.
\n SERVICE_QUOTA_NOT_AVAILABLE_ERROR - There was an error in\n Service Quotas.
Retrieves the default value for the specified quota. The default value does not reflect\n any quota increases.
" + "smithy.api#documentation": "Retrieves the default value for the specified quota. The default value does not\n reflect any quota increases.
" } }, "com.amazonaws.servicequotas#GetAWSDefaultServiceQuotaRequest": { @@ -365,14 +388,14 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "The service identifier.
", + "smithy.api#documentation": "Specifies the service identifier. To find the service code value \n for an Amazon Web Services service, use the ListServices operation.
", "smithy.api#required": {} } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "The quota identifier.
", + "smithy.api#documentation": "Specifies the quota identifier. To find the quota code for a specific \n quota, use the ListServiceQuotas operation, and look for the\n QuotaCode response in the output for the quota you want.
The association status. If the status is ASSOCIATED, the quota increase\n requests in the template are automatically applied to new accounts in your\n organization.
The association status. If the status is ASSOCIATED, the quota increase\n requests in the template are automatically applied to new Amazon Web Services accounts in your\n organization.
The ID of the quota increase request.
", + "smithy.api#documentation": "Specifies the ID of the quota increase request.
", "smithy.api#required": {} } } @@ -538,7 +561,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the applied quota value for the specified quota. For some quotas, only the\n default values are available. If the applied quota value is not available for a quota, the\n quota is not retrieved.
" + "smithy.api#documentation": "Retrieves the applied quota value for the specified quota. For some quotas, only the\n default values are available. If the applied quota value is not available for a quota,\n the quota is not retrieved.
" } }, "com.amazonaws.servicequotas#GetServiceQuotaIncreaseRequestFromTemplate": { @@ -579,7 +602,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves information about the specified quota increase request in your quota request\n template.
" + "smithy.api#documentation": "Retrieves information about the specified quota increase request in your quota request\n template.
" } }, "com.amazonaws.servicequotas#GetServiceQuotaIncreaseRequestFromTemplateRequest": { @@ -588,21 +611,21 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "The service identifier.
", + "smithy.api#documentation": "Specifies the service identifier. To find the service code value \n for an Amazon Web Services service, use the ListServices operation.
", "smithy.api#required": {} } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "The quota identifier.
", + "smithy.api#documentation": "Specifies the quota identifier. To find the quota code for a specific \n quota, use the ListServiceQuotas operation, and look for the\n QuotaCode response in the output for the quota you want.
The AWS Region.
", + "smithy.api#documentation": "Specifies the Amazon Web Services Region for which you made the request.
", "smithy.api#required": {} } } @@ -631,16 +654,22 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "The service identifier.
", + "smithy.api#documentation": "Specifies the service identifier. To find the service code value \n for an Amazon Web Services service, use the ListServices operation.
", "smithy.api#required": {} } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "The quota identifier.
", + "smithy.api#documentation": "Specifies the quota identifier. To find the quota code for a specific \n quota, use the ListServiceQuotas operation, and look for the\n QuotaCode response in the output for the quota you want.
Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field\n depends on the context scope associated with the specified service quota.
" + } } }, "traits": { @@ -752,7 +781,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the default values for the quotas for the specified AWS service. A default value\n does not reflect any quota increases.
", + "smithy.api#documentation": "Lists the default values for the quotas for the specified Amazon Web Service. A default\n value does not reflect any quota increases.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -767,20 +796,20 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "The service identifier.
", + "smithy.api#documentation": "Specifies the service identifier. To find the service code value \n for an Amazon Web Services service, use the ListServices operation.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "The token for the next page of results.
" + "smithy.api#documentation": "Specifies a value for receiving additional results after you \n receive a NextToken response in a previous request. A NextToken \n response indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.
The maximum number of results to return with a single call. To retrieve the remaining\n results, if any, make another call with the token returned from this call.
" + "smithy.api#documentation": "Specifies the maximum number of results that you want included on each \n page of the response. If you do not include this parameter, it defaults to a value appropriate \n to the operation. If additional items exist beyond those included in the current response, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results.
An API operation can return fewer results than the maximum even when there are \n more results available. You should check NextToken after every operation to ensure \n that you receive all of the results.
The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.
" + "smithy.api#documentation": "If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.
Retrieves the quota increase requests for the specified service.
", + "smithy.api#documentation": "Retrieves the quota increase requests for the specified Amazon Web Service.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -890,33 +919,39 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "The service identifier.
", + "smithy.api#documentation": "Specifies the service identifier. To find the service code value \n for an Amazon Web Services service, use the ListServices operation.
", "smithy.api#required": {} } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "The quota identifier.
", + "smithy.api#documentation": "Specifies the quota identifier. To find the quota code for a specific \n quota, use the ListServiceQuotas operation, and look for the\n QuotaCode response in the output for the quota you want.
The status value of the quota increase request.
" + "smithy.api#documentation": "Specifies that you want to filter the results to only the requests with the matching\n status.
" } }, "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "The token for the next page of results.
" + "smithy.api#documentation": "Specifies a value for receiving additional results after you \n receive a NextToken response in a previous request. A NextToken \n response indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.
The maximum number of results to return with a single call. To retrieve the remaining\n results, if any, make another call with the token returned from this call.
" + "smithy.api#documentation": "Specifies the maximum number of results that you want included on each \n page of the response. If you do not include this parameter, it defaults to a value appropriate \n to the operation. If additional items exist beyond those included in the current response, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results.
An API operation can return fewer results than the maximum even when there are \n more results available. You should check NextToken after every operation to ensure \n that you receive all of the results.
Specifies at which level within the Amazon Web Services account the quota request applies to.
" } } }, @@ -930,7 +965,7 @@ "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.
" + "smithy.api#documentation": "If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.
The service identifier.
" + "smithy.api#documentation": "Specifies the service identifier. To find the service code value \n for an Amazon Web Services service, use the ListServices operation.
" } }, "Status": { "target": "com.amazonaws.servicequotas#RequestStatus", "traits": { - "smithy.api#documentation": "The status of the quota increase request.
" + "smithy.api#documentation": "Specifies that you want to filter the results to only the requests with the matching\n status.
" } }, "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "The token for the next page of results.
" + "smithy.api#documentation": "Specifies a value for receiving additional results after you \n receive a NextToken response in a previous request. A NextToken \n response indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.
The maximum number of results to return with a single call. To retrieve the remaining\n results, if any, make another call with the token returned from this call.
" + "smithy.api#documentation": "Specifies the maximum number of results that you want included on each \n page of the response. If you do not include this parameter, it defaults to a value appropriate \n to the operation. If additional items exist beyond those included in the current response, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results.
An API operation can return fewer results than the maximum even when there are \n more results available. You should check NextToken after every operation to ensure \n that you receive all of the results.
Specifies at which level within the Amazon Web Services account the quota request applies to.
" } } }, @@ -982,7 +1023,7 @@ "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.
" + "smithy.api#documentation": "If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.
The service identifier.
" + "smithy.api#documentation": "Specifies the service identifier. To find the service code value \n for an Amazon Web Services service, use the ListServices operation.
" } }, "AwsRegion": { "target": "com.amazonaws.servicequotas#AwsRegion", "traits": { - "smithy.api#documentation": "The AWS Region.
" + "smithy.api#documentation": "Specifies the Amazon Web Services Region for which you made the request.
" } }, "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "The token for the next page of results.
" + "smithy.api#documentation": "Specifies a value for receiving additional results after you \n receive a NextToken response in a previous request. A NextToken \n response indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.
The maximum number of results to return with a single call. To retrieve the remaining\n results, if any, make another call with the token returned from this call.
" + "smithy.api#documentation": "Specifies the maximum number of results that you want included on each \n page of the response. If you do not include this parameter, it defaults to a value appropriate \n to the operation. If additional items exist beyond those included in the current response, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results.
An API operation can return fewer results than the maximum even when there are \n more results available. You should check NextToken after every operation to ensure \n that you receive all of the results.
The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.
" + "smithy.api#documentation": "If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.
Lists the applied quota values for the specified AWS service. For some quotas, only the\n default values are available. If the applied quota value is not available for a quota, the\n quota is not retrieved.
", + "smithy.api#documentation": "Lists the applied quota values for the specified Amazon Web Service. For some quotas, only\n the default values are available. If the applied quota value is not available for a\n quota, the quota is not retrieved.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1136,20 +1177,32 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "The service identifier.
", + "smithy.api#documentation": "Specifies the service identifier. To find the service code value \n for an Amazon Web Services service, use the ListServices operation.
", "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "The token for the next page of results.
" + "smithy.api#documentation": "Specifies a value for receiving additional results after you \n receive a NextToken response in a previous request. A NextToken \n response indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.
The maximum number of results to return with a single call. To retrieve the remaining\n results, if any, make another call with the token returned from this call.
" + "smithy.api#documentation": "Specifies the maximum number of results that you want included on each \n page of the response. If you do not include this parameter, it defaults to a value appropriate \n to the operation. If additional items exist beyond those included in the current response, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results.
An API operation can return fewer results than the maximum even when there are \n more results available. You should check NextToken after every operation to ensure \n that you receive all of the results.
Specifies the quota identifier. To find the quota code for a specific \n quota, use the ListServiceQuotas operation, and look for the\n QuotaCode response in the output for the quota you want.
Specifies at which level of granularity that the quota value is applied.
" } } }, @@ -1163,7 +1216,7 @@ "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.
" + "smithy.api#documentation": "If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.
Lists the names and codes for the services integrated with Service Quotas.
", + "smithy.api#documentation": "Lists the names and codes for the Amazon Web Services integrated with Service Quotas.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1218,13 +1271,13 @@ "NextToken": { "target": "com.amazonaws.servicequotas#NextToken", "traits": { - "smithy.api#documentation": "The token for the next page of results.
" + "smithy.api#documentation": "Specifies a value for receiving additional results after you \n receive a NextToken response in a previous request. A NextToken \n response indicates that more output is available. Set this parameter to the value of the previous \n call's NextToken response to indicate where the output should continue \n from.
The maximum number of results to return with a single call. To retrieve the remaining\n results, if any, make another call with the token returned from this call.
" + "smithy.api#documentation": "Specifies the maximum number of results that you want included on each \n page of the response. If you do not include this parameter, it defaults to a value appropriate \n to the operation. If additional items exist beyond those included in the current response, the \n NextToken response element is present and has a value (is not null). Include that \n value as the NextToken request parameter in the next call to the operation to get \n the next part of the results.
An API operation can return fewer results than the maximum even when there are \n more results available. You should check NextToken after every operation to ensure \n that you receive all of the results.
The token to use to retrieve the next page of results. This value is null when there are\n no more results to return.
" + "smithy.api#documentation": "If present, indicates that more output is available than is \n included in the current response. Use this value in the NextToken request parameter \n in a subsequent call to the operation to get the next part of the output. You should repeat this \n until the NextToken response element comes back as null.
Information about the services.
" + "smithy.api#documentation": "The list of the Amazon Web Service names and service codes.
" } } }, @@ -1287,7 +1340,7 @@ "ResourceARN": { "target": "com.amazonaws.servicequotas#AmazonResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the applied quota for which you want to list tags. You\n can get this information by using the Service Quotas console, or by listing the quotas using the\n list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the applied quota for which you want to list tags.\n You can get this information by using the Service Quotas console, or by listing the quotas\n using the list-service-quotas CLI command or the ListServiceQuotas Amazon Web Services API operation.
", "smithy.api#required": {} } } @@ -1358,7 +1411,7 @@ "MetricDimensions": { "target": "com.amazonaws.servicequotas#MetricDimensionsMapDefinition", "traits": { - "smithy.api#documentation": "The metric dimension. This is a name/value pair that is part of the identity of a\n metric.
" + "smithy.api#documentation": "The metric dimension. This is a name/value pair that is part of the identity of a\n metric.
" } }, "MetricStatisticRecommendation": { @@ -1390,7 +1443,7 @@ } }, "traits": { - "smithy.api#documentation": "The account making this call is not a member of an organization.
", + "smithy.api#documentation": "The Amazon Web Services account making this call is not a member of an organization.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -1416,7 +1469,7 @@ } }, "traits": { - "smithy.api#documentation": "The organization that your account belongs to is not in All Features mode.
", + "smithy.api#documentation": "The organization that your Amazon Web Services account belongs to is not in All Features\n mode.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1533,28 +1586,28 @@ "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "The quota identifier.
", + "smithy.api#documentation": "Specifies the quota identifier. To find the quota code for a specific \n quota, use the ListServiceQuotas operation, and look for the\n QuotaCode response in the output for the quota you want.
The service identifier.
", + "smithy.api#documentation": "Specifies the service identifier. To find the service code value \n for an Amazon Web Services service, use the ListServices operation.
", "smithy.api#required": {} } }, "AwsRegion": { "target": "com.amazonaws.servicequotas#AwsRegion", "traits": { - "smithy.api#documentation": "The AWS Region.
", + "smithy.api#documentation": "Specifies the Amazon Web Services Region to which the template applies.
", "smithy.api#required": {} } }, "DesiredValue": { "target": "com.amazonaws.servicequotas#QuotaValue", "traits": { - "smithy.api#documentation": "The new, increased value for the quota.
", + "smithy.api#documentation": "Specifies the new, increased value for the quota.
", "smithy.api#required": {} } } @@ -1596,6 +1649,55 @@ "smithy.api#pattern": "^[a-zA-Z][a-zA-Z0-9-]{1,128}$" } }, + "com.amazonaws.servicequotas#QuotaContextId": { + "type": "string" + }, + "com.amazonaws.servicequotas#QuotaContextInfo": { + "type": "structure", + "members": { + "ContextScope": { + "target": "com.amazonaws.servicequotas#QuotaContextScope", + "traits": { + "smithy.api#documentation": "Specifies whether the quota applies to an Amazon Web Services account, or to a resource.
" + } + }, + "ContextScopeType": { + "target": "com.amazonaws.servicequotas#QuotaContextScopeType", + "traits": { + "smithy.api#documentation": "When the ContextScope is RESOURCE, then this specifies the resource type of the specified resource.
Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field\n depends on the context scope associated with the specified service quota.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that describes the context for a service quota. The context identifies what the quota applies to.
" + } + }, + "com.amazonaws.servicequotas#QuotaContextScope": { + "type": "enum", + "members": { + "RESOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESOURCE" + } + }, + "ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT" + } + } + } + }, + "com.amazonaws.servicequotas#QuotaContextScopeType": { + "type": "string" + }, "com.amazonaws.servicequotas#QuotaExceededException": { "type": "structure", "members": { @@ -1604,7 +1706,7 @@ } }, "traits": { - "smithy.api#documentation": "You have exceeded your service quota. To perform the requested action, remove some of the\n relevant resources, or use Service Quotas to request a service quota increase.
", + "smithy.api#documentation": "You have exceeded your service quota. To perform the requested action, remove some of\n the relevant resources, or use Service Quotas to request a service quota increase.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -1624,7 +1726,7 @@ "PeriodValue": { "target": "com.amazonaws.servicequotas#PeriodValue", "traits": { - "smithy.api#documentation": "The value.
" + "smithy.api#documentation": "The value associated with the reported PeriodUnit.
The service identifier.
", + "smithy.api#documentation": "Specifies the service identifier. To find the service code value \n for an Amazon Web Services service, use the ListServices operation.
", "smithy.api#required": {} } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "The quota identifier.
", + "smithy.api#documentation": "Specifies the quota identifier. To find the quota code for a specific \n quota, use the ListServiceQuotas operation, and look for the\n QuotaCode response in the output for the quota you want.
The new, increased value for the quota.
", + "smithy.api#documentation": "Specifies the new, increased value for the quota.
", "smithy.api#required": {} } + }, + "ContextId": { + "target": "com.amazonaws.servicequotas#QuotaContextId", + "traits": { + "smithy.api#documentation": "Specifies the Amazon Web Services account or resource to which the quota applies. The value in this field\n depends on the context scope associated with the specified service quota.
" + } } }, "traits": { @@ -1776,6 +1884,18 @@ "traits": { "smithy.api#enumValue": "CASE_CLOSED" } + }, + "NOT_APPROVED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_APPROVED" + } + }, + "INVALID_REQUEST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_REQUEST" + } } } }, @@ -1797,25 +1917,25 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "The service identifier.
" + "smithy.api#documentation": "Specifies the service identifier. To find the service code value \n for an Amazon Web Services service, use the ListServices operation.
" } }, "ServiceName": { "target": "com.amazonaws.servicequotas#ServiceName", "traits": { - "smithy.api#documentation": "The service name.
" + "smithy.api#documentation": "Specifies the service name.
" } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "The quota identifier.
" + "smithy.api#documentation": "Specifies the quota identifier. To find the quota code for a specific \n quota, use the ListServiceQuotas operation, and look for the\n QuotaCode response in the output for the quota you want.
The quota name.
" + "smithy.api#documentation": "Specifies the quota name.
" } }, "DesiredValue": { @@ -1833,7 +1953,7 @@ "Created": { "target": "com.amazonaws.servicequotas#DateTime", "traits": { - "smithy.api#documentation": "The date and time when the quota increase request was received and the case ID was\n created.
" + "smithy.api#documentation": "The date and time when the quota increase request was received and the case ID was\n created.
" } }, "LastUpdated": { @@ -1866,6 +1986,18 @@ "traits": { "smithy.api#documentation": "The unit of measurement.
" } + }, + "QuotaRequestedAtLevel": { + "target": "com.amazonaws.servicequotas#AppliedLevelEnum", + "traits": { + "smithy.api#documentation": "Specifies at which level within the Amazon Web Services account the quota request applies to.
" + } + }, + "QuotaContext": { + "target": "com.amazonaws.servicequotas#QuotaContextInfo", + "traits": { + "smithy.api#documentation": "The context for this service quota.
" + } } }, "traits": { @@ -1923,18 +2055,18 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "The service identifier.
" + "smithy.api#documentation": "Specifies the service identifier. To find the service code value \n for an Amazon Web Services service, use the ListServices operation.
" } }, "ServiceName": { "target": "com.amazonaws.servicequotas#ServiceName", "traits": { - "smithy.api#documentation": "The service name.
" + "smithy.api#documentation": "Specifies the service name.
" } } }, "traits": { - "smithy.api#documentation": "Information about a service.
" + "smithy.api#documentation": "Information about an Amazon Web Service.
" } }, "com.amazonaws.servicequotas#ServiceInfoListDefinition": { @@ -1952,13 +2084,13 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "The service identifier.
" + "smithy.api#documentation": "Specifies the service identifier. To find the service code value \n for an Amazon Web Services service, use the ListServices operation.
" } }, "ServiceName": { "target": "com.amazonaws.servicequotas#ServiceName", "traits": { - "smithy.api#documentation": "The service name.
" + "smithy.api#documentation": "Specifies the service name.
" } }, "QuotaArn": { @@ -1970,13 +2102,13 @@ "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "The quota identifier.
" + "smithy.api#documentation": "Specifies the quota identifier. To find the quota code for a specific \n quota, use the ListServiceQuotas operation, and look for the\n QuotaCode response in the output for the quota you want.
The quota name.
" + "smithy.api#documentation": "Specifies the quota name.
" } }, "Value": { @@ -2022,6 +2154,18 @@ "traits": { "smithy.api#documentation": "The error code and error reason.
" } + }, + "QuotaAppliedAtLevel": { + "target": "com.amazonaws.servicequotas#AppliedLevelEnum", + "traits": { + "smithy.api#documentation": "Specifies at which level of granularity that the quota value is applied.
" + } + }, + "QuotaContext": { + "target": "com.amazonaws.servicequotas#QuotaContextInfo", + "traits": { + "smithy.api#documentation": "The context for this service quota.
" + } } }, "traits": { @@ -2034,25 +2178,25 @@ "ServiceCode": { "target": "com.amazonaws.servicequotas#ServiceCode", "traits": { - "smithy.api#documentation": "The service identifier.
" + "smithy.api#documentation": "Specifies the service identifier. To find the service code value \n for an Amazon Web Services service, use the ListServices operation.
" } }, "ServiceName": { "target": "com.amazonaws.servicequotas#ServiceName", "traits": { - "smithy.api#documentation": "The service name.
" + "smithy.api#documentation": "Specifies the service name.
" } }, "QuotaCode": { "target": "com.amazonaws.servicequotas#QuotaCode", "traits": { - "smithy.api#documentation": "The quota identifier.
" + "smithy.api#documentation": "Specifies the quota identifier. To find the quota code for a specific \n quota, use the ListServiceQuotas operation, and look for the\n QuotaCode response in the output for the quota you want.
The quota name.
" + "smithy.api#documentation": "Specifies the quota name.
" } }, "DesiredValue": { @@ -2064,7 +2208,7 @@ "AwsRegion": { "target": "com.amazonaws.servicequotas#AwsRegion", "traits": { - "smithy.api#documentation": "The AWS Region.
" + "smithy.api#documentation": "The Amazon Web Services Region.
" } }, "Unit": { @@ -2201,7 +2345,7 @@ "name": "servicequotas" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "With Service Quotas, you can view and manage your quotas easily as your AWS workloads\n grow. Quotas, also referred to as limits, are the maximum number of resources that you can\n create in your AWS account. For more information, see the Service Quotas User Guide.
", + "smithy.api#documentation": "With Service Quotas, you can view and manage your quotas easily as your Amazon Web Services workloads grow.\n Quotas, also referred to as limits, are the maximum number of resources that you can\n create in your Amazon Web Services account. For more information, see the Service Quotas User Guide.
", "smithy.api#title": "Service Quotas", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -3173,14 +3317,14 @@ "Key": { "target": "com.amazonaws.servicequotas#TagKey", "traits": { - "smithy.api#documentation": "A string that contains a tag key. The string length should be between 1 and 128\n characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . :\n / = + @.
", + "smithy.api#documentation": "A string that contains a tag key. The string length should be between 1 and 128\n characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _\n - . : / = + @.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.servicequotas#TagValue", "traits": { - "smithy.api#documentation": "A string that contains an optional tag value. The string length should be between 0 and\n 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ -\n . : / = + @.
", + "smithy.api#documentation": "A string that contains an optional tag value. The string length should be between 0\n and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special\n characters _ - . : / = + @.
", "smithy.api#required": {} } } @@ -3244,7 +3388,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds tags to the specified applied quota. You can include one or more tags to add to the\n quota.
" + "smithy.api#documentation": "Adds tags to the specified applied quota. You can include one or more tags to add to\n the quota.
" } }, "com.amazonaws.servicequotas#TagResourceRequest": { @@ -3253,7 +3397,7 @@ "ResourceARN": { "target": "com.amazonaws.servicequotas#AmazonResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the applied quota. You can get this information by\n using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the applied quota. You can get this information by\n using the Service Quotas console, or by listing the quotas using the list-service-quotas CLI command or the ListServiceQuotas Amazon Web Services API operation.
", "smithy.api#required": {} } }, @@ -3294,7 +3438,7 @@ } }, "traits": { - "smithy.api#documentation": "The Service Quotas template is not available in this AWS Region.
", + "smithy.api#documentation": "The Service Quotas template is not available in this Amazon Web Services Region.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -3307,7 +3451,7 @@ } }, "traits": { - "smithy.api#documentation": "Due to throttling, the request was denied. Slow down the rate of request calls, or request\n an increase for this quota.
", + "smithy.api#documentation": "Due to throttling, the request was denied. Slow down the rate of request calls, or\n request an increase for this quota.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -3320,7 +3464,7 @@ } }, "traits": { - "smithy.api#documentation": "You've exceeded the number of tags allowed for a resource. For more information, see\n Tag\n restrictions in the Service Quotas User Guide.
", + "smithy.api#documentation": "You've exceeded the number of tags allowed for a resource. For more information, see\n Tag\n restrictions in the Service Quotas User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3351,7 +3495,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes tags from the specified applied quota. You can specify one or more tags to\n remove.
" + "smithy.api#documentation": "Removes tags from the specified applied quota. You can specify one or more tags to\n remove.
" } }, "com.amazonaws.servicequotas#UntagResourceRequest": { @@ -3360,7 +3504,7 @@ "ResourceARN": { "target": "com.amazonaws.servicequotas#AmazonResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the applied quota that you want to untag. You can get\n this information by using the Service Quotas console, or by listing the quotas using the list-service-quotas AWS CLI command or the ListServiceQuotas AWS API operation.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the applied quota that you want to untag. You can\n get this information by using the Service Quotas console, or by listing the quotas using the\n list-service-quotas CLI command or the ListServiceQuotas Amazon Web Services API operation.
", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/ses.json b/codegen/sdk/aws-models/ses.json index 9d5e24dedf2..0585475f6b5 100644 --- a/codegen/sdk/aws-models/ses.json +++ b/codegen/sdk/aws-models/ses.json @@ -6424,6 +6424,7 @@ "arnNamespace": "ses", "cloudFormationName": "SES", "cloudTrailEventSource": "ses.amazonaws.com", + "docId": "email-2010-12-01", "endpointPrefix": "email" }, "aws.auth#sigv4": { diff --git a/codegen/sdk/aws-models/sesv2.json b/codegen/sdk/aws-models/sesv2.json index 3b4532c70aa..cc3ebfc3b29 100644 --- a/codegen/sdk/aws-models/sesv2.json +++ b/codegen/sdk/aws-models/sesv2.json @@ -370,6 +370,58 @@ "smithy.api#documentation": "Represents the body of the email message.
" } }, + "com.amazonaws.sesv2#Bounce": { + "type": "structure", + "members": { + "BounceType": { + "target": "com.amazonaws.sesv2#BounceType", + "traits": { + "smithy.api#documentation": "The type of the bounce, as determined by SES.\n Can be one of UNDETERMINED, TRANSIENT, or PERMANENT\n
The subtype of the bounce, as determined by SES.
" + } + }, + "DiagnosticCode": { + "target": "com.amazonaws.sesv2#DiagnosticCode", + "traits": { + "smithy.api#documentation": "The status code issued by the reporting Message Transfer Authority (MTA).\n This field only appears if a delivery status notification (DSN) was attached to the bounce\n and the Diagnostic-Code was provided in the DSN.\n
Information about a Bounce event.
Cancels an export job.
", + "smithy.api#examples": [ + { + "title": "Cancel export job", + "documentation": "Cancels the export job with ID ef28cf62-9d8e-4b60-9283-b09816c99a99", + "input": { + "JobId": "ef28cf62-9d8e-4b60-9283-b09816c99a99" + } + } + ], + "smithy.api#http": { + "method": "PUT", + "uri": "/v2/email/export-jobs/{JobId}/cancel", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#CancelExportJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.sesv2#JobId", + "traits": { + "smithy.api#documentation": "The export job ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a request to cancel an export job using the export job ID.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#CancelExportJobResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "An HTTP 200 response if the request succeeds, or an error message if the request\n fails.
", + "smithy.api#output": {} + } + }, "com.amazonaws.sesv2#CaseId": { "type": "string" }, @@ -600,6 +714,32 @@ "target": "com.amazonaws.sesv2#CloudWatchDimensionConfiguration" } }, + "com.amazonaws.sesv2#Complaint": { + "type": "structure", + "members": { + "ComplaintSubType": { + "target": "com.amazonaws.sesv2#ComplaintSubType", + "traits": { + "smithy.api#documentation": "\n Can either be null or OnAccountSuppressionList.\n If the value is OnAccountSuppressionList, SES accepted the message,\n but didn't attempt to send it because it was on the account-level suppression list.\n
\n The value of the Feedback-Type field from the feedback report received from the ISP.\n
Information about a Complaint event.
Creates an export job for a data source and destination.
\nYou can execute this operation no more than once per second.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/email/export-jobs", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#CreateExportJobRequest": { + "type": "structure", + "members": { + "ExportDataSource": { + "target": "com.amazonaws.sesv2#ExportDataSource", + "traits": { + "smithy.api#documentation": "The data source for the export job.
", + "smithy.api#required": {} + } + }, + "ExportDestination": { + "target": "com.amazonaws.sesv2#ExportDestination", + "traits": { + "smithy.api#documentation": "The destination for the export job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a request to create an export job from a data source to a data\n destination.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#CreateExportJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.sesv2#JobId", + "traits": { + "smithy.api#documentation": "A string that represents the export job ID.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An HTTP 200 response if the request succeeds, or an error message if the request\n fails.
", + "smithy.api#output": {} + } + }, "com.amazonaws.sesv2#CreateImportJob": { "type": "operation", "input": { @@ -1805,7 +2014,7 @@ } }, "traits": { - "smithy.api#documentation": "The data format of the import job's data source.
" + "smithy.api#documentation": "The data format of a file, can be one of the following:
\n\n CSV – A comma-separated values file.
\n JSON – A JSON file.
The subject line for an email that you submitted in a predictive inbox placement test.
" } }, + "com.amazonaws.sesv2#DeliveryEventType": { + "type": "enum", + "members": { + "SEND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SEND" + } + }, + "DELIVERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELIVERY" + } + }, + "TRANSIENT_BOUNCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIENT_BOUNCE" + } + }, + "PERMANENT_BOUNCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERMANENT_BOUNCE" + } + }, + "UNDETERMINED_BOUNCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNDETERMINED_BOUNCE" + } + }, + "COMPLAINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLAINT" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of delivery events:
\n\n SEND - The send request was successful and SES will\n attempt to deliver the message to the recipient’s mail server. (If account-level\n or global suppression is being used, SES will still count it as a send,\n but delivery is suppressed.)
\n DELIVERY - SES successfully delivered the email to the\n recipient's mail server. Excludes deliveries to the mailbox simulator and\n emails addressed to more than one recipient.
\n TRANSIENT_BOUNCE - Feedback received for\n delivery failures excluding issues with non-existent mailboxes. Excludes bounces from the\n mailbox simulator, and those from emails addressed to more than one recipient.
\n PERMANENT_BOUNCE - Feedback received for\n emails sent to non-existent mailboxes. Excludes bounces from the mailbox simulator, those\n originating from your account-level suppression list (if enabled), and those from emails\n addressed to more than one recipient.
\n UNDETERMINED_BOUNCE - SES was unable to determine the bounce reason.
\n COMPLAINT - Complaint received for the email.\n This excludes complaints from the mailbox simulator, those originating from\n your account-level suppression list (if enabled), and those from emails addressed to more\n than one recipient.
An object that describes the recipients for an email.
\nAmazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the\n local part of a destination email address (the part of the\n email address that precedes the @ sign) may only contain 7-bit ASCII\n characters. If the domain part of an address (the\n part after the @ sign) contains non-ASCII characters, they must be encoded using\n Punycode, as described in RFC3492.
\nAn object that defines the entire content of the email, including the message headers\n and the body content. You can create a simple email message, in which you specify the\n subject and the text and HTML versions of the message body. You can also create raw\n messages, in which you specify a complete MIME-formatted message. Raw messages can\n include attachments and custom headers.
" } }, + "com.amazonaws.sesv2#EmailInsights": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.sesv2#InsightsEmailAddress", + "traits": { + "smithy.api#documentation": "The recipient of the email.
" + } + }, + "Isp": { + "target": "com.amazonaws.sesv2#Isp", + "traits": { + "smithy.api#documentation": "The recipient's ISP (e.g., Gmail, Yahoo,\n etc.).
A list of events associated with the sent email.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An email's insights contain metadata and delivery information about a specific email.
" + } + }, + "com.amazonaws.sesv2#EmailInsightsList": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#EmailInsights" + } + }, + "com.amazonaws.sesv2#EmailSubject": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 998 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sesv2#EmailSubjectFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#EmailSubject" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.sesv2#EmailTemplateContent": { "type": "structure", "members": { @@ -3120,20 +3442,40 @@ "com.amazonaws.sesv2#EnabledWrapper": { "type": "boolean" }, - "com.amazonaws.sesv2#ErrorMessage": { - "type": "string" - }, - "com.amazonaws.sesv2#Esp": { - "type": "string" - }, - "com.amazonaws.sesv2#Esps": { - "type": "list", - "member": { - "target": "com.amazonaws.sesv2#Esp" - } - }, - "com.amazonaws.sesv2#EventDestination": { - "type": "structure", + "com.amazonaws.sesv2#EngagementEventType": { + "type": "enum", + "members": { + "OPEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OPEN" + } + }, + "CLICK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLICK" + } + } + }, + "traits": { + "smithy.api#documentation": "The type of delivery events:
\n\n OPEN - Open event for emails including open trackers.\n Excludes opens for emails addressed to more than one recipient.
\n CLICK - Click event for emails including wrapped links.\n Excludes clicks for emails addressed to more than one recipient.
Information about a Bounce event.
Information about a Complaint event.
\n Contains a Bounce object if the event type is BOUNCE.\n Contains a Complaint object if the event type is COMPLAINT.\n
An object that contains details about the data source of the export job. It can only\n contain one of MetricsDataSource or MessageInsightsDataSource object.
The data format of the final export job file, can be one of the following:
\n\n CSV - A comma-separated values file.
\n JSON - A Json file.
An Amazon S3 pre-signed URL that points to the generated export file.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains details about the destination of the export job.
" + } + }, + "com.amazonaws.sesv2#ExportDimensionValue": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#MetricDimensionValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.sesv2#ExportDimensions": { + "type": "map", + "key": { + "target": "com.amazonaws.sesv2#MetricDimensionName" + }, + "value": { + "target": "com.amazonaws.sesv2#ExportDimensionValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.sesv2#ExportJobSummary": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.sesv2#JobId", + "traits": { + "smithy.api#documentation": "The export job ID.
" + } + }, + "ExportSourceType": { + "target": "com.amazonaws.sesv2#ExportSourceType", + "traits": { + "smithy.api#documentation": "The source type of the export job.
" + } + }, + "JobStatus": { + "target": "com.amazonaws.sesv2#JobStatus", + "traits": { + "smithy.api#documentation": "The status of the export job.
" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the export job was created.
" + } + }, + "CompletedTimestamp": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the export job was completed.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A summary of the export job.
" + } + }, + "com.amazonaws.sesv2#ExportJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#ExportJobSummary" + }, + "traits": { + "smithy.api#documentation": "A list of the export job summaries.
" + } + }, + "com.amazonaws.sesv2#ExportMetric": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.sesv2#Metric" + }, + "Aggregation": { + "target": "com.amazonaws.sesv2#MetricAggregation" + } + }, + "traits": { + "smithy.api#documentation": "An object that contains a mapping between a Metric and\n MetricAggregation.
The type of data source of an export, can be one of the following:
\n\n METRICS_DATA - The metrics export.
\n MESSAGE_INSIGHTS - The Message Insights export.
The number of records that were processed to generate the final export file.
" + } + }, + "ExportedRecordsCount": { + "target": "com.amazonaws.sesv2#ExportedRecordsCount", + "traits": { + "smithy.api#documentation": "The number of records that were exported to the final export file.
\nThis value might not be available for all export source types
" + } + } + }, + "traits": { + "smithy.api#documentation": "Statistics about the execution of an export job.
" + } + }, + "com.amazonaws.sesv2#ExportedRecordsCount": { + "type": "integer" + }, "com.amazonaws.sesv2#FailedRecordsCount": { "type": "integer" }, @@ -3328,18 +3868,18 @@ "FailedRecordsS3Url": { "target": "com.amazonaws.sesv2#FailedRecordsS3Url", "traits": { - "smithy.api#documentation": "An Amazon S3 presigned URL that contains all the failed records and related\n information.
" + "smithy.api#documentation": "An Amazon S3 pre-signed URL that contains all the failed records and related information.
" } }, "ErrorMessage": { "target": "com.amazonaws.sesv2#ErrorMessage", "traits": { - "smithy.api#documentation": "A message about why the import job failed.
" + "smithy.api#documentation": "A message about why the job failed.
" } } }, "traits": { - "smithy.api#documentation": "An object that contains the failure details about an import job.
" + "smithy.api#documentation": "An object that contains the failure details about a job.
" } }, "com.amazonaws.sesv2#FailureRedirectionURL": { @@ -4725,6 +5265,114 @@ "smithy.api#output": {} } }, + "com.amazonaws.sesv2#GetExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#GetExportJobRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#GetExportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#NotFoundException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Provides information about an export job.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/email/export-jobs/{JobId}", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#GetExportJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.sesv2#JobId", + "traits": { + "smithy.api#documentation": "The export job ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a request to retrieve information about an export job using the export job\n ID.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#GetExportJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.sesv2#JobId", + "traits": { + "smithy.api#documentation": "The export job ID.
" + } + }, + "ExportSourceType": { + "target": "com.amazonaws.sesv2#ExportSourceType", + "traits": { + "smithy.api#documentation": "The type of source of the export job.
" + } + }, + "JobStatus": { + "target": "com.amazonaws.sesv2#JobStatus", + "traits": { + "smithy.api#documentation": "The status of the export job.
" + } + }, + "ExportDestination": { + "target": "com.amazonaws.sesv2#ExportDestination", + "traits": { + "smithy.api#documentation": "The destination of the export job.
" + } + }, + "ExportDataSource": { + "target": "com.amazonaws.sesv2#ExportDataSource", + "traits": { + "smithy.api#documentation": "The data source of the export job.
" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the export job was created.
" + } + }, + "CompletedTimestamp": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the export job was completed.
" + } + }, + "FailureInfo": { + "target": "com.amazonaws.sesv2#FailureInfo", + "traits": { + "smithy.api#documentation": "The failure details about an export job.
" + } + }, + "Statistics": { + "target": "com.amazonaws.sesv2#ExportStatistics", + "traits": { + "smithy.api#documentation": "The statistics about the export job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An HTTP 200 response if the request succeeds, or an error message if the request\n fails.
", + "smithy.api#output": {} + } + }, "com.amazonaws.sesv2#GetImportJob": { "type": "operation", "input": { @@ -4821,15 +5469,99 @@ "smithy.api#documentation": "The current number of records processed.
" } }, - "FailedRecordsCount": { - "target": "com.amazonaws.sesv2#FailedRecordsCount", + "FailedRecordsCount": { + "target": "com.amazonaws.sesv2#FailedRecordsCount", + "traits": { + "smithy.api#documentation": "The number of records that failed processing because of invalid input or other\n reasons.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An HTTP 200 response if the request succeeds, or an error message if the request\n fails.
", + "smithy.api#output": {} + } + }, + "com.amazonaws.sesv2#GetMessageInsights": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#GetMessageInsightsRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#GetMessageInsightsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#NotFoundException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Provides information about a specific message, including the from address, the\n subject, the recipient address, email tags, as well as events associated with the message.
\nYou can execute this operation no more than once per second.
", + "smithy.api#http": { + "method": "GET", + "uri": "/v2/email/insights/{MessageId}", + "code": 200 + } + } + }, + "com.amazonaws.sesv2#GetMessageInsightsRequest": { + "type": "structure", + "members": { + "MessageId": { + "target": "com.amazonaws.sesv2#OutboundMessageId", + "traits": { + "smithy.api#documentation": "\n A MessageId is a unique identifier for a message, and is\n returned when sending emails through Amazon SES.\n
A request to return information about a message.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#GetMessageInsightsResponse": { + "type": "structure", + "members": { + "MessageId": { + "target": "com.amazonaws.sesv2#OutboundMessageId", + "traits": { + "smithy.api#documentation": "A unique identifier for the message.
" + } + }, + "FromEmailAddress": { + "target": "com.amazonaws.sesv2#InsightsEmailAddress", + "traits": { + "smithy.api#documentation": "The from address used to send the message.
" + } + }, + "Subject": { + "target": "com.amazonaws.sesv2#EmailSubject", + "traits": { + "smithy.api#documentation": "The subject line of the message.
" + } + }, + "EmailTags": { + "target": "com.amazonaws.sesv2#MessageTagList", + "traits": { + "smithy.api#documentation": "\n A list of tags, in the form of name/value pairs, that were applied to the email you sent, along with Amazon SES\n Auto-Tags.\n
" + } + }, + "Insights": { + "target": "com.amazonaws.sesv2#EmailInsightsList", "traits": { - "smithy.api#documentation": "The number of records that failed processing because of invalid input or other\n reasons.
" + "smithy.api#documentation": "A set of insights associated with the message.
" } } }, "traits": { - "smithy.api#documentation": "An HTTP 200 response if the request succeeds, or an error message if the request\n fails.
", + "smithy.api#documentation": "Information about a message.
", "smithy.api#output": {} } }, @@ -5122,6 +5854,48 @@ "smithy.api#documentation": "An object that contains information about the inbox placement data settings for a\n verified domain that’s associated with your Amazon Web Services account. This data is available only\n if you enabled the Deliverability dashboard for the domain.
" } }, + "com.amazonaws.sesv2#InsightsEmailAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 320 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.sesv2#InsightsEvent": { + "type": "structure", + "members": { + "Timestamp": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the event.
" + } + }, + "Type": { + "target": "com.amazonaws.sesv2#EventType", + "traits": { + "smithy.api#documentation": "The type of event:
\n\n SEND - The send request was successful and SES will\n attempt to deliver the message to the recipient’s mail server. (If account-level\n or global suppression is being used, SES will still count it as a send,\n but delivery is suppressed.)\n
\n DELIVERY - SES successfully delivered the email to the\n recipient's mail server. Excludes deliveries to the mailbox simulator,\n and those from emails addressed to more than one recipient.\n
\n BOUNCE - Feedback received for delivery failures. Additional details about the bounce are provided in the Details object.\n Excludes bounces from the mailbox simulator, and those from emails addressed to more than one recipient.\n
\n COMPLAINT - Complaint received for the email. Additional details about the complaint are provided in the Details object.\n This excludes complaints from the mailbox simulator, those originating from\n your account-level suppression list (if enabled), and those from emails addressed\n to more than one recipient.\n
\n OPEN - Open event for emails including open trackers.\n Excludes opens for emails addressed to more than one recipient.
\n CLICK - Click event for emails including wrapped links.\n Excludes clicks for emails addressed to more than one recipient.
Details about bounce or complaint events.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing details about a specific event.
" + } + }, + "com.amazonaws.sesv2#InsightsEvents": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#InsightsEvent" + } + }, "com.amazonaws.sesv2#InternalServiceErrorException": { "type": "structure", "members": { @@ -5160,6 +5934,21 @@ "target": "com.amazonaws.sesv2#Ip" } }, + "com.amazonaws.sesv2#Isp": { + "type": "string" + }, + "com.amazonaws.sesv2#IspFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#Isp" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, "com.amazonaws.sesv2#IspName": { "type": "string", "traits": { @@ -5201,7 +5990,7 @@ "com.amazonaws.sesv2#JobId": { "type": "string", "traits": { - "smithy.api#documentation": "A string that represents the import job ID.
", + "smithy.api#documentation": "A string that represents a job ID.
", "smithy.api#length": { "min": 1 } @@ -5233,10 +6022,16 @@ "traits": { "smithy.api#enumValue": "FAILED" } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } } }, "traits": { - "smithy.api#documentation": "The status of the import job.
" + "smithy.api#documentation": "The status of a job.
\n\n CREATED – Job has just been created.
\n PROCESSING – Job is processing.
\n ERROR – An error occurred during processing.
\n COMPLETED – Job has completed processing successfully.
An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to\n stream data to other services, such as Amazon S3 and Amazon Redshift.
" } }, + "com.amazonaws.sesv2#LastDeliveryEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#DeliveryEventType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.sesv2#LastEngagementEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.sesv2#EngagementEventType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, "com.amazonaws.sesv2#LastFreshStart": { "type": "timestamp", "traits": { @@ -6011,6 +6830,90 @@ "smithy.api#output": {} } }, + "com.amazonaws.sesv2#ListExportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.sesv2#ListExportJobsRequest" + }, + "output": { + "target": "com.amazonaws.sesv2#ListExportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.sesv2#BadRequestException" + }, + { + "target": "com.amazonaws.sesv2#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all of the export jobs.
", + "smithy.api#http": { + "method": "POST", + "uri": "/v2/email/list-export-jobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "PageSize" + } + } + }, + "com.amazonaws.sesv2#ListExportJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.sesv2#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token returned from a previous call to ListExportJobs to\n indicate the position in the list of export jobs.
Maximum number of export jobs to return at once. Use this parameter to paginate\n results. If additional export jobs exist beyond the specified limit, the\n NextToken element is sent in the response. Use the\n NextToken value in subsequent calls to ListExportJobs to\n retrieve additional export jobs.
A value used to list export jobs that have a certain\n ExportSourceType.
A value used to list export jobs that have a certain JobStatus.
Represents a request to list all export jobs with filters.
", + "smithy.api#input": {} + } + }, + "com.amazonaws.sesv2#ListExportJobsResponse": { + "type": "structure", + "members": { + "ExportJobs": { + "target": "com.amazonaws.sesv2#ExportJobSummaryList", + "traits": { + "smithy.api#documentation": "A list of the export job summaries.
" + } + }, + "NextToken": { + "target": "com.amazonaws.sesv2#NextToken", + "traits": { + "smithy.api#documentation": "A string token indicating that there might be additional export jobs available to be\n listed. Use this token to a subsequent call to ListExportJobs with the same\n parameters to retrieve the next page of export jobs.
An HTTP 200 response if the request succeeds, or an error message if the request\n fails.
", + "smithy.api#output": {} + } + }, "com.amazonaws.sesv2#ListImportJobs": { "type": "operation", "input": { @@ -6571,6 +7474,99 @@ "com.amazonaws.sesv2#MessageData": { "type": "string" }, + "com.amazonaws.sesv2#MessageInsightsDataSource": { + "type": "structure", + "members": { + "StartDate": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "Represents the start date for the export interval as a timestamp. The start date is inclusive.
", + "smithy.api#required": {} + } + }, + "EndDate": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "Represents the end date for the export interval as a timestamp. The end date is inclusive.
", + "smithy.api#required": {} + } + }, + "Include": { + "target": "com.amazonaws.sesv2#MessageInsightsFilters", + "traits": { + "smithy.api#documentation": "Filters for results to be included in the export file.
" + } + }, + "Exclude": { + "target": "com.amazonaws.sesv2#MessageInsightsFilters", + "traits": { + "smithy.api#documentation": "Filters for results to be excluded from the export file.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.sesv2#MessageInsightsExportMaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains filters applied when performing the Message Insights export.
" + } + }, + "com.amazonaws.sesv2#MessageInsightsExportMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10000 + } + } + }, + "com.amazonaws.sesv2#MessageInsightsFilters": { + "type": "structure", + "members": { + "FromEmailAddress": { + "target": "com.amazonaws.sesv2#EmailAddressFilterList", + "traits": { + "smithy.api#documentation": "The from address used to send the message.
" + } + }, + "Destination": { + "target": "com.amazonaws.sesv2#EmailAddressFilterList", + "traits": { + "smithy.api#documentation": "The recipient's email address.
" + } + }, + "Subject": { + "target": "com.amazonaws.sesv2#EmailSubjectFilterList", + "traits": { + "smithy.api#documentation": "The subject line of the message.
" + } + }, + "Isp": { + "target": "com.amazonaws.sesv2#IspFilterList", + "traits": { + "smithy.api#documentation": "The recipient's ISP (e.g., Gmail, Yahoo,\n etc.).
\n The last delivery-related event for the email, where the ordering is as follows:\n SEND < BOUNCE < DELIVERY < COMPLAINT.\n
\n The last engagement-related event for the email, where the ordering is as follows:\n OPEN < CLICK.\n
\n Engagement events are only available if Engagement tracking\n is enabled.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object containing Message Insights filters.
\nIf you specify multiple filters, the filters are joined by AND.
\nIf you specify multiple values for a filter, the values are joined by OR. Filter values are case-sensitive.
\n\n FromEmailAddress, Destination, and Subject filters support partial match.\n A partial match is performed by using the * wildcard character placed at the beginning (suffix match), the end (prefix match)\n or both ends of the string (contains match).\n In order to match the literal characters * or \\, they must be escaped using the \\ character.\n If no wildcard character is present, an exact match is performed.\n
The metric to export, can be one of the following:
\n\n SEND - Emails sent eligible for tracking in the VDM\n dashboard. This excludes emails sent to the mailbox simulator and emails\n addressed to more than one recipient.
\n COMPLAINT - Complaints received for your account. This\n excludes complaints from the mailbox simulator, those originating from your\n account-level suppression list (if enabled), and those for emails addressed to\n more than one recipient
\n PERMANENT_BOUNCE - Permanent bounces - i.e., feedback\n received for emails sent to non-existent mailboxes. Excludes bounces from the\n mailbox simulator, those originating from your account-level suppression list\n (if enabled), and those for emails addressed to more than one recipient.
\n TRANSIENT_BOUNCE - Transient bounces - i.e., feedback\n received for delivery failures excluding issues with non-existent mailboxes.\n Excludes bounces from the mailbox simulator, and those for emails addressed to\n more than one recipient.
\n OPEN - Unique open events for emails including open\n trackers. Excludes opens for emails addressed to more than one recipient.
\n CLICK - Unique click events for emails including wrapped\n links. Excludes clicks for emails addressed to more than one recipient.
\n DELIVERY - Successful deliveries for email sending\n attempts. Excludes deliveries to the mailbox simulator and for emails addressed\n to more than one recipient.
\n DELIVERY_OPEN - Successful deliveries for email sending\n attempts. Excludes deliveries to the mailbox simulator, for emails addressed to\n more than one recipient, and emails without open trackers.
\n DELIVERY_CLICK - Successful deliveries for email sending\n attempts. Excludes deliveries to the mailbox simulator, for emails addressed to\n more than one recipient, and emails without click trackers.
\n DELIVERY_COMPLAINT - Successful deliveries for email\n sending attempts. Excludes deliveries to the mailbox simulator, for emails\n addressed to more than one recipient, and emails addressed to recipients hosted\n by ISPs with which Amazon SES does not have a feedback loop agreement.
The aggregation to apply to a metric, can be one of the following:
\n\n VOLUME - The volume of events for this metric.
\n RATE - The rate for this metric relative to the\n SEND metric volume.
A list of values associated with the MetricDimensionName to filter\n metrics by. Can either be * as a wildcard for all values or a list of up to\n 10 specific values. If one Dimension has the * value, other\n dimensions can only contain one value.
An object that contains a mapping between a MetricDimensionName and\n MetricDimensionValue to filter metrics by. Must contain a least 1\n dimension but no more than 3 unique ones.
The metrics namespace - e.g., VDM.
A list of ExportMetric objects to export.
Represents the start date for the export interval as a timestamp.
", + "smithy.api#required": {} + } + }, + "EndDate": { + "target": "com.amazonaws.sesv2#Timestamp", + "traits": { + "smithy.api#documentation": "Represents the end date for the export interval as a timestamp.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains details about the data source for the metrics export.
" + } + }, "com.amazonaws.sesv2#NextToken": { "type": "string" }, @@ -8535,7 +9600,7 @@ "com.amazonaws.sesv2#S3Url": { "type": "string", "traits": { - "smithy.api#documentation": "An Amazon S3 URL in the format\n s3://
An Amazon S3 URL in the format s3://
Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP).\n
\nAfter you create an identity source, you can use the identities provided by the IdP as proxies\n for the principal in authorization queries that use the IsAuthorizedWithToken\n operation. These identities take the form of tokens that contain claims about the user,\n such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and\n access tokens, and Verified Permissions can use either or both. Any combination of identity and access\n tokens results in the same Cedar principal. Verified Permissions automatically translates the\n information about the identities into the standard Cedar attributes that can be\n evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain\n different information, the tokens you choose to use determine which principal attributes\n are available to access when evaluating Cedar policies.
\nIf you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.
\nTo reference a user from this identity source in your Cedar policies, use the following\n syntax.
\n\n IdentityType::\"<CognitoUserPoolIdentifier>|<CognitoClientId>\n
\nWhere IdentityType is the string that you provide to the\n PrincipalEntityType parameter for this operation. The\n CognitoUserPoolId and CognitoClientId are defined by\n the Amazon Cognito user pool.
Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP).\n
\nAfter you create an identity source, you can use the identities provided by the IdP as proxies\n for the principal in authorization queries that use the IsAuthorizedWithToken\n operation. These identities take the form of tokens that contain claims about the user,\n such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and\n access tokens, and Verified Permissions can use either or both. Any combination of identity and access\n tokens results in the same Cedar principal. Verified Permissions automatically translates the\n information about the identities into the standard Cedar attributes that can be\n evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain\n different information, the tokens you choose to use determine which principal attributes\n are available to access when evaluating Cedar policies.
\nIf you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire.
\nTo reference a user from this identity source in your Cedar policies, use the following\n syntax.
\n\n IdentityType::\"<CognitoUserPoolIdentifier>|<CognitoClientId>\n
\nWhere IdentityType is the string that you provide to the\n PrincipalEntityType parameter for this operation. The\n CognitoUserPoolId and CognitoClientId are defined by\n the Amazon Cognito user pool.
Verified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nCreates a Cedar policy and saves it in the specified policy store. You can create either a\n static policy or a policy linked to a policy template.
\nTo create a static policy, provide the Cedar policy text in the\n StaticPolicy section of the\n PolicyDefinition.
To create a policy that is dynamically linked to a policy template, specify the policy template ID\n and the principal and resource to associate with this policy in the\n templateLinked section of the PolicyDefinition. If the\n policy template is ever updated, any policies linked to the policy template automatically use the\n updated template.
Creating a policy causes it to be validated against the schema in the policy store. If the\n policy doesn't pass validation, the operation fails and the policy isn't\n stored.
\nCreates a Cedar policy and saves it in the specified policy store. You can create either a\n static policy or a policy linked to a policy template.
\nTo create a static policy, provide the Cedar policy text in the\n StaticPolicy section of the\n PolicyDefinition.
To create a policy that is dynamically linked to a policy template, specify the policy template ID\n and the principal and resource to associate with this policy in the\n templateLinked section of the PolicyDefinition. If the\n policy template is ever updated, any policies linked to the policy template automatically use the\n updated template.
Creating a policy causes it to be validated against the schema in the policy store. If the\n policy doesn't pass validation, the operation fails and the policy isn't\n stored.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nCreates a policy store. A policy store is a container for policy resources.
\nAlthough Cedar\n supports multiple namespaces, Verified Permissions currently supports only one\n namespace per policy store.
\nCreates a policy store. A policy store is a container for policy resources.
\nAlthough Cedar\n supports multiple namespaces, Verified Permissions currently supports only one\n namespace per policy store.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nCreates a policy template. A template can use placeholders for the principal and resource. A\n template must be instantiated into a policy by associating it with specific principals\n and resources to use for the placeholders. That instantiated policy can then be\n considered in authorization decisions. The instantiated policy works identically to any\n other policy, except that it is dynamically linked to the template. If the template\n changes, then any policies that are linked to that template are immediately updated as\n well.
", + "smithy.api#documentation": "Creates a policy template. A template can use placeholders for the principal and resource. A\n template must be instantiated into a policy by associating it with specific principals\n and resources to use for the placeholders. That instantiated policy can then be\n considered in authorization decisions. The instantiated policy works identically to any\n other policy, except that it is dynamically linked to the template. If the template\n changes, then any policies that are linked to that template are immediately updated as\n well.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nContains information about an entity that can be referenced in a Cedar\n policy.
\nThis data type is used as one of the fields in the EntitiesDefinition\n structure.
\n\n { \"id\": { \"entityType\": \"Photo\", \"entityId\": \"VacationPhoto94.jpg\" },\n \"Attributes\": {}, \"Parents\": [ { \"entityType\": \"Album\", \"entityId\": \"alice_folder\" }\n ] }\n
Contains information about an entity that can be referenced in a Cedar\n policy.
\nThis data type is used as one of the fields in the EntitiesDefinition\n structure.
\n\n { \"identifier\": { \"entityType\": \"Photo\", \"entityId\": \"VacationPhoto94.jpg\" },\n \"attributes\": {}, \"parents\": [ { \"entityType\": \"Album\", \"entityId\": \"alice_folder\" }\n ] }\n
Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.
If you do not specify this parameter, the operation defaults to 10 policy stores per\n response. You can specify a maximum of 50 policy stores per response.
" + "smithy.api#documentation": "Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.
If you do not specify this parameter, the operation defaults to 10 policy stores per response.\n You can specify a maximum of 50 policy stores per response.
" } } }, @@ -2086,7 +2086,7 @@ "maxResults": { "target": "com.amazonaws.verifiedpermissions#MaxResults", "traits": { - "smithy.api#documentation": "Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.
If you do not specify this parameter, the operation defaults to 10 policy templates per\n response. You can specify a maximum of 50 policy templates per response.
" + "smithy.api#documentation": "Specifies the total number of results that you want included in each\n response. If additional items exist beyond the number you specify, the \n NextToken response element is returned with a value (not null). Include the\n specified value as the NextToken request parameter in the next call to the\n operation to get the next set of results. Note that the service might return fewer\n results than the maximum even when there are more results available. You should check \n NextToken after every operation to ensure that you receive all of the\n results.
If you do not specify this parameter, the operation defaults to 10 policy templates per response.\n You can specify a maximum of 50 policy templates per response.
" } } }, @@ -2642,7 +2642,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create or update the policy schema in the specified policy store", - "smithy.api#documentation": "Creates or updates the policy schema in the specified policy store. The schema is used to\n validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema\n validate only policies and templates submitted after the schema change. Existing\n policies and templates are not re-evaluated against the changed schema. If you later\n update a policy, then it is evaluated against the new schema at that time.
", + "smithy.api#documentation": "Creates or updates the policy schema in the specified policy store. The schema is used to\n validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema\n validate only policies and templates submitted after the schema change. Existing\n policies and templates are not re-evaluated against the changed schema. If you later\n update a policy, then it is evaluated against the new schema at that time.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nUpdates the specified identity source to use a new identity provider (IdP) source, or to change\n the mapping of identities from the IdP to a different principal entity type.
", + "smithy.api#documentation": "Updates the specified identity source to use a new identity provider (IdP) source, or to change\n the mapping of identities from the IdP to a different principal entity type.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nModifies a Cedar static policy in the specified policy store. You can change only certain elements of\n the UpdatePolicyDefinition parameter. You can directly update only static policies. To\n change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate.
\nIf policy validation is enabled in the policy store, then updating a static policy causes\n Verified Permissions to validate the policy against the schema in the policy store. If the updated\n static policy doesn't pass validation, the operation fails and the update isn't\n stored.
\nWhen you edit a static policy, You can change only certain elements of a static\n policy:
\nThe action referenced by the policy.
\nA condition clause, such as when and unless.
\nYou can't change these elements of a static policy:
\nChanging a policy from a static policy to a template-linked\n policy.
\nChanging the effect of a static policy from permit or forbid.\n
\nThe principal referenced by a static policy.
\nThe resource referenced by a static policy.
\nTo update a template-linked policy, you must update the template instead.
\nModifies a Cedar static policy in the specified policy store. You can change only certain elements of\n the UpdatePolicyDefinition parameter. You can directly update only static policies. To\n change a template-linked policy, you must update the template instead, using UpdatePolicyTemplate.
\nIf policy validation is enabled in the policy store, then updating a static policy causes\n Verified Permissions to validate the policy against the schema in the policy store. If the updated\n static policy doesn't pass validation, the operation fails and the update isn't\n stored.
\nWhen you edit a static policy, You can change only certain elements of a static\n policy:
\nThe action referenced by the policy.
\nA condition clause, such as when and unless.
\nYou can't change these elements of a static policy:
\nChanging a policy from a static policy to a template-linked\n policy.
\nChanging the effect of a static policy from permit or forbid.\n
\nThe principal referenced by a static policy.
\nThe resource referenced by a static policy.
\nTo update a template-linked policy, you must update the template instead.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nModifies the validation setting for a policy store.
", + "smithy.api#documentation": "Modifies the validation setting for a policy store.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nUpdates the specified policy template. You can update only the description and the some elements\n of the policyBody.
\nChanges you make to the policy template content are immediately reflected in authorization\n decisions that involve all template-linked policies instantiated from this template.
\nUpdates the specified policy template. You can update only the description and the some elements\n of the policyBody.
\nChanges you make to the policy template content are immediately reflected in authorization\n decisions that involve all template-linked policies instantiated from this template.
\nVerified Permissions is \n eventually consistent\n . It can take a few seconds for a new or changed element to be propagate through\n the service and be visible in the results of other Verified Permissions operations.
\nThe ARN of the browser settings.
", "smithy.api#httpQuery": "browserSettingsArn", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#AssociateBrowserSettingsResponse": { @@ -955,6 +821,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#AssociateIpAccessSettings": { @@ -1009,6 +878,7 @@ "ipAccessSettingsArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { + "aws.cloudformation#cfnMutability": "full", "smithy.api#documentation": "The ARN of the IP access settings.
", "smithy.api#httpQuery": "ipAccessSettingsArn", "smithy.api#required": {} @@ -1093,11 +963,15 @@ "networkSettingsArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { + "aws.cloudformation#cfnMutability": "full", "smithy.api#documentation": "The ARN of the network settings.
", "smithy.api#httpQuery": "networkSettingsArn", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#AssociateNetworkSettingsResponse": { @@ -1117,6 +991,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#AssociateTrustStore": { @@ -1168,11 +1045,15 @@ "trustStoreArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { + "aws.cloudformation#cfnMutability": "full", "smithy.api#documentation": "The ARN of the trust store.
", "smithy.api#httpQuery": "trustStoreArn", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#AssociateTrustStoreResponse": { @@ -1192,6 +1073,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#AssociateUserAccessLoggingSettings": { @@ -1246,11 +1130,15 @@ "userAccessLoggingSettingsArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { + "aws.cloudformation#cfnMutability": "full", "smithy.api#documentation": "The ARN of the user access logging settings.
", "smithy.api#httpQuery": "userAccessLoggingSettingsArn", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#AssociateUserAccessLoggingSettingsResponse": { @@ -1270,6 +1158,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#AssociateUserSettings": { @@ -1324,11 +1215,15 @@ "userSettingsArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { + "aws.cloudformation#cfnMutability": "full", "smithy.api#documentation": "The ARN of the user settings.
", "smithy.api#httpQuery": "userSettingsArn", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#AssociateUserSettingsResponse": { @@ -1348,6 +1243,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#AuthenticationType": { @@ -1383,7 +1281,8 @@ "target": "com.amazonaws.workspacesweb#ARN", "traits": { "smithy.api#documentation": "The ARN of the browser settings.
", - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "browserSettingsArn" } }, "associatedPortalArns": { @@ -1409,13 +1308,67 @@ "target": "com.amazonaws.workspacesweb#BrowserSettingsSummary" } }, + "com.amazonaws.workspacesweb#BrowserSettingsResource": { + "type": "resource", + "identifiers": { + "browserSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN" + } + }, + "properties": { + "tags": { + "target": "com.amazonaws.workspacesweb#TagList" + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn" + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap" + }, + "browserPolicy": { + "target": "com.amazonaws.workspacesweb#BrowserPolicy" + }, + "associatedPortalArns": { + "target": "com.amazonaws.workspacesweb#ArnList" + } + }, + "create": { + "target": "com.amazonaws.workspacesweb#CreateBrowserSettings" + }, + "read": { + "target": "com.amazonaws.workspacesweb#GetBrowserSettings" + }, + "update": { + "target": "com.amazonaws.workspacesweb#UpdateBrowserSettings" + }, + "delete": { + "target": "com.amazonaws.workspacesweb#DeleteBrowserSettings" + }, + "list": { + "target": "com.amazonaws.workspacesweb#ListBrowserSettings" + }, + "traits": { + "aws.api#arn": { + "template": "{browserSettingsArn}", + "absolute": true + }, + "aws.api#taggable": { + "property": "tags" + }, + "aws.cloudformation#cfnResource": { + "name": "BrowserSettings" + } + } + }, "com.amazonaws.workspacesweb#BrowserSettingsSummary": { "type": "structure", "members": { "browserSettingsArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { - "smithy.api#documentation": "The ARN of the browser settings.
" + "smithy.api#documentation": "The ARN of the browser settings.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "browserSettingsArn" } } }, @@ -1591,6 +1544,96 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.workspacesweb#CookieDomain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 253 + }, + "smithy.api#pattern": "^(\\.?)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$" + } + }, + "com.amazonaws.workspacesweb#CookieName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.workspacesweb#CookiePath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + }, + "smithy.api#pattern": "^/(\\S)*$" + } + }, + "com.amazonaws.workspacesweb#CookieSpecification": { + "type": "structure", + "members": { + "domain": { + "target": "com.amazonaws.workspacesweb#CookieDomain", + "traits": { + "smithy.api#documentation": "The domain of the cookie.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.workspacesweb#CookieName", + "traits": { + "smithy.api#documentation": "The name of the cookie.
" + } + }, + "path": { + "target": "com.amazonaws.workspacesweb#CookiePath", + "traits": { + "smithy.api#documentation": "The path of the cookie.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a single cookie or set of cookies in an end user's browser.
" + } + }, + "com.amazonaws.workspacesweb#CookieSpecifications": { + "type": "list", + "member": { + "target": "com.amazonaws.workspacesweb#CookieSpecification" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.workspacesweb#CookieSynchronizationConfiguration": { + "type": "structure", + "members": { + "allowlist": { + "target": "com.amazonaws.workspacesweb#CookieSpecifications", + "traits": { + "smithy.api#documentation": "The list of cookie specifications that are allowed to be synchronized to the remote browser.
", + "smithy.api#required": {} + } + }, + "blocklist": { + "target": "com.amazonaws.workspacesweb#CookieSpecifications", + "traits": { + "smithy.api#documentation": "The list of cookie specifications that are blocked from being synchronized to the remote browser.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.workspacesweb#CreateBrowserSettings": { "type": "operation", "input": { @@ -1637,6 +1680,7 @@ "tags": { "target": "com.amazonaws.workspacesweb#TagList", "traits": { + "aws.cloudformation#cfnMutability": "full", "smithy.api#documentation": "The tags to add to the browser settings resource. A tag is a key-value pair.
" } }, @@ -1666,6 +1710,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#CreateBrowserSettingsResponse": { @@ -1678,6 +1725,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#CreateIdentityProvider": { @@ -1758,18 +1808,24 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#CreateIdentityProviderResponse": { "type": "structure", "members": { "identityProviderArn": { - "target": "com.amazonaws.workspacesweb#ARN", + "target": "com.amazonaws.workspacesweb#SubresourceARN", "traits": { "smithy.api#documentation": "The ARN of the identity provider.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#CreateIpAccessSettings": { @@ -1827,6 +1883,7 @@ "tags": { "target": "com.amazonaws.workspacesweb#TagList", "traits": { + "aws.cloudformation#cfnMutability": "full", "smithy.api#documentation": "The tags to add to the browser settings resource. A tag is a key-value pair.
" } }, @@ -1940,6 +1997,7 @@ "tags": { "target": "com.amazonaws.workspacesweb#TagList", "traits": { + "aws.cloudformation#cfnMutability": "full", "smithy.api#documentation": "The tags to add to the network settings resource. A tag is a key-value pair.
" } }, @@ -1950,6 +2008,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#CreateNetworkSettingsResponse": { @@ -1962,6 +2023,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#CreatePortal": { @@ -2016,6 +2080,7 @@ "tags": { "target": "com.amazonaws.workspacesweb#TagList", "traits": { + "aws.cloudformation#cfnMutability": "full", "smithy.api#documentation": "The tags to add to the web portal. A tag is a key-value pair.
" } }, @@ -2044,6 +2109,9 @@ "smithy.api#documentation": "The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM_Identity_Center web portals are authenticated through AWS IAM Identity\n Center (successor to AWS Single Sign-On). They provide additional features, such as\n IdP-initiated authentication. Identity sources (including external identity provider\n integration), plus user and group access to your web portal, can be configured in the IAM\n Identity Center.
The tags to add to the trust store. A tag is a key-value pair.
" } }, @@ -2125,6 +2197,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#CreateTrustStoreResponse": { @@ -2137,6 +2212,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#CreateUserAccessLoggingSettings": { @@ -2189,6 +2267,7 @@ "tags": { "target": "com.amazonaws.workspacesweb#TagList", "traits": { + "aws.cloudformation#cfnMutability": "full", "smithy.api#documentation": "The tags to add to the user settings resource. A tag is a key-value pair.
" } }, @@ -2199,6 +2278,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#CreateUserAccessLoggingSettingsResponse": { @@ -2211,6 +2293,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#CreateUserSettings": { @@ -2291,18 +2376,21 @@ "tags": { "target": "com.amazonaws.workspacesweb#TagList", "traits": { + "aws.cloudformation#cfnMutability": "full", "smithy.api#documentation": "The tags to add to the user settings resource. A tag is a key-value pair.
" } }, "disconnectTimeoutInMinutes": { "target": "com.amazonaws.workspacesweb#DisconnectTimeoutInMinutes", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect.
" } }, "idleDisconnectTimeoutInMinutes": { "target": "com.amazonaws.workspacesweb#IdleDisconnectTimeoutInMinutes", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" } }, @@ -2312,7 +2400,28 @@ "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token returns the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", "smithy.api#idempotencyToken": {} } + }, + "cookieSynchronizationConfiguration": { + "target": "com.amazonaws.workspacesweb#CookieSynchronizationConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
" + } + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn", + "traits": { + "smithy.api#documentation": "The customer managed key used to encrypt sensitive information in the user settings.
" + } + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap", + "traits": { + "smithy.api#documentation": "The additional encryption context of the user settings.
" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#CreateUserSettingsResponse": { @@ -2325,6 +2434,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#DeleteBrowserSettings": { @@ -2373,11 +2485,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#DeleteBrowserSettingsResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.workspacesweb#DeleteIdentityProvider": { "type": "operation", @@ -2418,18 +2536,24 @@ "type": "structure", "members": { "identityProviderArn": { - "target": "com.amazonaws.workspacesweb#ARN", + "target": "com.amazonaws.workspacesweb#SubresourceARN", "traits": { "smithy.api#documentation": "The ARN of the identity provider.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#DeleteIdentityProviderResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.workspacesweb#DeleteIpAccessSettings": { "type": "operation", @@ -2535,11 +2659,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#DeleteNetworkSettingsResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.workspacesweb#DeletePortal": { "type": "operation", @@ -2587,11 +2717,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#DeletePortalResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.workspacesweb#DeleteTrustStore": { "type": "operation", @@ -2639,11 +2775,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#DeleteTrustStoreResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.workspacesweb#DeleteUserAccessLoggingSettings": { "type": "operation", @@ -2691,11 +2833,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#DeleteUserAccessLoggingSettingsResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.workspacesweb#DeleteUserSettings": { "type": "operation", @@ -2743,11 +2891,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#DeleteUserSettingsResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.workspacesweb#Description": { "type": "string", @@ -2806,11 +2960,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#DisassociateBrowserSettingsResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.workspacesweb#DisassociateIpAccessSettings": { "type": "operation", @@ -2916,11 +3076,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#DisassociateNetworkSettingsResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.workspacesweb#DisassociateTrustStore": { "type": "operation", @@ -2968,11 +3134,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#DisassociateTrustStoreResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.workspacesweb#DisassociateUserAccessLoggingSettings": { "type": "operation", @@ -3020,11 +3192,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#DisassociateUserAccessLoggingSettingsResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.workspacesweb#DisassociateUserSettings": { "type": "operation", @@ -3072,11 +3250,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#DisassociateUserSettingsResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.workspacesweb#DisconnectTimeoutInMinutes": { "type": "integer", @@ -3174,6 +3358,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#GetBrowserSettingsResponse": { @@ -3182,9 +3369,13 @@ "browserSettings": { "target": "com.amazonaws.workspacesweb#BrowserSettings", "traits": { - "smithy.api#documentation": "The browser settings.
" + "smithy.api#documentation": "The browser settings.
", + "smithy.api#nestedProperties": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#GetIdentityProvider": { @@ -3226,13 +3417,16 @@ "type": "structure", "members": { "identityProviderArn": { - "target": "com.amazonaws.workspacesweb#ARN", + "target": "com.amazonaws.workspacesweb#SubresourceARN", "traits": { "smithy.api#documentation": "The ARN of the identity provider.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#GetIdentityProviderResponse": { @@ -3241,9 +3435,13 @@ "identityProvider": { "target": "com.amazonaws.workspacesweb#IdentityProvider", "traits": { - "smithy.api#documentation": "The identity provider.
" + "smithy.api#documentation": "The identity provider.
", + "smithy.api#nestedProperties": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#GetIpAccessSettings": { @@ -3303,7 +3501,8 @@ "ipAccessSettings": { "target": "com.amazonaws.workspacesweb#IpAccessSettings", "traits": { - "smithy.api#documentation": "The IP access settings.
" + "smithy.api#documentation": "The IP access settings.
", + "smithy.api#nestedProperties": {} } } }, @@ -3357,6 +3556,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#GetNetworkSettingsResponse": { @@ -3365,9 +3567,13 @@ "networkSettings": { "target": "com.amazonaws.workspacesweb#NetworkSettings", "traits": { - "smithy.api#documentation": "The network settings.
" + "smithy.api#documentation": "The network settings.
", + "smithy.api#nestedProperties": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#GetPortal": { @@ -3416,6 +3622,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#GetPortalResponse": { @@ -3424,9 +3633,13 @@ "portal": { "target": "com.amazonaws.workspacesweb#Portal", "traits": { - "smithy.api#documentation": "The web portal.
" + "smithy.api#documentation": "The web portal.
", + "smithy.api#nestedProperties": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#GetPortalServiceProviderMetadata": { @@ -3475,6 +3688,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#GetPortalServiceProviderMetadataResponse": { @@ -3490,9 +3706,13 @@ "serviceProviderSamlMetadata": { "target": "com.amazonaws.workspacesweb#SamlMetadata", "traits": { + "aws.cloudformation#cfnMutability": "read", "smithy.api#documentation": "The service provider SAML metadata.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#GetTrustStore": { @@ -3573,7 +3793,8 @@ "traits": { "smithy.api#documentation": "The ARN of the trust store certificate.
", "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "trustStoreArn" } }, "thumbprint": { @@ -3581,9 +3802,13 @@ "traits": { "smithy.api#documentation": "The thumbprint of the trust store certificate.
", "smithy.api#httpQuery": "thumbprint", + "smithy.api#notProperty": {}, "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#GetTrustStoreCertificateResponse": { @@ -3592,15 +3817,21 @@ "trustStoreArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { - "smithy.api#documentation": "The ARN of the trust store certificate.
" + "smithy.api#documentation": "The ARN of the trust store certificate.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "trustStoreArn" } }, "certificate": { "target": "com.amazonaws.workspacesweb#Certificate", "traits": { - "smithy.api#documentation": "The certificate of the trust store certificate.
" + "smithy.api#documentation": "The certificate of the trust store certificate.
", + "smithy.api#notProperty": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#GetTrustStoreRequest": { @@ -3614,6 +3845,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#GetTrustStoreResponse": { @@ -3622,9 +3856,13 @@ "trustStore": { "target": "com.amazonaws.workspacesweb#TrustStore", "traits": { - "smithy.api#documentation": "The trust store.
" + "smithy.api#documentation": "The trust store.
", + "smithy.api#nestedProperties": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#GetUserAccessLoggingSettings": { @@ -3673,6 +3911,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#GetUserAccessLoggingSettingsResponse": { @@ -3681,9 +3922,13 @@ "userAccessLoggingSettings": { "target": "com.amazonaws.workspacesweb#UserAccessLoggingSettings", "traits": { - "smithy.api#documentation": "The user access logging settings.
" + "smithy.api#documentation": "The user access logging settings.
", + "smithy.api#nestedProperties": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#GetUserSettings": { @@ -3732,6 +3977,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#GetUserSettingsResponse": { @@ -3740,19 +3988,24 @@ "userSettings": { "target": "com.amazonaws.workspacesweb#UserSettings", "traits": { - "smithy.api#documentation": "The user settings.
" + "smithy.api#documentation": "The user settings.
", + "smithy.api#nestedProperties": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#IdentityProvider": { "type": "structure", "members": { "identityProviderArn": { - "target": "com.amazonaws.workspacesweb#ARN", + "target": "com.amazonaws.workspacesweb#SubresourceARN", "traits": { "smithy.api#documentation": "The ARN of the identity provider.
", - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "identityProviderArn" } }, "identityProviderName": { @@ -3807,13 +4060,61 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.workspacesweb#IdentityProviderResource": { + "type": "resource", + "identifiers": { + "identityProviderArn": { + "target": "com.amazonaws.workspacesweb#SubresourceARN" + } + }, + "properties": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN" + }, + "identityProviderName": { + "target": "com.amazonaws.workspacesweb#IdentityProviderName" + }, + "identityProviderType": { + "target": "com.amazonaws.workspacesweb#IdentityProviderType" + }, + "identityProviderDetails": { + "target": "com.amazonaws.workspacesweb#IdentityProviderDetails" + } + }, + "create": { + "target": "com.amazonaws.workspacesweb#CreateIdentityProvider" + }, + "read": { + "target": "com.amazonaws.workspacesweb#GetIdentityProvider" + }, + "update": { + "target": "com.amazonaws.workspacesweb#UpdateIdentityProvider" + }, + "delete": { + "target": "com.amazonaws.workspacesweb#DeleteIdentityProvider" + }, + "list": { + "target": "com.amazonaws.workspacesweb#ListIdentityProviders" + }, + "traits": { + "aws.api#arn": { + "template": "{identityProviderArn}", + "absolute": true + }, + "aws.cloudformation#cfnResource": { + "name": "IdentityProvider" + } + } + }, "com.amazonaws.workspacesweb#IdentityProviderSummary": { "type": "structure", "members": { "identityProviderArn": { - "target": "com.amazonaws.workspacesweb#ARN", + "target": "com.amazonaws.workspacesweb#SubresourceARN", "traits": { - "smithy.api#documentation": "The ARN of the identity provider.
" + "smithy.api#documentation": "The ARN of the identity provider.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "identityProviderArn" } }, "identityProviderName": { @@ -3901,7 +4202,8 @@ "target": "com.amazonaws.workspacesweb#ARN", "traits": { "smithy.api#documentation": "The ARN of the IP access settings resource.
", - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ipAccessSettingsArn" } }, "associatedPortalArns": { @@ -3945,13 +4247,76 @@ "target": "com.amazonaws.workspacesweb#IpAccessSettingsSummary" } }, + "com.amazonaws.workspacesweb#IpAccessSettingsResource": { + "type": "resource", + "identifiers": { + "ipAccessSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN" + } + }, + "properties": { + "displayName": { + "target": "com.amazonaws.workspacesweb#DisplayName" + }, + "description": { + "target": "com.amazonaws.workspacesweb#Description" + }, + "tags": { + "target": "com.amazonaws.workspacesweb#TagList" + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn" + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap" + }, + "associatedPortalArns": { + "target": "com.amazonaws.workspacesweb#ArnList" + }, + "ipRules": { + "target": "com.amazonaws.workspacesweb#IpRuleList" + }, + "creationDate": { + "target": "com.amazonaws.workspacesweb#Timestamp" + } + }, + "create": { + "target": "com.amazonaws.workspacesweb#CreateIpAccessSettings" + }, + "read": { + "target": "com.amazonaws.workspacesweb#GetIpAccessSettings" + }, + "update": { + "target": "com.amazonaws.workspacesweb#UpdateIpAccessSettings" + }, + "delete": { + "target": "com.amazonaws.workspacesweb#DeleteIpAccessSettings" + }, + "list": { + "target": "com.amazonaws.workspacesweb#ListIpAccessSettings" + }, + "traits": { + "aws.api#arn": { + "template": "{ipAccessSettingsArn}", + "absolute": true + }, + "aws.api#taggable": { + "property": "tags" + }, + "aws.cloudformation#cfnResource": { + "name": "IpAccessSettings" + } + } + }, "com.amazonaws.workspacesweb#IpAccessSettingsSummary": { "type": "structure", "members": { "ipAccessSettingsArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { - "smithy.api#documentation": "The ARN of IP access settings.
" + "smithy.api#documentation": "The ARN of IP access settings.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "ipAccessSettingsArn" } }, "displayName": { @@ -4084,6 +4449,9 @@ "smithy.api#httpQuery": "maxResults" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#ListBrowserSettingsResponse": { @@ -4101,6 +4469,9 @@ "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#ListIdentityProviders": { @@ -4165,6 +4536,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#ListIdentityProvidersResponse": { @@ -4182,6 +4556,9 @@ "smithy.api#documentation": "The identity providers.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#ListIpAccessSettings": { @@ -4317,8 +4694,11 @@ "smithy.api#httpQuery": "maxResults" } } - } - }, + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.workspacesweb#ListNetworkSettingsResponse": { "type": "structure", "members": { @@ -4334,6 +4714,9 @@ "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#ListPortals": { @@ -4390,6 +4773,9 @@ "smithy.api#httpQuery": "maxResults" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#ListPortalsResponse": { @@ -4407,6 +4793,9 @@ "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#ListTagsForResource": { @@ -4455,6 +4844,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#ListTagsForResourceResponse": { @@ -4466,6 +4858,9 @@ "smithy.api#documentation": "The tags of the resource.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#ListTrustStoreCertificates": { @@ -4516,23 +4911,29 @@ "traits": { "smithy.api#documentation": "The ARN of the trust store
", "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "trustStoreArn" } }, "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
", - "smithy.api#httpQuery": "nextToken" + "smithy.api#httpQuery": "nextToken", + "smithy.api#notProperty": {} } }, "maxResults": { "target": "com.amazonaws.workspacesweb#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of results to be included in the next page.
", - "smithy.api#httpQuery": "maxResults" + "smithy.api#httpQuery": "maxResults", + "smithy.api#notProperty": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#ListTrustStoreCertificatesResponse": { @@ -4541,21 +4942,30 @@ "certificateList": { "target": "com.amazonaws.workspacesweb#CertificateSummaryList", "traits": { - "smithy.api#documentation": "The certificate list.
" + "smithy.api#documentation": "The certificate list.
", + "smithy.api#property": { + "name": "certificateSummaryList" + } } }, "trustStoreArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { - "smithy.api#documentation": "The ARN of the trust store.
" + "smithy.api#documentation": "The ARN of the trust store.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "trustStoreArn" } }, "nextToken": { "target": "com.amazonaws.workspacesweb#PaginationToken", "traits": { - "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.>
" + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.>
", + "smithy.api#notProperty": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#ListTrustStores": { @@ -4612,6 +5022,9 @@ "smithy.api#httpQuery": "maxResults" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#ListTrustStoresResponse": { @@ -4629,6 +5042,9 @@ "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#ListUserAccessLoggingSettings": { @@ -4685,6 +5101,9 @@ "smithy.api#httpQuery": "maxResults" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#ListUserAccessLoggingSettingsResponse": { @@ -4702,6 +5121,9 @@ "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#ListUserSettings": { @@ -4758,6 +5180,9 @@ "smithy.api#httpQuery": "maxResults" } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#ListUserSettingsResponse": { @@ -4775,6 +5200,9 @@ "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#MaxResults": { @@ -4792,7 +5220,8 @@ "target": "com.amazonaws.workspacesweb#ARN", "traits": { "smithy.api#documentation": "The ARN of the network settings.
", - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "networkSettingsArn" } }, "associatedPortalArns": { @@ -4830,13 +5259,67 @@ "target": "com.amazonaws.workspacesweb#NetworkSettingsSummary" } }, + "com.amazonaws.workspacesweb#NetworkSettingsResource": { + "type": "resource", + "identifiers": { + "networkSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN" + } + }, + "properties": { + "associatedPortalArns": { + "target": "com.amazonaws.workspacesweb#ArnList" + }, + "vpcId": { + "target": "com.amazonaws.workspacesweb#VpcId" + }, + "subnetIds": { + "target": "com.amazonaws.workspacesweb#SubnetIdList" + }, + "securityGroupIds": { + "target": "com.amazonaws.workspacesweb#SecurityGroupIdList" + }, + "tags": { + "target": "com.amazonaws.workspacesweb#TagList" + } + }, + "create": { + "target": "com.amazonaws.workspacesweb#CreateNetworkSettings" + }, + "read": { + "target": "com.amazonaws.workspacesweb#GetNetworkSettings" + }, + "update": { + "target": "com.amazonaws.workspacesweb#UpdateNetworkSettings" + }, + "delete": { + "target": "com.amazonaws.workspacesweb#DeleteNetworkSettings" + }, + "list": { + "target": "com.amazonaws.workspacesweb#ListNetworkSettings" + }, + "traits": { + "aws.api#arn": { + "template": "{networkSettingsArn}", + "absolute": true + }, + "aws.api#taggable": { + "property": "tags" + }, + "aws.cloudformation#cfnResource": { + "name": "NetworkSettings" + } + } + }, "com.amazonaws.workspacesweb#NetworkSettingsSummary": { "type": "structure", "members": { "networkSettingsArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { - "smithy.api#documentation": "The ARN of the network settings.
" + "smithy.api#documentation": "The ARN of the network settings.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "networkSettingsArn" } }, "vpcId": { @@ -4866,7 +5349,9 @@ "portalArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { - "smithy.api#documentation": "The ARN of the web portal.
" + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "portalArn" } }, "rendererType": { @@ -4974,6 +5459,148 @@ "target": "com.amazonaws.workspacesweb#PortalSummary" } }, + "com.amazonaws.workspacesweb#PortalResource": { + "type": "resource", + "identifiers": { + "portalArn": { + "target": "com.amazonaws.workspacesweb#ARN" + } + }, + "properties": { + "rendererType": { + "target": "com.amazonaws.workspacesweb#RendererType" + }, + "browserType": { + "target": "com.amazonaws.workspacesweb#BrowserType" + }, + "portalStatus": { + "target": "com.amazonaws.workspacesweb#PortalStatus" + }, + "portalEndpoint": { + "target": "com.amazonaws.workspacesweb#PortalEndpoint" + }, + "displayName": { + "target": "com.amazonaws.workspacesweb#DisplayName" + }, + "creationDate": { + "target": "com.amazonaws.workspacesweb#Timestamp" + }, + "browserSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN" + }, + "userSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN" + }, + "networkSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN" + }, + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN" + }, + "statusReason": { + "target": "com.amazonaws.workspacesweb#StatusReason" + }, + "userAccessLoggingSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN" + }, + "authenticationType": { + "target": "com.amazonaws.workspacesweb#AuthenticationType" + }, + "ipAccessSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN" + }, + "serviceProviderSamlMetadata": { + "target": "com.amazonaws.workspacesweb#SamlMetadata" + }, + "tags": { + "target": "com.amazonaws.workspacesweb#TagList" + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn" + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap" + } + }, + "create": { + "target": "com.amazonaws.workspacesweb#CreatePortal" + }, + "read": { + "target": "com.amazonaws.workspacesweb#GetPortal" + }, + "update": { + "target": "com.amazonaws.workspacesweb#UpdatePortal" + }, + "delete": { + "target": "com.amazonaws.workspacesweb#DeletePortal" + }, + "list": { + "target": "com.amazonaws.workspacesweb#ListPortals" + }, + "operations": [ + { + "target": "com.amazonaws.workspacesweb#AssociateBrowserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#AssociateIpAccessSettings" + }, + { + "target": "com.amazonaws.workspacesweb#AssociateNetworkSettings" + }, + { + "target": "com.amazonaws.workspacesweb#AssociateTrustStore" + }, + { + "target": "com.amazonaws.workspacesweb#AssociateUserAccessLoggingSettings" + }, + { + "target": "com.amazonaws.workspacesweb#AssociateUserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#DisassociateBrowserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#DisassociateIpAccessSettings" + }, + { + "target": "com.amazonaws.workspacesweb#DisassociateNetworkSettings" + }, + { + "target": "com.amazonaws.workspacesweb#DisassociateTrustStore" + }, + { + "target": "com.amazonaws.workspacesweb#DisassociateUserAccessLoggingSettings" + }, + { + "target": "com.amazonaws.workspacesweb#DisassociateUserSettings" + }, + { + "target": "com.amazonaws.workspacesweb#GetPortalServiceProviderMetadata" + } + ], + "traits": { + "aws.api#arn": { + "template": "{portalArn}", + "absolute": true + }, + "aws.api#taggable": { + "property": "tags" + }, + "aws.cloudformation#cfnResource": { + "name": "Portal", + "additionalSchemas": [ + "com.amazonaws.workspacesweb#AssociateBrowserSettingsRequest", + "com.amazonaws.workspacesweb#AssociateNetworkSettingsRequest", + "com.amazonaws.workspacesweb#AssociateUserSettingsRequest", + "com.amazonaws.workspacesweb#AssociateUserAccessLoggingSettingsRequest", + "com.amazonaws.workspacesweb#AssociateIpAccessSettingsRequest", + "com.amazonaws.workspacesweb#AssociateTrustStoreRequest", + "com.amazonaws.workspacesweb#GetPortalServiceProviderMetadataRequest", + "com.amazonaws.workspacesweb#GetPortalServiceProviderMetadataResponse" + ] + } + } + }, "com.amazonaws.workspacesweb#PortalStatus": { "type": "string", "traits": { @@ -4999,7 +5626,9 @@ "portalArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { - "smithy.api#documentation": "The ARN of the web portal.
" + "smithy.api#documentation": "The ARN of the web portal.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "portalArn" } }, "rendererType": { @@ -5250,6 +5879,16 @@ } } }, + "com.amazonaws.workspacesweb#SubresourceARN": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[\\w+=\\/,.@-]+:[a-zA-Z0-9\\-]+:[a-zA-Z0-9\\-]*:[a-zA-Z0-9]{1,12}:[a-zA-Z]+(\\/[a-fA-F0-9\\-]{36}){2,}$" + } + }, "com.amazonaws.workspacesweb#Tag": { "type": "structure", "members": { @@ -5373,11 +6012,17 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#TagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.workspacesweb#TagValue": { "type": "string", @@ -5457,7 +6102,9 @@ "trustStoreArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { - "smithy.api#documentation": "The ARN of the trust store.
" + "smithy.api#documentation": "The ARN of the trust store.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "trustStoreArn" } } }, @@ -5465,6 +6112,63 @@ "smithy.api#documentation": "A trust store that can be associated with a web portal. A trust store contains\n certificate authority (CA) certificates. Once associated with a web portal, the browser in\n a streaming session will recognize certificates that have been issued using any of the CAs\n in the trust store. If your organization has internal websites that use certificates issued\n by private CAs, you should add the private CA certificate to the trust store.
" } }, + "com.amazonaws.workspacesweb#TrustStoreResource": { + "type": "resource", + "identifiers": { + "trustStoreArn": { + "target": "com.amazonaws.workspacesweb#ARN" + } + }, + "properties": { + "certificateList": { + "target": "com.amazonaws.workspacesweb#CertificateList" + }, + "certificateSummaryList": { + "target": "com.amazonaws.workspacesweb#CertificateSummaryList" + }, + "associatedPortalArns": { + "target": "com.amazonaws.workspacesweb#ArnList" + }, + "tags": { + "target": "com.amazonaws.workspacesweb#TagList" + } + }, + "create": { + "target": "com.amazonaws.workspacesweb#CreateTrustStore" + }, + "read": { + "target": "com.amazonaws.workspacesweb#GetTrustStore" + }, + "update": { + "target": "com.amazonaws.workspacesweb#UpdateTrustStore" + }, + "delete": { + "target": "com.amazonaws.workspacesweb#DeleteTrustStore" + }, + "list": { + "target": "com.amazonaws.workspacesweb#ListTrustStores" + }, + "operations": [ + { + "target": "com.amazonaws.workspacesweb#GetTrustStoreCertificate" + }, + { + "target": "com.amazonaws.workspacesweb#ListTrustStoreCertificates" + } + ], + "traits": { + "aws.api#arn": { + "template": "{trustStoreArn}", + "absolute": true + }, + "aws.api#taggable": { + "property": "tags" + }, + "aws.cloudformation#cfnResource": { + "name": "TrustStore" + } + } + }, "com.amazonaws.workspacesweb#TrustStoreSummary": { "type": "structure", "members": { @@ -5539,11 +6243,17 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#UntagResourceResponse": { "type": "structure", - "members": {} + "members": {}, + "traits": { + "smithy.api#output": {} + } }, "com.amazonaws.workspacesweb#UpdateBrowserSettings": { "type": "operation", @@ -5603,6 +6313,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#UpdateBrowserSettingsResponse": { @@ -5612,9 +6325,13 @@ "target": "com.amazonaws.workspacesweb#BrowserSettings", "traits": { "smithy.api#documentation": "The browser settings.
", + "smithy.api#nestedProperties": {}, "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#UpdateIdentityProvider": { @@ -5655,7 +6372,7 @@ "type": "structure", "members": { "identityProviderArn": { - "target": "com.amazonaws.workspacesweb#ARN", + "target": "com.amazonaws.workspacesweb#SubresourceARN", "traits": { "smithy.api#documentation": "The ARN of the identity provider.
", "smithy.api#httpLabel": {}, @@ -5687,6 +6404,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#UpdateIdentityProviderResponse": { @@ -5696,9 +6416,13 @@ "target": "com.amazonaws.workspacesweb#IdentityProvider", "traits": { "smithy.api#documentation": "The identity provider.
", + "smithy.api#nestedProperties": {}, "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#UpdateIpAccessSettings": { @@ -5783,6 +6507,7 @@ "target": "com.amazonaws.workspacesweb#IpAccessSettings", "traits": { "smithy.api#documentation": "The IP access settings.
", + "smithy.api#nestedProperties": {}, "smithy.api#required": {} } } @@ -5861,6 +6586,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#UpdateNetworkSettingsResponse": { @@ -5870,9 +6598,13 @@ "target": "com.amazonaws.workspacesweb#NetworkSettings", "traits": { "smithy.api#documentation": "The network settings.
", + "smithy.api#nestedProperties": {}, "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#UpdatePortal": { @@ -5936,6 +6668,9 @@ "smithy.api#documentation": "The type of authentication integration points used when signing into the web portal.\n Defaults to Standard.
\n Standard web portals are authenticated directly through your identity\n provider. You need to call CreateIdentityProvider to integrate your identity\n provider with your web portal. User and group access to your web portal is controlled\n through your identity provider.
\n IAM_Identity_Center web portals are authenticated through AWS IAM Identity\n Center (successor to AWS Single Sign-On). They provide additional features, such as\n IdP-initiated authentication. Identity sources (including external identity provider\n integration), plus user and group access to your web portal, can be configured in the IAM\n Identity Center.
The web portal.
" + "smithy.api#documentation": "The web portal.
", + "smithy.api#nestedProperties": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#UpdateTrustStore": { @@ -6000,13 +6739,15 @@ "certificatesToAdd": { "target": "com.amazonaws.workspacesweb#CertificateList", "traits": { - "smithy.api#documentation": "A list of CA certificates to add to the trust store.
" + "smithy.api#documentation": "A list of CA certificates to add to the trust store.
", + "smithy.api#notProperty": {} } }, "certificatesToDelete": { "target": "com.amazonaws.workspacesweb#CertificateThumbprintList", "traits": { - "smithy.api#documentation": "A list of CA certificates to delete from a trust store.
" + "smithy.api#documentation": "A list of CA certificates to delete from a trust store.
", + "smithy.api#notProperty": {} } }, "clientToken": { @@ -6016,6 +6757,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#UpdateTrustStoreResponse": { @@ -6028,6 +6772,9 @@ "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#UpdateUserAccessLoggingSettings": { @@ -6088,6 +6835,9 @@ "smithy.api#idempotencyToken": {} } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#UpdateUserAccessLoggingSettingsResponse": { @@ -6097,9 +6847,13 @@ "target": "com.amazonaws.workspacesweb#UserAccessLoggingSettings", "traits": { "smithy.api#documentation": "The user access logging settings.
", + "smithy.api#nestedProperties": {}, "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#UpdateUserSettings": { @@ -6180,12 +6934,14 @@ "disconnectTimeoutInMinutes": { "target": "com.amazonaws.workspacesweb#DisconnectTimeoutInMinutes", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect.
" } }, "idleDisconnectTimeoutInMinutes": { "target": "com.amazonaws.workspacesweb#IdleDisconnectTimeoutInMinutes", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" } }, @@ -6195,7 +6951,16 @@ "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Idempotency ensures that an API request completes only once. With an idempotent\n request, if the original request completes successfully, subsequent retries with the same\n client token return the result from the original successful request.
\nIf you do not specify a client token, one is automatically generated by the AWS\n SDK.
", "smithy.api#idempotencyToken": {} } + }, + "cookieSynchronizationConfiguration": { + "target": "com.amazonaws.workspacesweb#CookieSynchronizationConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
\nIf the allowlist and blocklist are empty, the configuration becomes null.
" + } } + }, + "traits": { + "smithy.api#input": {} } }, "com.amazonaws.workspacesweb#UpdateUserSettingsResponse": { @@ -6205,9 +6970,13 @@ "target": "com.amazonaws.workspacesweb#UserSettings", "traits": { "smithy.api#documentation": "The user settings.
", + "smithy.api#nestedProperties": {}, "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.workspacesweb#UserAccessLoggingSettings": { @@ -6217,7 +6986,8 @@ "target": "com.amazonaws.workspacesweb#ARN", "traits": { "smithy.api#documentation": "The ARN of the user access logging settings.
", - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "userAccessLoggingSettingsArn" } }, "associatedPortalArns": { @@ -6243,13 +7013,61 @@ "target": "com.amazonaws.workspacesweb#UserAccessLoggingSettingsSummary" } }, + "com.amazonaws.workspacesweb#UserAccessLoggingSettingsResource": { + "type": "resource", + "identifiers": { + "userAccessLoggingSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN" + } + }, + "properties": { + "associatedPortalArns": { + "target": "com.amazonaws.workspacesweb#ArnList" + }, + "kinesisStreamArn": { + "target": "com.amazonaws.workspacesweb#KinesisStreamArn" + }, + "tags": { + "target": "com.amazonaws.workspacesweb#TagList" + } + }, + "create": { + "target": "com.amazonaws.workspacesweb#CreateUserAccessLoggingSettings" + }, + "read": { + "target": "com.amazonaws.workspacesweb#GetUserAccessLoggingSettings" + }, + "update": { + "target": "com.amazonaws.workspacesweb#UpdateUserAccessLoggingSettings" + }, + "delete": { + "target": "com.amazonaws.workspacesweb#DeleteUserAccessLoggingSettings" + }, + "list": { + "target": "com.amazonaws.workspacesweb#ListUserAccessLoggingSettings" + }, + "traits": { + "aws.api#arn": { + "template": "{userAccessLoggingSettingsArn}", + "absolute": true + }, + "aws.api#taggable": { + "property": "tags" + }, + "aws.cloudformation#cfnResource": { + "name": "UserAccessLoggingSettings" + } + } + }, "com.amazonaws.workspacesweb#UserAccessLoggingSettingsSummary": { "type": "structure", "members": { "userAccessLoggingSettingsArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { - "smithy.api#documentation": "The ARN of the user access logging settings.
" + "smithy.api#documentation": "The ARN of the user access logging settings.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "userAccessLoggingSettingsArn" } }, "kinesisStreamArn": { @@ -6270,7 +7088,8 @@ "target": "com.amazonaws.workspacesweb#ARN", "traits": { "smithy.api#documentation": "The ARN of the user settings.
", - "smithy.api#required": {} + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "userSettingsArn" } }, "associatedPortalArns": { @@ -6312,14 +7131,22 @@ "disconnectTimeoutInMinutes": { "target": "com.amazonaws.workspacesweb#DisconnectTimeoutInMinutes", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect.
" } }, "idleDisconnectTimeoutInMinutes": { "target": "com.amazonaws.workspacesweb#IdleDisconnectTimeoutInMinutes", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" } + }, + "cookieSynchronizationConfiguration": { + "target": "com.amazonaws.workspacesweb#CookieSynchronizationConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
" + } } }, "traits": { @@ -6332,13 +7159,88 @@ "target": "com.amazonaws.workspacesweb#UserSettingsSummary" } }, + "com.amazonaws.workspacesweb#UserSettingsResource": { + "type": "resource", + "identifiers": { + "userSettingsArn": { + "target": "com.amazonaws.workspacesweb#ARN" + } + }, + "properties": { + "associatedPortalArns": { + "target": "com.amazonaws.workspacesweb#ArnList" + }, + "copyAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType" + }, + "pasteAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType" + }, + "downloadAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType" + }, + "uploadAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType" + }, + "printAllowed": { + "target": "com.amazonaws.workspacesweb#EnabledType" + }, + "disconnectTimeoutInMinutes": { + "target": "com.amazonaws.workspacesweb#DisconnectTimeoutInMinutes" + }, + "idleDisconnectTimeoutInMinutes": { + "target": "com.amazonaws.workspacesweb#IdleDisconnectTimeoutInMinutes" + }, + "tags": { + "target": "com.amazonaws.workspacesweb#TagList" + }, + "customerManagedKey": { + "target": "com.amazonaws.workspacesweb#keyArn" + }, + "additionalEncryptionContext": { + "target": "com.amazonaws.workspacesweb#EncryptionContextMap" + }, + "cookieSynchronizationConfiguration": { + "target": "com.amazonaws.workspacesweb#CookieSynchronizationConfiguration" + } + }, + "create": { + "target": "com.amazonaws.workspacesweb#CreateUserSettings" + }, + "read": { + "target": "com.amazonaws.workspacesweb#GetUserSettings" + }, + "update": { + "target": "com.amazonaws.workspacesweb#UpdateUserSettings" + }, + "delete": { + "target": "com.amazonaws.workspacesweb#DeleteUserSettings" + }, + "list": { + "target": "com.amazonaws.workspacesweb#ListUserSettings" + }, + "traits": { + "aws.api#arn": { + "template": "{userSettingsArn}", + "absolute": true + }, + "aws.api#taggable": { + "property": "tags" + }, + "aws.cloudformation#cfnResource": { + "name": "UserSettings" + } + } + }, "com.amazonaws.workspacesweb#UserSettingsSummary": { "type": "structure", "members": { "userSettingsArn": { "target": "com.amazonaws.workspacesweb#ARN", "traits": { - "smithy.api#documentation": "The ARN of the user settings.
" + "smithy.api#documentation": "The ARN of the user settings.
", + "smithy.api#required": {}, + "smithy.api#resourceIdentifier": "userSettingsArn" } }, "copyAllowed": { @@ -6374,14 +7276,22 @@ "disconnectTimeoutInMinutes": { "target": "com.amazonaws.workspacesweb#DisconnectTimeoutInMinutes", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "The amount of time that a streaming session remains active after users disconnect.
" } }, "idleDisconnectTimeoutInMinutes": { "target": "com.amazonaws.workspacesweb#IdleDisconnectTimeoutInMinutes", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.
" } + }, + "cookieSynchronizationConfiguration": { + "target": "com.amazonaws.workspacesweb#CookieSynchronizationConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.
" + } } }, "traits": { diff --git a/gradle.properties b/gradle.properties index c905560f142..8e6f7768d34 100644 --- a/gradle.properties +++ b/gradle.properties @@ -12,7 +12,7 @@ sdkVersion=0.32.0-SNAPSHOT smithyVersion=1.29.0 smithyGradleVersion=0.6.0 # smithy-kotlin codegen and runtime are versioned together -smithyKotlinVersion=0.27.0-SNAPSHOT +smithyKotlinVersion=0.27.0 # kotlin kotlinVersion=1.8.22 From 22d6b455f3d16f0b5f674a91c9997e8d534ec7d7 Mon Sep 17 00:00:00 2001 From: Ian Botsford <83236726+ianbotsf@users.noreply.github.com> Date: Thu, 31 Aug 2023 18:41:30 +0000 Subject: [PATCH 2/2] bump smithy-kotlin version even higher! --- gradle.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gradle.properties b/gradle.properties index 8e6f7768d34..4997e6d00f4 100644 --- a/gradle.properties +++ b/gradle.properties @@ -12,7 +12,7 @@ sdkVersion=0.32.0-SNAPSHOT smithyVersion=1.29.0 smithyGradleVersion=0.6.0 # smithy-kotlin codegen and runtime are versioned together -smithyKotlinVersion=0.27.0 +smithyKotlinVersion=0.27.1 # kotlin kotlinVersion=1.8.22