The properties that are applied when Amazon S3 is used as a destination.
" } }, + "com.amazonaws.appflow#S3InputFileType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CSV", + "name": "CSV" + }, + { + "value": "JSON", + "name": "JSON" + } + ] + } + }, + "com.amazonaws.appflow#S3InputFormatConfig": { + "type": "structure", + "members": { + "s3InputFileType": { + "target": "com.amazonaws.appflow#S3InputFileType", + "traits": { + "smithy.api#documentation": "The file type that Amazon AppFlow gets from your Amazon S3 bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "When you use Amazon S3 as the source, the configuration format that you provide the flow input data.
" + } + }, "com.amazonaws.appflow#S3Metadata": { "type": "structure", "members": {}, @@ -4465,6 +4494,9 @@ "traits": { "smithy.api#documentation": "The object key for the Amazon S3 bucket in which the source files are stored.
" } + }, + "s3InputFormatConfig": { + "target": "com.amazonaws.appflow#S3InputFormatConfig" } }, "traits": { diff --git a/codegen/sdk/aws-models/auditmanager.2017-07-25.json b/codegen/sdk/aws-models/auditmanager.2017-07-25.json index 2321adfd823..b0c13a7019e 100644 --- a/codegen/sdk/aws-models/auditmanager.2017-07-25.json +++ b/codegen/sdk/aws-models/auditmanager.2017-07-25.json @@ -35,24 +35,24 @@ "id": { "target": "com.amazonaws.auditmanager#AccountId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified account. \n
" + "smithy.api#documentation": "The identifier for the Amazon Web Services account.
" } }, "emailAddress": { "target": "com.amazonaws.auditmanager#EmailAddress", "traits": { - "smithy.api#documentation": "\n The email address associated with the specified account. \n
" + "smithy.api#documentation": "The email address that's associated with the Amazon Web Services account.
" } }, "name": { "target": "com.amazonaws.auditmanager#AccountName", "traits": { - "smithy.api#documentation": "\n The name of the specified account. \n
" + "smithy.api#documentation": "The name of the Amazon Web Services account.
" } } }, "traits": { - "smithy.api#documentation": "\n The wrapper of account details, such as account ID, email address, and so on. \n
" + "smithy.api#documentation": "The wrapper of Amazon Web Services account details, such as account ID or email address.\n
" } }, "com.amazonaws.auditmanager#AWSAccounts": { @@ -67,12 +67,12 @@ "serviceName": { "target": "com.amazonaws.auditmanager#AWSServiceName", "traits": { - "smithy.api#documentation": "\n The name of the Amazon Web Service. \n
" + "smithy.api#documentation": "The name of the Amazon Web Service.
" } } }, "traits": { - "smithy.api#documentation": "\n An Amazon Web Service such as Amazon S3, CloudTrail, and so on. \n
" + "smithy.api#documentation": "An Amazon Web Service such as Amazon S3 or CloudTrail.\n
" } }, "com.amazonaws.auditmanager#AWSServiceName": { @@ -102,7 +102,7 @@ } }, "traits": { - "smithy.api#documentation": "\n Your account is not registered with Audit Manager. Check the delegated administrator setup on the Audit Manager settings page, and try again.\n
", + "smithy.api#documentation": "Your account isn't registered with Audit Manager. Check the delegated\n administrator setup on the Audit Manager settings page, and try again.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -211,36 +211,36 @@ "arn": { "target": "com.amazonaws.auditmanager#AuditManagerArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the assessment. \n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assessment.
" } }, "awsAccount": { "target": "com.amazonaws.auditmanager#AWSAccount", "traits": { - "smithy.api#documentation": "\n The account associated with the assessment. \n
" + "smithy.api#documentation": "The Amazon Web Services account that's associated with the assessment.
" } }, "metadata": { "target": "com.amazonaws.auditmanager#AssessmentMetadata", "traits": { - "smithy.api#documentation": "\n The metadata for the specified assessment. \n
" + "smithy.api#documentation": "The metadata for the assessment.
" } }, "framework": { "target": "com.amazonaws.auditmanager#AssessmentFramework", "traits": { - "smithy.api#documentation": "\n The framework from which the assessment was created. \n
" + "smithy.api#documentation": "The framework that the assessment was created from.
" } }, "tags": { "target": "com.amazonaws.auditmanager#TagMap", "traits": { - "smithy.api#documentation": "\n The tags associated with the assessment. \n
" + "smithy.api#documentation": "The tags that are associated with the assessment.
" } } }, "traits": { - "smithy.api#documentation": "\n An entity that defines the scope of audit evidence collected by Audit Manager. An Audit Manager assessment is an implementation of an Audit Manager framework. \n
" + "smithy.api#documentation": "An entity that defines the scope of audit evidence collected by Audit Manager.\n An Audit Manager assessment is an implementation of an Audit Manager\n framework.
" } }, "com.amazonaws.auditmanager#AssessmentControl": { @@ -249,60 +249,60 @@ "id": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified control. \n
" + "smithy.api#documentation": "The identifier for the control.
" } }, "name": { "target": "com.amazonaws.auditmanager#ControlName", "traits": { - "smithy.api#documentation": "\n The name of the specified control. \n
" + "smithy.api#documentation": "The name of the control.
" } }, "description": { "target": "com.amazonaws.auditmanager#ControlDescription", "traits": { - "smithy.api#documentation": "\n The description of the specified control. \n
" + "smithy.api#documentation": "The description of the control.
" } }, "status": { "target": "com.amazonaws.auditmanager#ControlStatus", "traits": { - "smithy.api#documentation": "\n The status of the specified control. \n
" + "smithy.api#documentation": "The status of the control.
" } }, "response": { "target": "com.amazonaws.auditmanager#ControlResponse", "traits": { - "smithy.api#documentation": "\n The response of the specified control. \n
" + "smithy.api#documentation": "The response of the control.
" } }, "comments": { "target": "com.amazonaws.auditmanager#ControlComments", "traits": { - "smithy.api#documentation": "\n The list of comments attached to the specified control. \n
" + "smithy.api#documentation": "The list of comments that's attached to the control.
" } }, "evidenceSources": { "target": "com.amazonaws.auditmanager#EvidenceSources", "traits": { - "smithy.api#documentation": "\n The list of data sources for the specified evidence.\n
" + "smithy.api#documentation": "The list of data sources for the evidence.
" } }, "evidenceCount": { "target": "com.amazonaws.auditmanager#Integer", "traits": { - "smithy.api#documentation": "\n The amount of evidence generated for the control.\n
" + "smithy.api#documentation": "The amount of evidence that's generated for the control.
" } }, "assessmentReportEvidenceCount": { "target": "com.amazonaws.auditmanager#Integer", "traits": { - "smithy.api#documentation": "\n The amount of evidence in the assessment report.\n
" + "smithy.api#documentation": "The amount of evidence in the assessment report.
" } } }, "traits": { - "smithy.api#documentation": "\n The control entity that represents a standard or custom control used in an Audit Manager assessment.\n
" + "smithy.api#documentation": "The control entity that represents a standard control or a custom control in an Audit Manager assessment.
" } }, "com.amazonaws.auditmanager#AssessmentControlSet": { @@ -311,54 +311,54 @@ "id": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "\n The identifier of the control set in the assessment. This is the control set name in a plain string format. \n
" + "smithy.api#documentation": "The identifier of the control set in the assessment. This is the control set name in a\n plain string format.
" } }, "description": { "target": "com.amazonaws.auditmanager#NonEmptyString", "traits": { - "smithy.api#documentation": "\n The description for the control set. \n
" + "smithy.api#documentation": "The description for the control set.
" } }, "status": { "target": "com.amazonaws.auditmanager#ControlSetStatus", "traits": { - "smithy.api#documentation": "\nSpecifies the current status of the control set.\n
" + "smithy.api#documentation": "Specifies the current status of the control set.
" } }, "roles": { "target": "com.amazonaws.auditmanager#Roles", "traits": { - "smithy.api#documentation": "\n The roles associated with the control set. \n
" + "smithy.api#documentation": "The roles that are associated with the control set.
" } }, "controls": { "target": "com.amazonaws.auditmanager#AssessmentControls", "traits": { - "smithy.api#documentation": "\nThe list of controls contained with the control set.\n
" + "smithy.api#documentation": "The list of controls that's contained with the control set.
" } }, "delegations": { "target": "com.amazonaws.auditmanager#Delegations", "traits": { - "smithy.api#documentation": "\n The delegations associated with the control set.\n
" + "smithy.api#documentation": "The delegations that are associated with the control set.
" } }, "systemEvidenceCount": { "target": "com.amazonaws.auditmanager#Integer", "traits": { - "smithy.api#documentation": "\n The total number of evidence objects retrieved automatically for the control set. \n
" + "smithy.api#documentation": "The total number of evidence objects that are retrieved automatically for the control\n set.
" } }, "manualEvidenceCount": { "target": "com.amazonaws.auditmanager#Integer", "traits": { - "smithy.api#documentation": "\n The total number of evidence objects uploaded manually to the control set. \n
" + "smithy.api#documentation": "The total number of evidence objects that are uploaded manually to the control set.\n
" } } }, "traits": { - "smithy.api#documentation": "\n Represents a set of controls in an Audit Manager assessment.\n
" + "smithy.api#documentation": "Represents a set of controls in an Audit Manager assessment.
" } }, "com.amazonaws.auditmanager#AssessmentControlSets": { @@ -389,114 +389,114 @@ "name": { "target": "com.amazonaws.auditmanager#AssessmentEvidenceFolderName", "traits": { - "smithy.api#documentation": "\nThe name of the specified evidence folder.\n
" + "smithy.api#documentation": "The name of the evidence folder.
" } }, "date": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n The date when the first evidence was added to the evidence folder.\n
" + "smithy.api#documentation": "The date when the first evidence was added to the evidence folder.
" } }, "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
" + "smithy.api#documentation": "The identifier for the assessment.
" } }, "controlSetId": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "\n The identifier for the control set. \n
" + "smithy.api#documentation": "The identifier for the control set.
" } }, "controlId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n \n The unique identifier for the specified control. \n
" + "smithy.api#documentation": "The unique identifier for the control.
" } }, "id": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\nThe identifier for the folder in which evidence is stored.\n
" + "smithy.api#documentation": "The identifier for the folder that the evidence is stored in.
" } }, "dataSource": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "\n The Amazon Web Service from which the evidence was collected. \n
" + "smithy.api#documentation": "The Amazon Web Service that the evidence was collected from.
" } }, "author": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "\n The name of the user who created the evidence folder.\n
" + "smithy.api#documentation": "The name of the user who created the evidence folder.
" } }, "totalEvidence": { "target": "com.amazonaws.auditmanager#Integer", "traits": { - "smithy.api#documentation": "\n The total amount of evidence in the evidence folder.\n
" + "smithy.api#documentation": "The total amount of evidence in the evidence folder.
" } }, "assessmentReportSelectionCount": { "target": "com.amazonaws.auditmanager#Integer", "traits": { - "smithy.api#documentation": "\n The total count of evidence included in the assessment report.\n
" + "smithy.api#documentation": "The total count of evidence that's included in the assessment report.
" } }, "controlName": { "target": "com.amazonaws.auditmanager#ControlName", "traits": { - "smithy.api#documentation": "\n The name of the control.\n
" + "smithy.api#documentation": "The name of the control.
" } }, "evidenceResourcesIncludedCount": { "target": "com.amazonaws.auditmanager#Integer", "traits": { - "smithy.api#documentation": "\n The amount of evidence included in the evidence folder.\n
" + "smithy.api#documentation": "The amount of evidence that's included in the evidence folder.
" } }, "evidenceByTypeConfigurationDataCount": { "target": "com.amazonaws.auditmanager#Integer", "traits": { - "smithy.api#documentation": "\n The number of evidence that falls under the configuration data category. This evidence is collected from configuration snapshots of other Amazon Web Services services such as Amazon EC2, Amazon S3, or IAM.\n
" + "smithy.api#documentation": "The number of evidence that falls under the configuration data category. This\n evidence is collected from configuration snapshots of other Amazon Web Services services such as Amazon EC2, Amazon S3, or IAM.
" } }, "evidenceByTypeManualCount": { "target": "com.amazonaws.auditmanager#Integer", "traits": { - "smithy.api#documentation": "\n The number of evidence that falls under the manual category. This evidence is imported manually.\n
" + "smithy.api#documentation": "The number of evidence that falls under the manual category. This evidence is imported\n manually.
" } }, "evidenceByTypeComplianceCheckCount": { "target": "com.amazonaws.auditmanager#Integer", "traits": { - "smithy.api#documentation": "\n The number of evidence that falls under the compliance check category. This evidence is collected from Config or Security Hub.\n
" + "smithy.api#documentation": "The number of evidence that falls under the compliance check category. This evidence is\n collected from Config or Security Hub.
" } }, "evidenceByTypeComplianceCheckIssuesCount": { "target": "com.amazonaws.auditmanager#Integer", "traits": { - "smithy.api#documentation": "\n The total number of issues that were reported directly from Security Hub, Config, or both.\n
" + "smithy.api#documentation": "The total number of issues that were reported directly from Security Hub,\n Config, or both.
" } }, "evidenceByTypeUserActivityCount": { "target": "com.amazonaws.auditmanager#Integer", "traits": { - "smithy.api#documentation": "\n The number of evidence that falls under the user activity category. This evidence is collected from CloudTrail logs.\n
" + "smithy.api#documentation": "The number of evidence that falls under the user activity category. This evidence is\n collected from CloudTrail logs.
" } }, "evidenceAwsServiceSourceCount": { "target": "com.amazonaws.auditmanager#Integer", "traits": { - "smithy.api#documentation": "\n The total number of Amazon Web Services resources assessed to generate the evidence. \n
" + "smithy.api#documentation": "The total number of Amazon Web Services resources that were assessed to generate the\n evidence.
" } } }, "traits": { - "smithy.api#documentation": "\n The folder in which Audit Manager stores evidence for an assessment.\n
" + "smithy.api#documentation": "The folder where Audit Manager stores evidence for an assessment.
" } }, "com.amazonaws.auditmanager#AssessmentEvidenceFolderName": { @@ -521,13 +521,13 @@ "id": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\nThe unique identifier for the framework.\n
" + "smithy.api#documentation": "The unique identifier for the framework.
" } }, "arn": { "target": "com.amazonaws.auditmanager#AuditManagerArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the specified framework. \n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the framework.
" } }, "metadata": { @@ -536,12 +536,12 @@ "controlSets": { "target": "com.amazonaws.auditmanager#AssessmentControlSets", "traits": { - "smithy.api#documentation": "\n The control sets associated with the framework. \n
" + "smithy.api#documentation": "The control sets that are associated with the framework.
" } } }, "traits": { - "smithy.api#documentation": "\n The file used to structure and automate Audit Manager assessments for a given compliance standard.\n
" + "smithy.api#documentation": "The file used to structure and automate Audit Manager assessments for a given\n compliance standard.
" } }, "com.amazonaws.auditmanager#AssessmentFrameworkDescription": { @@ -560,72 +560,176 @@ "arn": { "target": "com.amazonaws.auditmanager#AuditManagerArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the framework. \n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the framework.
" } }, "id": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\nThe unique identified for the specified framework.\n
" + "smithy.api#documentation": "The unique identifier for the framework.
" } }, "type": { "target": "com.amazonaws.auditmanager#FrameworkType", "traits": { - "smithy.api#documentation": "\nThe framework type, such as standard or custom.\n
" + "smithy.api#documentation": "The framework type, such as a standard framework or a custom framework.
" } }, "name": { "target": "com.amazonaws.auditmanager#FrameworkName", "traits": { - "smithy.api#documentation": "\nThe name of the specified framework.\n
" + "smithy.api#documentation": "The name of the framework.
" } }, "description": { "target": "com.amazonaws.auditmanager#FrameworkDescription", "traits": { - "smithy.api#documentation": "\n The description of the specified framework.\n
" + "smithy.api#documentation": "The description of the framework.
" } }, "logo": { "target": "com.amazonaws.auditmanager#Filename", "traits": { - "smithy.api#documentation": "\n The logo associated with the framework. \n
" + "smithy.api#documentation": "The logo that's associated with the framework.
" } }, "complianceType": { "target": "com.amazonaws.auditmanager#ComplianceType", "traits": { - "smithy.api#documentation": "\n The compliance type that the new custom framework supports, such as CIS or HIPAA.\n
" + "smithy.api#documentation": "The compliance type that the new custom framework supports, such as CIS or HIPAA.\n
" } }, "controlsCount": { "target": "com.amazonaws.auditmanager#ControlsCount", "traits": { - "smithy.api#documentation": "\nThe number of controls associated with the specified framework.\n
" + "smithy.api#documentation": "The number of controls that are associated with the framework.
" } }, "controlSetsCount": { "target": "com.amazonaws.auditmanager#ControlSetsCount", "traits": { - "smithy.api#documentation": "\n The number of control sets associated with the specified framework.\n
" + "smithy.api#documentation": "The number of control sets that are associated with the framework.
" } }, "createdAt": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n Specifies when the framework was created.\n
" + "smithy.api#documentation": "Specifies when the framework was created.
" } }, "lastUpdatedAt": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n Specifies when the framework was most recently updated.\n
" + "smithy.api#documentation": "Specifies when the framework was most recently updated.
" } } }, "traits": { - "smithy.api#documentation": "\n The metadata associated with a standard or custom framework.\n
" + "smithy.api#documentation": "The metadata that's associated with a standard framework or a custom framework.
" + } + }, + "com.amazonaws.auditmanager#AssessmentFrameworkShareRequest": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.auditmanager#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier for the share request.
" + } + }, + "frameworkId": { + "target": "com.amazonaws.auditmanager#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier for the shared custom framework.
" + } + }, + "frameworkName": { + "target": "com.amazonaws.auditmanager#FrameworkName", + "traits": { + "smithy.api#documentation": "The name of the custom framework that the share request is for.
" + } + }, + "frameworkDescription": { + "target": "com.amazonaws.auditmanager#FrameworkDescription", + "traits": { + "smithy.api#documentation": "The description of the shared custom framework.
" + } + }, + "status": { + "target": "com.amazonaws.auditmanager#ShareRequestStatus", + "traits": { + "smithy.api#documentation": "The status of the share request.
" + } + }, + "sourceAccount": { + "target": "com.amazonaws.auditmanager#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account of the sender.
" + } + }, + "destinationAccount": { + "target": "com.amazonaws.auditmanager#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account of the recipient.
" + } + }, + "destinationRegion": { + "target": "com.amazonaws.auditmanager#Region", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region of the recipient.
" + } + }, + "expirationTime": { + "target": "com.amazonaws.auditmanager#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the share request expires.
" + } + }, + "creationTime": { + "target": "com.amazonaws.auditmanager#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the share request was created.
" + } + }, + "lastUpdated": { + "target": "com.amazonaws.auditmanager#Timestamp", + "traits": { + "smithy.api#documentation": "Specifies when the share request was last updated.
" + } + }, + "comment": { + "target": "com.amazonaws.auditmanager#ShareRequestComment", + "traits": { + "smithy.api#documentation": "An optional comment from the sender about the share request.
" + } + }, + "standardControlsCount": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "The number of standard controls that are part of the shared custom framework.
" + } + }, + "customControlsCount": { + "target": "com.amazonaws.auditmanager#NullableInteger", + "traits": { + "smithy.api#documentation": "The number of custom controls that are part of the shared custom framework.
" + } + }, + "complianceType": { + "target": "com.amazonaws.auditmanager#ComplianceType", + "traits": { + "smithy.api#documentation": "The compliance type that the shared custom framework supports, such as CIS or HIPAA.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a share request for a custom framework in Audit Manager.
" + } + }, + "com.amazonaws.auditmanager#AssessmentFrameworkShareRequestList": { + "type": "list", + "member": { + "target": "com.amazonaws.auditmanager#AssessmentFrameworkShareRequest" } }, "com.amazonaws.auditmanager#AssessmentMetadata": { @@ -634,72 +738,72 @@ "name": { "target": "com.amazonaws.auditmanager#AssessmentName", "traits": { - "smithy.api#documentation": "\n The name of the assessment. \n
" + "smithy.api#documentation": "The name of the assessment.
" } }, "id": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The unique identifier for the assessment. \n
" + "smithy.api#documentation": "The unique identifier for the assessment.
" } }, "description": { "target": "com.amazonaws.auditmanager#AssessmentDescription", "traits": { - "smithy.api#documentation": "\n The description of the assessment. \n
" + "smithy.api#documentation": "The description of the assessment.
" } }, "complianceType": { "target": "com.amazonaws.auditmanager#ComplianceType", "traits": { - "smithy.api#documentation": "\n The name of a compliance standard related to the assessment, such as PCI-DSS. \n
" + "smithy.api#documentation": "The name of the compliance standard that's related to the assessment, such as PCI-DSS.\n
" } }, "status": { "target": "com.amazonaws.auditmanager#AssessmentStatus", "traits": { - "smithy.api#documentation": "\n The overall status of the assessment. \n
" + "smithy.api#documentation": "The overall status of the assessment.
" } }, "assessmentReportsDestination": { "target": "com.amazonaws.auditmanager#AssessmentReportsDestination", "traits": { - "smithy.api#documentation": "\n The destination in which evidence reports are stored for the specified assessment. \n
" + "smithy.api#documentation": "The destination that evidence reports are stored in for the assessment.
" } }, "scope": { "target": "com.amazonaws.auditmanager#Scope", "traits": { - "smithy.api#documentation": "\n The wrapper of accounts and services in scope for the assessment. \n
" + "smithy.api#documentation": "The wrapper of Amazon Web Services accounts and services that are in scope for the\n assessment.
" } }, "roles": { "target": "com.amazonaws.auditmanager#Roles", "traits": { - "smithy.api#documentation": "\n The roles associated with the assessment. \n
" + "smithy.api#documentation": "The roles that are associated with the assessment.
" } }, "delegations": { "target": "com.amazonaws.auditmanager#Delegations", "traits": { - "smithy.api#documentation": "\n The delegations associated with the assessment. \n
" + "smithy.api#documentation": "The delegations that are associated with the assessment.
" } }, "creationTime": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n Specifies when the assessment was created.\n
" + "smithy.api#documentation": "Specifies when the assessment was created.
" } }, "lastUpdated": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n The time of the most recent update. \n
" + "smithy.api#documentation": "The time of the most recent update.
" } } }, "traits": { - "smithy.api#documentation": "\n The metadata associated with the specified assessment.\n
" + "smithy.api#documentation": "The metadata that's associated with the specified assessment.
" } }, "com.amazonaws.auditmanager#AssessmentMetadataItem": { @@ -708,54 +812,54 @@ "name": { "target": "com.amazonaws.auditmanager#AssessmentName", "traits": { - "smithy.api#documentation": "\nThe name of the assessment.\n
" + "smithy.api#documentation": "The name of the assessment.
" } }, "id": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The unique identifier for the assessment. \n
" + "smithy.api#documentation": "The unique identifier for the assessment.
" } }, "complianceType": { "target": "com.amazonaws.auditmanager#ComplianceType", "traits": { - "smithy.api#documentation": "\n The name of the compliance standard related to the assessment, such as PCI-DSS. \n
" + "smithy.api#documentation": "The name of the compliance standard that's related to the assessment, such as PCI-DSS.\n
" } }, "status": { "target": "com.amazonaws.auditmanager#AssessmentStatus", "traits": { - "smithy.api#documentation": "\nThe current status of the assessment.\n
" + "smithy.api#documentation": "The current status of the assessment.
" } }, "roles": { "target": "com.amazonaws.auditmanager#Roles", "traits": { - "smithy.api#documentation": "\n The roles associated with the assessment. \n
" + "smithy.api#documentation": "The roles that are associated with the assessment.
" } }, "delegations": { "target": "com.amazonaws.auditmanager#Delegations", "traits": { - "smithy.api#documentation": "\n The delegations associated with the assessment.\n
" + "smithy.api#documentation": "The delegations that are associated with the assessment.
" } }, "creationTime": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n Specifies when the assessment was created.\n
" + "smithy.api#documentation": "Specifies when the assessment was created.
" } }, "lastUpdated": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n The time of the most recent update. \n
" + "smithy.api#documentation": "The time of the most recent update.
" } } }, "traits": { - "smithy.api#documentation": "\n A metadata object associated with an assessment in Audit Manager.\n
" + "smithy.api#documentation": "A metadata object that's associated with an assessment in Audit Manager.\n
" } }, "com.amazonaws.auditmanager#AssessmentName": { @@ -774,60 +878,60 @@ "id": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\nThe unique identifier for the specified assessment report.\n
" + "smithy.api#documentation": "The unique identifier for the assessment report.
" } }, "name": { "target": "com.amazonaws.auditmanager#AssessmentReportName", "traits": { - "smithy.api#documentation": "\nThe name given to the assessment report.\n
" + "smithy.api#documentation": "The name that's given to the assessment report.
" } }, "description": { "target": "com.amazonaws.auditmanager#AssessmentReportDescription", "traits": { - "smithy.api#documentation": "\n The description of the specified assessment report.\n
" + "smithy.api#documentation": "The description of the specified assessment report.
" } }, "awsAccountId": { "target": "com.amazonaws.auditmanager#AccountId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified account. \n
" + "smithy.api#documentation": "The identifier for the specified Amazon Web Services account.
" } }, "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
" + "smithy.api#documentation": "The identifier for the specified assessment.
" } }, "assessmentName": { "target": "com.amazonaws.auditmanager#AssessmentName", "traits": { - "smithy.api#documentation": "\nThe name of the associated assessment.\n
" + "smithy.api#documentation": "The name of the associated assessment.
" } }, "author": { "target": "com.amazonaws.auditmanager#Username", "traits": { - "smithy.api#documentation": "\n The name of the user who created the assessment report.\n
" + "smithy.api#documentation": "The name of the user who created the assessment report.
" } }, "status": { "target": "com.amazonaws.auditmanager#AssessmentReportStatus", "traits": { - "smithy.api#documentation": "\nThe current status of the specified assessment report.\n
" + "smithy.api#documentation": "The current status of the specified assessment report.
" } }, "creationTime": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n Specifies when the assessment report was created. \n
" + "smithy.api#documentation": "Specifies when the assessment report was created.
" } } }, "traits": { - "smithy.api#documentation": "\n A finalized document generated from an Audit Manager assessment. These reports summarize the relevant evidence collected for your audit, and link to the relevant evidence folders which are named and organized according to the controls specified in your assessment.\n
" + "smithy.api#documentation": "A finalized document that's generated from an Audit Manager assessment. These\n reports summarize the relevant evidence that was collected for your audit, and link to the\n relevant evidence folders. These evidence folders are named and organized according to the\n controls that are specified in your assessment.
" } }, "com.amazonaws.auditmanager#AssessmentReportDescription": { @@ -857,24 +961,24 @@ "evidenceId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the evidence. \n
" + "smithy.api#documentation": "The identifier for the evidence.
" } }, "errorCode": { "target": "com.amazonaws.auditmanager#ErrorCode", "traits": { - "smithy.api#documentation": "\n The error code returned by the AssessmentReportEvidence API. \n
The error code that the AssessmentReportEvidence API returned.
\n The error message returned by the AssessmentReportEvidence API. \n
The error message that the AssessmentReportEvidence API returned.
\n An error entity for the AssessmentReportEvidence API. This is used to provide more meaningful errors than a simple string message.\n
An error entity for the AssessmentReportEvidence API. This is used to\n provide more meaningful errors than a simple string message.
\nThe unique identifier for the assessment report.\n
" + "smithy.api#documentation": "The unique identifier for the assessment report.
" } }, "name": { "target": "com.amazonaws.auditmanager#AssessmentReportName", "traits": { - "smithy.api#documentation": "\nThe name of the assessment report.\n
" + "smithy.api#documentation": "The name of the assessment report.
" } }, "description": { "target": "com.amazonaws.auditmanager#AssessmentReportDescription", "traits": { - "smithy.api#documentation": "\nThe description of the specified assessment report.\n
" + "smithy.api#documentation": "The description of the assessment report.
" } }, "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The unique identifier for the associated assessment.\n
" + "smithy.api#documentation": "The unique identifier for the associated assessment.
" } }, "assessmentName": { "target": "com.amazonaws.auditmanager#AssessmentName", "traits": { - "smithy.api#documentation": "The name of the associated assessment. \n
" + "smithy.api#documentation": "The name of the associated assessment.
" } }, "author": { "target": "com.amazonaws.auditmanager#Username", "traits": { - "smithy.api#documentation": "\n The name of the user who created the assessment report.\n
" + "smithy.api#documentation": "The name of the user who created the assessment report.
" } }, "status": { "target": "com.amazonaws.auditmanager#AssessmentReportStatus", "traits": { - "smithy.api#documentation": "\nThe current status of the assessment report.\n
" + "smithy.api#documentation": "The current status of the assessment report.
" } }, "creationTime": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n Specifies when the assessment report was created.\n
" + "smithy.api#documentation": "Specifies when the assessment report was created.
" } } }, "traits": { - "smithy.api#documentation": "\n The metadata objects associated with the specified assessment report.\n
" + "smithy.api#documentation": "The metadata objects that are associated with the specified assessment report.
" } }, "com.amazonaws.auditmanager#AssessmentReportName": { @@ -974,18 +1078,18 @@ "destinationType": { "target": "com.amazonaws.auditmanager#AssessmentReportDestinationType", "traits": { - "smithy.api#documentation": "\n The destination type, such as Amazon S3. \n
" + "smithy.api#documentation": "The destination type, such as Amazon S3.
" } }, "destination": { "target": "com.amazonaws.auditmanager#S3Url", "traits": { - "smithy.api#documentation": "\n The destination of the assessment report.\n
" + "smithy.api#documentation": "The destination of the assessment report.
" } } }, "traits": { - "smithy.api#documentation": "\n The location in which Audit Manager saves assessment reports for the given assessment.\n
" + "smithy.api#documentation": "The location where Audit Manager saves assessment reports for the given\n assessment.
" } }, "com.amazonaws.auditmanager#AssessmentReportsMetadata": { @@ -1032,7 +1136,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Associates an evidence folder to the specified assessment report in Audit Manager. \n
", + "smithy.api#documentation": "Associates an evidence folder to an assessment report in a Audit Manager\n assessment.
", "smithy.api#http": { "method": "PUT", "uri": "/assessments/{assessmentId}/associateToAssessmentReport", @@ -1046,7 +1150,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1054,7 +1158,7 @@ "evidenceFolderId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the folder in which evidence is stored.\n
", + "smithy.api#documentation": "The identifier for the folder that the evidence is stored in.
", "smithy.api#required": {} } } @@ -1097,7 +1201,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Associates a list of evidence to an assessment report in an Audit Manager assessment.\n
", + "smithy.api#documentation": "Associates a list of evidence to an assessment report in an Audit Manager\n assessment.
", "smithy.api#http": { "method": "PUT", "uri": "/assessments/{assessmentId}/batchAssociateToAssessmentReport", @@ -1111,7 +1215,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The unique identifier for the specified assessment.\n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1119,14 +1223,14 @@ "evidenceFolderId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the folder in which the evidence is stored.\n
", + "smithy.api#documentation": "The identifier for the folder that the evidence is stored in.
", "smithy.api#required": {} } }, "evidenceIds": { "target": "com.amazonaws.auditmanager#EvidenceIds", "traits": { - "smithy.api#documentation": "\n The list of evidence identifiers. \n
", + "smithy.api#documentation": "The list of evidence identifiers.
", "smithy.api#required": {} } } @@ -1138,13 +1242,13 @@ "evidenceIds": { "target": "com.amazonaws.auditmanager#EvidenceIds", "traits": { - "smithy.api#documentation": "\n The identifier for the evidence. \n
" + "smithy.api#documentation": "The list of evidence identifiers.
" } }, "errors": { "target": "com.amazonaws.auditmanager#AssessmentReportEvidenceErrors", "traits": { - "smithy.api#documentation": "\n A list of errors returned by the BatchAssociateAssessmentReportEvidence API. \n
A list of errors that the BatchAssociateAssessmentReportEvidence API\n returned.
\n Create a batch of delegations for a specified assessment in Audit Manager.\n
", + "smithy.api#documentation": "Creates a batch of delegations for an assessment in Audit Manager.
", "smithy.api#http": { "method": "POST", "uri": "/assessments/{assessmentId}/delegations", @@ -1186,24 +1290,24 @@ "createDelegationRequest": { "target": "com.amazonaws.auditmanager#CreateDelegationRequest", "traits": { - "smithy.api#documentation": "\n The API request to batch create delegations in Audit Manager.\n
" + "smithy.api#documentation": "The API request to batch create delegations in Audit Manager.
" } }, "errorCode": { "target": "com.amazonaws.auditmanager#ErrorCode", "traits": { - "smithy.api#documentation": "\n The error code returned by the BatchCreateDelegationByAssessment API. \n
The error code that the BatchCreateDelegationByAssessment API returned.\n
\n The error message returned by the BatchCreateDelegationByAssessment API. \n
The error message that the BatchCreateDelegationByAssessment API returned.\n
\n An error entity for the BatchCreateDelegationByAssessment API. This is used to provide more meaningful errors than a simple string message.\n
An error entity for the BatchCreateDelegationByAssessment API. This is\n used to provide more meaningful errors than a simple string message.
\n The API request to batch create delegations in Audit Manager.\n
", + "smithy.api#documentation": "The API request to batch create delegations in Audit Manager.
", "smithy.api#required": {} } }, "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1238,13 +1342,13 @@ "delegations": { "target": "com.amazonaws.auditmanager#Delegations", "traits": { - "smithy.api#documentation": "\n The delegations associated with the assessment. \n
" + "smithy.api#documentation": "The delegations that are associated with the assessment.
" } }, "errors": { "target": "com.amazonaws.auditmanager#BatchCreateDelegationByAssessmentErrors", "traits": { - "smithy.api#documentation": "\n A list of errors returned by the BatchCreateDelegationByAssessment API. \n
A list of errors that the BatchCreateDelegationByAssessment API returned.\n
\n Deletes the delegations in the specified Audit Manager assessment.\n
", + "smithy.api#documentation": "Deletes a batch of delegations for an assessment in Audit Manager.
", "smithy.api#http": { "method": "PUT", "uri": "/assessments/{assessmentId}/delegations", @@ -1286,24 +1390,24 @@ "delegationId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified delegation.\n
" + "smithy.api#documentation": "The identifier for the delegation.
" } }, "errorCode": { "target": "com.amazonaws.auditmanager#ErrorCode", "traits": { - "smithy.api#documentation": "\n The error code returned by the BatchDeleteDelegationByAssessment API.\n
The error code that the BatchDeleteDelegationByAssessment API returned.\n
\n The error message returned by the BatchDeleteDelegationByAssessment API.\n
The error message that the BatchDeleteDelegationByAssessment API returned.\n
\n An error entity for the BatchDeleteDelegationByAssessment API. This is used to provide more meaningful errors than a simple string message.\n
An error entity for the BatchDeleteDelegationByAssessment API. This is\n used to provide more meaningful errors than a simple string message.
\n The identifiers for the specified delegations.\n
", + "smithy.api#documentation": "The identifiers for the delegations.
", "smithy.api#required": {} } }, "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1338,7 +1442,7 @@ "errors": { "target": "com.amazonaws.auditmanager#BatchDeleteDelegationByAssessmentErrors", "traits": { - "smithy.api#documentation": "\n A list of errors returned by the BatchDeleteDelegationByAssessment API. \n
A list of errors that the BatchDeleteDelegationByAssessment API returned.\n
\n Disassociates a list of evidence from the specified assessment report in Audit Manager. \n
", + "smithy.api#documentation": "Disassociates a list of evidence from an assessment report in Audit Manager.\n
", "smithy.api#http": { "method": "PUT", "uri": "/assessments/{assessmentId}/batchDisassociateFromAssessmentReport", @@ -1380,7 +1484,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1388,14 +1492,14 @@ "evidenceFolderId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the folder in which evidence is stored.\n
", + "smithy.api#documentation": "The identifier for the folder that the evidence is stored in.
", "smithy.api#required": {} } }, "evidenceIds": { "target": "com.amazonaws.auditmanager#EvidenceIds", "traits": { - "smithy.api#documentation": "\n The list of evidence identifiers. \n
", + "smithy.api#documentation": "The list of evidence identifiers.
", "smithy.api#required": {} } } @@ -1407,13 +1511,13 @@ "evidenceIds": { "target": "com.amazonaws.auditmanager#EvidenceIds", "traits": { - "smithy.api#documentation": "\n The identifier for the evidence. \n
" + "smithy.api#documentation": "The identifier for the evidence.
" } }, "errors": { "target": "com.amazonaws.auditmanager#AssessmentReportEvidenceErrors", "traits": { - "smithy.api#documentation": "\n A list of errors returned by the BatchDisassociateAssessmentReportEvidence API. \n
A list of errors that the BatchDisassociateAssessmentReportEvidence API\n returned.
\n Uploads one or more pieces of evidence to the specified control in the assessment in Audit Manager.\n
", + "smithy.api#documentation": "Uploads one or more pieces of evidence to a control in an Audit Manager\n assessment.
", "smithy.api#http": { "method": "POST", "uri": "/assessments/{assessmentId}/controlSets/{controlSetId}/controls/{controlId}/evidence", @@ -1455,24 +1559,24 @@ "manualEvidence": { "target": "com.amazonaws.auditmanager#ManualEvidence", "traits": { - "smithy.api#documentation": "\n Manual evidence that cannot be collected automatically by Audit Manager.\n
" + "smithy.api#documentation": "Manual evidence that can't be collected automatically by Audit Manager.
" } }, "errorCode": { "target": "com.amazonaws.auditmanager#ErrorCode", "traits": { - "smithy.api#documentation": "\n The error code returned by the BatchImportEvidenceToAssessmentControl API. \n
The error code that the BatchImportEvidenceToAssessmentControl API\n returned.
\n The error message returned by the BatchImportEvidenceToAssessmentControl API. \n
The error message that the BatchImportEvidenceToAssessmentControl API\n returned.
\n An error entity for the BatchImportEvidenceToAssessmentControl API. This is used to provide more meaningful errors than a simple string message.\n
An error entity for the BatchImportEvidenceToAssessmentControl API. This\n is used to provide more meaningful errors than a simple string message.
\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1495,7 +1599,7 @@ "controlSetId": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified control set.\n
", + "smithy.api#documentation": "The identifier for the control set.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1503,7 +1607,7 @@ "controlId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n \n The identifier for the specified control. \n
", + "smithy.api#documentation": "The identifier for the control.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1511,7 +1615,7 @@ "manualEvidence": { "target": "com.amazonaws.auditmanager#ManualEvidenceList", "traits": { - "smithy.api#documentation": "\n The list of manual evidence objects.\n
", + "smithy.api#documentation": "The list of manual evidence objects.
", "smithy.api#required": {} } } @@ -1523,7 +1627,7 @@ "errors": { "target": "com.amazonaws.auditmanager#BatchImportEvidenceToAssessmentControlErrors", "traits": { - "smithy.api#documentation": "\n A list of errors returned by the BatchImportEvidenceToAssessmentControl API. \n
A list of errors that the BatchImportEvidenceToAssessmentControl API\n returned.
Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors.
\nAudit Manager is a service that provides automated evidence collection so that you\n can continuously audit your Amazon Web Services usage, and assess the effectiveness of your controls to\n better manage risk and simplify compliance.
\nAudit Manager provides pre-built frameworks that structure and automate assessments\n for a given compliance standard. Frameworks include a pre-built collection of controls with\n descriptions and testing procedures, which are grouped according to the requirements of the\n specified compliance standard or regulation. You can also customize frameworks and controls\n to support internal audits with unique requirements.
\n \nUse the following links to get started with the Audit Manager API:
\n\n Actions: An alphabetical list of all Audit Manager API operations.
\n\n Data types: An alphabetical list of all Audit Manager data types.
\n\n Common parameters: Parameters that all Query operations can use.
\n\n Common errors: Client and server errors that all operations can return.
\nIf you're new to Audit Manager, we recommend that you review the Audit Manager User Guide.
", + "smithy.api#documentation": "Welcome to the Audit Manager API reference. This guide is for developers who\n need detailed information about the Audit Manager API operations, data types, and\n errors.
\nAudit Manager is a service that provides automated evidence collection so that\n you can continually audit your Amazon Web Services usage. You can use it to assess the\n effectiveness of your controls, manage risk, and simplify compliance.
\nAudit Manager provides prebuilt frameworks that structure and automate\n assessments for a given compliance standard. Frameworks include a prebuilt collection of\n controls with descriptions and testing procedures. These controls are grouped according to\n the requirements of the specified compliance standard or regulation. You can also customize\n frameworks and controls to support internal audits with specific requirements.
\nUse the following links to get started with the Audit Manager API:
\n\n Actions: An\n alphabetical list of all Audit Manager API operations.
\n\n Data types: An alphabetical list of all Audit Manager data\n types.
\n\n Common\n parameters: Parameters that all Query operations can use.
\n\n Common errors:\n Client and server errors that all operations can return.
\nIf you're new to Audit Manager, we recommend that you review the \n Audit Manager User Guide.
", "smithy.api#title": "AWS Audit Manager" } }, @@ -1714,36 +1830,36 @@ "objectType": { "target": "com.amazonaws.auditmanager#ObjectTypeEnum", "traits": { - "smithy.api#documentation": "\n The changelog object type, such as an assessment, control, or control set. \n
" + "smithy.api#documentation": "The object that was changed, such as an assessment, control, or control set.
" } }, "objectName": { "target": "com.amazonaws.auditmanager#NonEmptyString", "traits": { - "smithy.api#documentation": "\n The name of the changelog object. \n
" + "smithy.api#documentation": "The name of the object that changed. This could be the name of an assessment, control,\n or control set.
" } }, "action": { "target": "com.amazonaws.auditmanager#ActionEnum", "traits": { - "smithy.api#documentation": "\n The action performed. \n
" + "smithy.api#documentation": "The action that was performed.
" } }, "createdAt": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n The time of creation for the changelog object. \n
" + "smithy.api#documentation": "The time when the action was performed and the changelog record was created.
" } }, "createdBy": { "target": "com.amazonaws.auditmanager#IamArn", "traits": { - "smithy.api#documentation": "\n The IAM user or role that performed the action. \n
" + "smithy.api#documentation": "The IAM user or role that performed the action.
" } } }, "traits": { - "smithy.api#documentation": "\n The record of a change within Audit Manager, such as a modified assessment, a delegated control set, and so on. \n
" + "smithy.api#documentation": "The record of a change within Audit Manager. For example, this could be the\n status change of an assessment or the delegation of a control set.
" } }, "com.amazonaws.auditmanager#ChangeLogs": { @@ -1768,96 +1884,96 @@ "arn": { "target": "com.amazonaws.auditmanager#AuditManagerArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the specified control.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control.
" } }, "id": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\nThe unique identifier for the control.\n
" + "smithy.api#documentation": "The unique identifier for the control.
" } }, "type": { "target": "com.amazonaws.auditmanager#ControlType", "traits": { - "smithy.api#documentation": "\nThe type of control, such as custom or standard.\n
" + "smithy.api#documentation": "The type of control, such as a custom control or a standard control.
" } }, "name": { "target": "com.amazonaws.auditmanager#ControlName", "traits": { - "smithy.api#documentation": "\nThe name of the specified control.\n
" + "smithy.api#documentation": "The name of the control.
" } }, "description": { "target": "com.amazonaws.auditmanager#ControlDescription", "traits": { - "smithy.api#documentation": "\n The description of the specified control. \n
" + "smithy.api#documentation": "The description of the control.
" } }, "testingInformation": { "target": "com.amazonaws.auditmanager#TestingInformation", "traits": { - "smithy.api#documentation": "\n The steps to follow to determine if the control has been satisfied.\n
" + "smithy.api#documentation": "The steps that you should follow to determine if the control has been satisfied.\n
" } }, "actionPlanTitle": { "target": "com.amazonaws.auditmanager#ActionPlanTitle", "traits": { - "smithy.api#documentation": "\n The title of the action plan for remediating the control.\n
" + "smithy.api#documentation": "The title of the action plan for remediating the control.
" } }, "actionPlanInstructions": { "target": "com.amazonaws.auditmanager#ActionPlanInstructions", "traits": { - "smithy.api#documentation": "\n \n The recommended actions to carry out if the control is not fulfilled.\n
" + "smithy.api#documentation": "The recommended actions to carry out if the control isn't fulfilled.
" } }, "controlSources": { "target": "com.amazonaws.auditmanager#ControlSources", "traits": { - "smithy.api#documentation": "\n The data source that determines from where Audit Manager collects evidence for the control. \n
" + "smithy.api#documentation": "The data source that determines where Audit Manager collects evidence from for\n the control.
" } }, "controlMappingSources": { "target": "com.amazonaws.auditmanager#ControlMappingSources", "traits": { - "smithy.api#documentation": "\n The data mapping sources for the specified control.\n
" + "smithy.api#documentation": "The data mapping sources for the control.
" } }, "createdAt": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\nSpecifies when the control was created.\n
" + "smithy.api#documentation": "Specifies when the control was created.
" } }, "lastUpdatedAt": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\nSpecifies when the control was most recently updated.\n
" + "smithy.api#documentation": "Specifies when the control was most recently updated.
" } }, "createdBy": { "target": "com.amazonaws.auditmanager#CreatedBy", "traits": { - "smithy.api#documentation": "\n The IAM user or role that created the control.\n
" + "smithy.api#documentation": "The IAM user or role that created the control.
" } }, "lastUpdatedBy": { "target": "com.amazonaws.auditmanager#LastUpdatedBy", "traits": { - "smithy.api#documentation": "\n The IAM user or role that most recently updated the control. \n
" + "smithy.api#documentation": "The IAM user or role that most recently updated the control.
" } }, "tags": { "target": "com.amazonaws.auditmanager#TagMap", "traits": { - "smithy.api#documentation": "\n The tags associated with the control.\n
" + "smithy.api#documentation": "The tags associated with the control.
" } } }, "traits": { - "smithy.api#documentation": "\n A control in Audit Manager.\n
" + "smithy.api#documentation": "A control in Audit Manager.
" } }, "com.amazonaws.auditmanager#ControlComment": { @@ -1866,24 +1982,24 @@ "authorName": { "target": "com.amazonaws.auditmanager#Username", "traits": { - "smithy.api#documentation": "\n The name of the user who authored the comment. \n
" + "smithy.api#documentation": "The name of the user who authored the comment.
" } }, "commentBody": { "target": "com.amazonaws.auditmanager#ControlCommentBody", "traits": { - "smithy.api#documentation": "\n The body text of a control comment. \n
" + "smithy.api#documentation": "The body text of a control comment.
" } }, "postedDate": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n The time when the comment was posted. \n
" + "smithy.api#documentation": "The time when the comment was posted.
" } } }, "traits": { - "smithy.api#documentation": "\n A comment posted by a user on a control. This includes the author's name, the comment text, and a timestamp. \n
" + "smithy.api#documentation": "A comment that's posted by a user on a control. This includes the author's name, the\n comment text, and a timestamp.
" } }, "com.amazonaws.auditmanager#ControlCommentBody": { @@ -1918,31 +2034,31 @@ "sourceId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\nThe unique identifier for the specified source.\n
" + "smithy.api#documentation": "The unique identifier for the source.
" } }, "sourceName": { "target": "com.amazonaws.auditmanager#SourceName", "traits": { - "smithy.api#documentation": "\nThe name of the specified source.\n
" + "smithy.api#documentation": "The name of the source.
" } }, "sourceDescription": { "target": "com.amazonaws.auditmanager#SourceDescription", "traits": { - "smithy.api#documentation": "\nThe description of the specified source.\n
" + "smithy.api#documentation": "The description of the source.
" } }, "sourceSetUpOption": { "target": "com.amazonaws.auditmanager#SourceSetUpOption", "traits": { - "smithy.api#documentation": "\n The setup option for the data source, which reflects if the evidence collection is automated or manual.\n
" + "smithy.api#documentation": "The setup option for the data source. This option reflects if the evidence collection\n is automated or manual.
" } }, "sourceType": { "target": "com.amazonaws.auditmanager#SourceType", "traits": { - "smithy.api#documentation": "\n Specifies one of the five types of data sources for evidence collection.\n
" + "smithy.api#documentation": "Specifies one of the five types of data sources for evidence collection.
" } }, "sourceKeyword": { @@ -1951,18 +2067,18 @@ "sourceFrequency": { "target": "com.amazonaws.auditmanager#SourceFrequency", "traits": { - "smithy.api#documentation": "\n The frequency of evidence collection for the specified control mapping source.\n
" + "smithy.api#documentation": "The frequency of evidence collection for the control mapping source.
" } }, "troubleshootingText": { "target": "com.amazonaws.auditmanager#TroubleshootingText", "traits": { - "smithy.api#documentation": "\n The instructions for troubleshooting the specified control.\n
" + "smithy.api#documentation": "The instructions for troubleshooting the control.
" } } }, "traits": { - "smithy.api#documentation": "\n The data source that determines from where Audit Manager collects evidence for the control.\n
" + "smithy.api#documentation": "The data source that determines where Audit Manager collects evidence from for\n the control.
" } }, "com.amazonaws.auditmanager#ControlMappingSources": { @@ -1982,42 +2098,42 @@ "arn": { "target": "com.amazonaws.auditmanager#AuditManagerArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the specified control.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control.
" } }, "id": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\nThe unique identifier for the specified control.\n
" + "smithy.api#documentation": "The unique identifier for the control.
" } }, "name": { "target": "com.amazonaws.auditmanager#ControlName", "traits": { - "smithy.api#documentation": "\nThe name of the specified control.\n
" + "smithy.api#documentation": "The name of the control.
" } }, "controlSources": { "target": "com.amazonaws.auditmanager#ControlSources", "traits": { - "smithy.api#documentation": "\n The data source that determines from where Audit Manager collects evidence for the control.\n
" + "smithy.api#documentation": "The data source that determines where Audit Manager collects evidence from for\n the control.
" } }, "createdAt": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n Specifies when the control was created.\n
" + "smithy.api#documentation": "Specifies when the control was created.
" } }, "lastUpdatedAt": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n Specifies when the control was most recently updated.\n
" + "smithy.api#documentation": "Specifies when the control was most recently updated.
" } } }, "traits": { - "smithy.api#documentation": "\n The metadata associated with the specified standard or custom control.\n
" + "smithy.api#documentation": "The metadata that's associated with the standard control or custom control.
" } }, "com.amazonaws.auditmanager#ControlMetadataList": { @@ -2065,24 +2181,24 @@ "id": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier of the control set in the assessment. This is the control set name in a plain string format. \n
" + "smithy.api#documentation": "The identifier of the control set in the assessment. This is the control set name in a\n plain string format.
" } }, "name": { "target": "com.amazonaws.auditmanager#ControlSetName", "traits": { - "smithy.api#documentation": "\nThe name of the control set.\n
" + "smithy.api#documentation": "The name of the control set.
" } }, "controls": { "target": "com.amazonaws.auditmanager#Controls", "traits": { - "smithy.api#documentation": "\n The list of controls within the control set. \n
" + "smithy.api#documentation": "The list of controls within the control set.
" } } }, "traits": { - "smithy.api#documentation": "\n A set of controls in Audit Manager.\n
" + "smithy.api#documentation": "A set of controls in Audit Manager.
" } }, "com.amazonaws.auditmanager#ControlSetId": { @@ -2102,7 +2218,7 @@ "min": 1, "max": 300 }, - "smithy.api#pattern": "^[^\\_]*$" + "smithy.api#pattern": "^[^\\\\\\_]*$" } }, "com.amazonaws.auditmanager#ControlSetStatus": { @@ -2219,7 +2335,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Creates an assessment in Audit Manager. \n
", + "smithy.api#documentation": "Creates an assessment in Audit Manager.
", "smithy.api#http": { "method": "POST", "uri": "/assessments", @@ -2250,7 +2366,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Creates a custom framework in Audit Manager. \n
", + "smithy.api#documentation": "Creates a custom framework in Audit Manager.
", "smithy.api#http": { "method": "POST", "uri": "/assessmentFrameworks", @@ -2264,12 +2380,12 @@ "id": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\nThe unique identifier of the control.\n
" + "smithy.api#documentation": "The unique identifier of the control.
" } } }, "traits": { - "smithy.api#documentation": "\n Control entity attributes that uniquely identify an existing control to be added to a framework in Audit Manager.\n
" + "smithy.api#documentation": "The control entity attributes that uniquely identify an existing control to be added to\n a framework in Audit Manager.
" } }, "com.amazonaws.auditmanager#CreateAssessmentFrameworkControlSet": { @@ -2278,19 +2394,19 @@ "name": { "target": "com.amazonaws.auditmanager#ControlSetName", "traits": { - "smithy.api#documentation": "\nThe name of the specified control set.\n
", + "smithy.api#documentation": "The name of the control set.
", "smithy.api#required": {} } }, "controls": { "target": "com.amazonaws.auditmanager#CreateAssessmentFrameworkControls", "traits": { - "smithy.api#documentation": "\n The list of controls within the control set. This does not contain the control set ID.\n
" + "smithy.api#documentation": "The list of controls within the control set. This doesn't contain the control set ID.\n
" } } }, "traits": { - "smithy.api#documentation": "\n A controlSet entity that represents a collection of controls in Audit Manager. This does not contain the control set ID.\n
A controlSet entity that represents a collection of controls in Audit Manager. This doesn't contain the control set ID.
\nThe name of the new custom framework.\n
", + "smithy.api#documentation": "The name of the new custom framework.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.auditmanager#FrameworkDescription", "traits": { - "smithy.api#documentation": "\nAn optional description for the new custom framework.\n
" + "smithy.api#documentation": "An optional description for the new custom framework.
" } }, "complianceType": { "target": "com.amazonaws.auditmanager#ComplianceType", "traits": { - "smithy.api#documentation": "\nThe compliance type that the new custom framework supports, such as CIS or HIPAA.\n
" + "smithy.api#documentation": "The compliance type that the new custom framework supports, such as CIS or HIPAA.\n
" } }, "controlSets": { "target": "com.amazonaws.auditmanager#CreateAssessmentFrameworkControlSets", "traits": { - "smithy.api#documentation": "\n The control sets to be associated with the framework. \n
", + "smithy.api#documentation": "The control sets that are associated with the framework.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.auditmanager#TagMap", "traits": { - "smithy.api#documentation": "\n The tags associated with the framework.\n
" + "smithy.api#documentation": "The tags that are associated with the framework.
" } } } @@ -2358,7 +2474,7 @@ "framework": { "target": "com.amazonaws.auditmanager#Framework", "traits": { - "smithy.api#documentation": "\n The name of the new framework returned by the CreateAssessmentFramework API.\n
The name of the new framework that the CreateAssessmentFramework API\n returned.
\nCreates an assessment report for the specified assessment.\n
", + "smithy.api#documentation": "Creates an assessment report for the specified assessment.
", "smithy.api#http": { "method": "POST", "uri": "/assessments/{assessmentId}/reports", @@ -2400,20 +2516,20 @@ "name": { "target": "com.amazonaws.auditmanager#AssessmentReportName", "traits": { - "smithy.api#documentation": "\nThe name of the new assessment report.\n
", + "smithy.api#documentation": "The name of the new assessment report.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.auditmanager#AssessmentReportDescription", "traits": { - "smithy.api#documentation": "\nThe description of the assessment report.\n
" + "smithy.api#documentation": "The description of the assessment report.
" } }, "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2426,7 +2542,7 @@ "assessmentReport": { "target": "com.amazonaws.auditmanager#AssessmentReport", "traits": { - "smithy.api#documentation": "\n The new assessment report returned by the CreateAssessmentReport API.\n
The new assessment report that the CreateAssessmentReport API returned.\n
\n The name of the assessment to be created.\n
", + "smithy.api#documentation": "The name of the assessment to be created.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.auditmanager#AssessmentDescription", "traits": { - "smithy.api#documentation": "\n The optional description of the assessment to be created.\n
" + "smithy.api#documentation": "The optional description of the assessment to be created.
" } }, "assessmentReportsDestination": { "target": "com.amazonaws.auditmanager#AssessmentReportsDestination", "traits": { - "smithy.api#documentation": "\n The assessment report storage destination for the specified assessment that is being created. \n
", + "smithy.api#documentation": "The assessment report storage destination for the assessment that's being created.
", "smithy.api#required": {} } }, @@ -2463,21 +2579,21 @@ "roles": { "target": "com.amazonaws.auditmanager#Roles", "traits": { - "smithy.api#documentation": "\n The list of roles for the specified assessment. \n
", + "smithy.api#documentation": "The list of roles for the assessment.
", "smithy.api#required": {} } }, "frameworkId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified framework. \n
", + "smithy.api#documentation": "The identifier for the framework that the assessment will be created from.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.auditmanager#TagMap", "traits": { - "smithy.api#documentation": "\n The tags associated with the assessment. \n
" + "smithy.api#documentation": "The tags that are associated with the assessment.
" } } } @@ -2513,7 +2629,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Creates a new custom control in Audit Manager.\n
", + "smithy.api#documentation": "Creates a new custom control in Audit Manager.
", "smithy.api#http": { "method": "POST", "uri": "/controls", @@ -2527,25 +2643,25 @@ "sourceName": { "target": "com.amazonaws.auditmanager#SourceName", "traits": { - "smithy.api#documentation": "\nThe name of the control mapping data source.\n
" + "smithy.api#documentation": "The name of the control mapping data source.
" } }, "sourceDescription": { "target": "com.amazonaws.auditmanager#SourceDescription", "traits": { - "smithy.api#documentation": "\n The description of the data source that determines from where Audit Manager collects evidence for the control. \n
" + "smithy.api#documentation": "The description of the data source that determines where Audit Manager collects\n evidence from for the control.
" } }, "sourceSetUpOption": { "target": "com.amazonaws.auditmanager#SourceSetUpOption", "traits": { - "smithy.api#documentation": "\n The setup option for the data source, which reflects if the evidence collection is automated or manual.\n
" + "smithy.api#documentation": "The setup option for the data source, which reflects if the evidence collection is\n automated or manual.
" } }, "sourceType": { "target": "com.amazonaws.auditmanager#SourceType", "traits": { - "smithy.api#documentation": "\n Specifies one of the five types of data sources for evidence collection.\n \n
" + "smithy.api#documentation": "Specifies one of the five types of data sources for evidence collection.
" } }, "sourceKeyword": { @@ -2554,18 +2670,18 @@ "sourceFrequency": { "target": "com.amazonaws.auditmanager#SourceFrequency", "traits": { - "smithy.api#documentation": "\n The frequency of evidence collection for the specified control mapping source.\n
" + "smithy.api#documentation": "The frequency of evidence collection for the control mapping source.
" } }, "troubleshootingText": { "target": "com.amazonaws.auditmanager#TroubleshootingText", "traits": { - "smithy.api#documentation": "\nThe instructions for troubleshooting the specified control.\n
" + "smithy.api#documentation": "The instructions for troubleshooting the control.
" } } }, "traits": { - "smithy.api#documentation": "\n Control mapping fields that represent the source for evidence collection, along with related parameters and metadata. This does not contain mappingID.\n
The control mapping fields that represent the source for evidence collection, along\n with related parameters and metadata. This doesn't contain mappingID.
\nThe name of the control.\n
", + "smithy.api#documentation": "The name of the control.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.auditmanager#ControlDescription", "traits": { - "smithy.api#documentation": "\nThe description of the control.\n
" + "smithy.api#documentation": "The description of the control.
" } }, "testingInformation": { "target": "com.amazonaws.auditmanager#TestingInformation", "traits": { - "smithy.api#documentation": "\n The steps to follow to determine if the control has been satisfied.\n
" + "smithy.api#documentation": "The steps to follow to determine if the control is satisfied.
" } }, "actionPlanTitle": { "target": "com.amazonaws.auditmanager#ActionPlanTitle", "traits": { - "smithy.api#documentation": "\n The title of the action plan for remediating the control.\n
" + "smithy.api#documentation": "The title of the action plan for remediating the control.
" } }, "actionPlanInstructions": { "target": "com.amazonaws.auditmanager#ActionPlanInstructions", "traits": { - "smithy.api#documentation": "\n The recommended actions to carry out if the control is not fulfilled.\n
" + "smithy.api#documentation": "The recommended actions to carry out if the control isn't fulfilled.
" } }, "controlMappingSources": { "target": "com.amazonaws.auditmanager#CreateControlMappingSources", "traits": { - "smithy.api#documentation": "\n The data mapping sources for the specified control.\n
", + "smithy.api#documentation": "The data mapping sources for the control.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.auditmanager#TagMap", "traits": { - "smithy.api#documentation": "\n The tags associated with the control.\n
" + "smithy.api#documentation": "The tags that are associated with the control.
" } } } @@ -2634,7 +2750,7 @@ "control": { "target": "com.amazonaws.auditmanager#Control", "traits": { - "smithy.api#documentation": "\n The new control returned by the CreateControl API. \n
The new control that the CreateControl API returned.
\n A comment related to the delegation request. \n
" + "smithy.api#documentation": "A comment that's related to the delegation request.
" } }, "controlSetId": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "\n The unique identifier for the control set. \n
" + "smithy.api#documentation": "The unique identifier for the control set.
" } }, "roleArn": { "target": "com.amazonaws.auditmanager#IamArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the IAM role. \n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role.
" } }, "roleType": { "target": "com.amazonaws.auditmanager#RoleType", "traits": { - "smithy.api#documentation": "\n The type of customer persona.\n
\nIn CreateAssessment, roleType can only be PROCESS_OWNER.
In UpdateSettings, roleType can only be PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
The type of customer persona.
\nIn CreateAssessment, roleType can only be\n PROCESS_OWNER.
In UpdateSettings, roleType can only be\n PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be\n RESOURCE_OWNER.
\n A collection of attributes used to create a delegation for an assessment in Audit Manager.\n
" + "smithy.api#documentation": "A collection of attributes that's used to create a delegation for an assessment in\n Audit Manager.
" } }, "com.amazonaws.auditmanager#CreateDelegationRequests": { @@ -2699,37 +2815,37 @@ "id": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The unique identifier for the delegation. \n
" + "smithy.api#documentation": "The unique identifier for the delegation.
" } }, "assessmentName": { "target": "com.amazonaws.auditmanager#AssessmentName", "traits": { - "smithy.api#documentation": "\n The name of the associated assessment. \n
" + "smithy.api#documentation": "The name of the assessment that's associated with the delegation.
" } }, "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the associated assessment. \n
" + "smithy.api#documentation": "The identifier for the assessment that's associated with the delegation.
" } }, "status": { "target": "com.amazonaws.auditmanager#DelegationStatus", "traits": { - "smithy.api#documentation": "\n The status of the delegation. \n
" + "smithy.api#documentation": "The status of the delegation.
" } }, "roleArn": { "target": "com.amazonaws.auditmanager#IamArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the IAM role. \n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role.
" } }, "roleType": { "target": "com.amazonaws.auditmanager#RoleType", "traits": { - "smithy.api#documentation": "\n The type of customer persona.\n
\nIn CreateAssessment, roleType can only be PROCESS_OWNER.
In UpdateSettings, roleType can only be PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
The type of customer persona.
\nIn CreateAssessment, roleType can only be\n PROCESS_OWNER.
In UpdateSettings, roleType can only be\n PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be\n RESOURCE_OWNER.
\n Specifies when the delegation was last updated. \n
" + "smithy.api#documentation": "Specifies when the delegation was last updated.
" } }, "controlSetId": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "\n The identifier for the associated control set.\n
" + "smithy.api#documentation": "The identifier for the control set that's associated with the delegation.
" } }, "comment": { "target": "com.amazonaws.auditmanager#DelegationComment", "traits": { - "smithy.api#documentation": "\n The comment related to the delegation. \n
" + "smithy.api#documentation": "The comment that's related to the delegation.
" } }, "createdBy": { @@ -2764,7 +2880,7 @@ } }, "traits": { - "smithy.api#documentation": "\n The assignment of a control set to a delegate for review. \n
" + "smithy.api#documentation": "The assignment of a control set to a delegate for review.
" } }, "com.amazonaws.auditmanager#DelegationComment": { @@ -2795,48 +2911,48 @@ "id": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The unique identifier for the delegation. \n
" + "smithy.api#documentation": "The unique identifier for the delegation.
" } }, "assessmentName": { "target": "com.amazonaws.auditmanager#AssessmentName", "traits": { - "smithy.api#documentation": "\n The name of the associated assessment. \n
" + "smithy.api#documentation": "The name of the associated assessment.
" } }, "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The unique identifier for the specified assessment.\n
" + "smithy.api#documentation": "The unique identifier for the assessment.
" } }, "status": { "target": "com.amazonaws.auditmanager#DelegationStatus", "traits": { - "smithy.api#documentation": "\nThe current status of the delgation.\n
" + "smithy.api#documentation": "The current status of the delegation.
" } }, "roleArn": { "target": "com.amazonaws.auditmanager#IamArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the IAM role. \n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role.
" } }, "creationTime": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n Specifies when the delegation was created.\n
" + "smithy.api#documentation": "Specifies when the delegation was created.
" } }, "controlSetName": { "target": "com.amazonaws.auditmanager#NonEmptyString", "traits": { - "smithy.api#documentation": "\nSpecifies the name of the control set delegated for review.\n
" + "smithy.api#documentation": "Specifies the name of the control set that was delegated for review.
" } } }, "traits": { - "smithy.api#documentation": "\n The metadata associated with the specified delegation.\n
" + "smithy.api#documentation": "The metadata that's associated with the delegation.
" } }, "com.amazonaws.auditmanager#DelegationMetadataList": { @@ -2893,7 +3009,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Deletes an assessment in Audit Manager. \n
", + "smithy.api#documentation": "Deletes an assessment in Audit Manager.
", "smithy.api#http": { "method": "DELETE", "uri": "/assessments/{assessmentId}", @@ -2924,7 +3040,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Deletes a custom framework in Audit Manager.\n
", + "smithy.api#documentation": "Deletes a custom framework in Audit Manager.
", "smithy.api#http": { "method": "DELETE", "uri": "/assessmentFrameworks/{frameworkId}", @@ -2938,7 +3054,7 @@ "frameworkId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified framework. \n
", + "smithy.api#documentation": "The identifier for the framework.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2949,6 +3065,62 @@ "type": "structure", "members": {} }, + "com.amazonaws.auditmanager#DeleteAssessmentFrameworkShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.auditmanager#DeleteAssessmentFrameworkShareRequest" + }, + "output": { + "target": "com.amazonaws.auditmanager#DeleteAssessmentFrameworkShareResponse" + }, + "errors": [ + { + "target": "com.amazonaws.auditmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.auditmanager#InternalServerException" + }, + { + "target": "com.amazonaws.auditmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.auditmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Deletes a share request for a custom framework in Audit Manager.\n
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/assessmentFrameworkShareRequests/{requestId}", + "code": 200 + } + } + }, + "com.amazonaws.auditmanager#DeleteAssessmentFrameworkShareRequest": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.auditmanager#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier for the share request to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "requestType": { + "target": "com.amazonaws.auditmanager#ShareRequestType", + "traits": { + "smithy.api#documentation": "Specifies whether the share request is a sent request or a received request.
", + "smithy.api#httpQuery": "requestType", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.auditmanager#DeleteAssessmentFrameworkShareResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.auditmanager#DeleteAssessmentReport": { "type": "operation", "input": { @@ -2972,7 +3144,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Deletes an assessment report from an assessment in Audit Manager.\n
", + "smithy.api#documentation": "Deletes an assessment report from an assessment in Audit Manager.
", "smithy.api#http": { "method": "DELETE", "uri": "/assessments/{assessmentId}/reports/{assessmentReportId}", @@ -2986,7 +3158,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2994,7 +3166,7 @@ "assessmentReportId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\nThe unique identifier for the assessment report.\n
", + "smithy.api#documentation": "The unique identifier for the assessment report.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3011,7 +3183,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3045,7 +3217,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Deletes a custom control in Audit Manager.\n
", + "smithy.api#documentation": "Deletes a custom control in Audit Manager.
", "smithy.api#http": { "method": "DELETE", "uri": "/controls/{controlId}", @@ -3059,7 +3231,7 @@ "controlId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified control. \n
", + "smithy.api#documentation": "The identifier for the control.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3093,7 +3265,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Deregisters an account in Audit Manager.\n
", + "smithy.api#documentation": "Deregisters an account in Audit Manager.
", "smithy.api#http": { "method": "POST", "uri": "/account/deregisterAccount", @@ -3111,7 +3283,7 @@ "status": { "target": "com.amazonaws.auditmanager#AccountStatus", "traits": { - "smithy.api#documentation": "\nThe registration status of the account.\n
" + "smithy.api#documentation": "The registration status of the account.
" } } } @@ -3139,7 +3311,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specified member account as a delegated administrator for Audit Manager.
\nWhen you remove a delegated administrator from your Audit Manager settings, or when you\n deregister a delegated administrator from Organizations, you continue to have access\n to the evidence that you previously collected under that account. However, Audit Manager\n will stop collecting and attaching evidence to that delegated administrator account\n moving forward.
\nRemoves the specified member Amazon Web Services account as a delegated administrator for\n Audit Manager.
\nWhen you remove a delegated administrator from your Audit Manager settings, you\n continue to have access to the evidence that you previously collected under that\n account. This is also the case when you deregister a delegated administrator from\n Audit Manager. However, Audit Manager will stop collecting and attaching\n evidence to that delegated administrator account moving forward.
\n\n The identifier for the specified administrator account. \n
" + "smithy.api#documentation": "The identifier for the administrator account.
" } } } @@ -3185,7 +3357,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Disassociates an evidence folder from the specified assessment report in Audit Manager. \n
", + "smithy.api#documentation": "Disassociates an evidence folder from the specified assessment report in Audit Manager.
", "smithy.api#http": { "method": "PUT", "uri": "/assessments/{assessmentId}/disassociateFromAssessmentReport", @@ -3199,7 +3371,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3207,7 +3379,7 @@ "evidenceFolderId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the folder in which evidence is stored.\n
", + "smithy.api#documentation": "The identifier for the folder in which evidence is stored.
", "smithy.api#required": {} } } @@ -3263,96 +3435,96 @@ "dataSource": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "\n The data source from which the specified evidence was collected.\n
" + "smithy.api#documentation": "The data source where the evidence was collected from.
" } }, "evidenceAwsAccountId": { "target": "com.amazonaws.auditmanager#AccountId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified account. \n
" + "smithy.api#documentation": "The identifier for the Amazon Web Services account.
" } }, "time": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n The timestamp that represents when the evidence was collected.\n
" + "smithy.api#documentation": "The timestamp that represents when the evidence was collected.
" } }, "eventSource": { "target": "com.amazonaws.auditmanager#AWSServiceName", "traits": { - "smithy.api#documentation": "\n The Amazon Web Service from which the evidence is collected.\n
" + "smithy.api#documentation": "The Amazon Web Service that the evidence is collected from.
" } }, "eventName": { "target": "com.amazonaws.auditmanager#EventName", "traits": { - "smithy.api#documentation": "\n The name of the specified evidence event.\n
" + "smithy.api#documentation": "The name of the evidence event.
" } }, "evidenceByType": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "\n The type of automated evidence.\n
" + "smithy.api#documentation": "The type of automated evidence.
" } }, "resourcesIncluded": { "target": "com.amazonaws.auditmanager#Resources", "traits": { - "smithy.api#documentation": "\n The list of resources assessed to generate the evidence.\n
" + "smithy.api#documentation": "The list of resources that are assessed to generate the evidence.
" } }, "attributes": { "target": "com.amazonaws.auditmanager#EvidenceAttributes", "traits": { - "smithy.api#documentation": "\n The names and values used by the evidence event, including an attribute name (such as allowUsersToChangePassword) and value (such as true or false).\n
The names and values that are used by the evidence event. This includes an attribute\n name (such as allowUsersToChangePassword) and value (such as true\n or false).
\n The unique identifier for the IAM user or role associated with the evidence.\n
" + "smithy.api#documentation": "The unique identifier for the IAM user or role that's associated with\n the evidence.
" } }, "complianceCheck": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "The evaluation status for evidence that falls under the compliance check category. For\n evidence collected from Security Hub, a Pass or\n Fail result is shown. For evidence collected from Config, a\n Compliant or Noncompliant result is shown.
" + "smithy.api#documentation": "The evaluation status for evidence that falls under the compliance check category. For\n evidence collected from Security Hub, a Pass or\n Fail result is shown. For evidence collected from Config, a Compliant or Noncompliant\n result is shown.
" } }, "awsOrganization": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "\n The account from which the evidence is collected, and its organization path.\n
" + "smithy.api#documentation": "The Amazon Web Services account that the evidence is collected from, and its\n organization path.
" } }, "awsAccountId": { "target": "com.amazonaws.auditmanager#AccountId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified account. \n
" + "smithy.api#documentation": "The identifier for the Amazon Web Services account.
" } }, "evidenceFolderId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the folder in which the evidence is stored.\n
" + "smithy.api#documentation": "The identifier for the folder that the evidence is stored in.
" } }, "id": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "The identifier for the evidence. \n
" + "smithy.api#documentation": "The identifier for the evidence.
" } }, "assessmentReportSelection": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "\n Specifies whether the evidence is included in the assessment report.\n
" + "smithy.api#documentation": "Specifies whether the evidence is included in the assessment report.
" } } }, "traits": { - "smithy.api#documentation": "\n A record that contains the information needed to demonstrate compliance with the requirements specified by a control. Examples of evidence include change activity triggered by a user, or a system configuration snapshot. \n
" + "smithy.api#documentation": "A record that contains the information needed to demonstrate compliance with the\n requirements specified by a control. Examples of evidence include change activity triggered\n by a user, or a system configuration snapshot.
" } }, "com.amazonaws.auditmanager#EvidenceAttributeKey": { @@ -3424,90 +3596,90 @@ "arn": { "target": "com.amazonaws.auditmanager#AuditManagerArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the specified framework.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the framework.
" } }, "id": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\nThe unique identifier for the specified framework.\n
" + "smithy.api#documentation": "The unique identifier for the framework.
" } }, "name": { "target": "com.amazonaws.auditmanager#FrameworkName", "traits": { - "smithy.api#documentation": "\nThe name of the specified framework.\n
" + "smithy.api#documentation": "The name of the framework.
" } }, "type": { "target": "com.amazonaws.auditmanager#FrameworkType", "traits": { - "smithy.api#documentation": "\nThe framework type, such as custom or standard.\n
" + "smithy.api#documentation": "The framework type, such as a custom framework or a standard framework.
" } }, "complianceType": { "target": "com.amazonaws.auditmanager#ComplianceType", "traits": { - "smithy.api#documentation": "\n The compliance type that the new custom framework supports, such as CIS or HIPAA.\n
" + "smithy.api#documentation": "The compliance type that the new custom framework supports, such as CIS or HIPAA.\n
" } }, "description": { "target": "com.amazonaws.auditmanager#FrameworkDescription", "traits": { - "smithy.api#documentation": "\n The description of the specified framework.\n
" + "smithy.api#documentation": "The description of the framework.
" } }, "logo": { "target": "com.amazonaws.auditmanager#Filename", "traits": { - "smithy.api#documentation": "\n The logo associated with the framework. \n
" + "smithy.api#documentation": "The logo that's associated with the framework.
" } }, "controlSources": { "target": "com.amazonaws.auditmanager#ControlSources", "traits": { - "smithy.api#documentation": "\n The sources from which Audit Manager collects evidence for the control.\n
" + "smithy.api#documentation": "The sources that Audit Manager collects evidence from for the control.
" } }, "controlSets": { "target": "com.amazonaws.auditmanager#ControlSets", "traits": { - "smithy.api#documentation": "\n The control sets associated with the framework. \n
" + "smithy.api#documentation": "The control sets that are associated with the framework.
" } }, "createdAt": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n Specifies when the framework was created.\n
" + "smithy.api#documentation": "Specifies when the framework was created.
" } }, "lastUpdatedAt": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n Specifies when the framework was most recently updated.\n
" + "smithy.api#documentation": "Specifies when the framework was most recently updated.
" } }, "createdBy": { "target": "com.amazonaws.auditmanager#CreatedBy", "traits": { - "smithy.api#documentation": "\n The IAM user or role that created the framework.\n
" + "smithy.api#documentation": "The IAM user or role that created the framework.
" } }, "lastUpdatedBy": { "target": "com.amazonaws.auditmanager#LastUpdatedBy", "traits": { - "smithy.api#documentation": "\n The IAM user or role that most recently updated the framework. \n
" + "smithy.api#documentation": "The IAM user or role that most recently updated the framework.
" } }, "tags": { "target": "com.amazonaws.auditmanager#TagMap", "traits": { - "smithy.api#documentation": "\n The tags associated with the framework.\n
" + "smithy.api#documentation": "The tags that are associated with the framework.
" } } }, "traits": { - "smithy.api#documentation": "\n The file used to structure and automate Audit Manager assessments for a given compliance standard.\n
" + "smithy.api#documentation": "The file that's used to structure and automate Audit Manager assessments for a\n given compliance standard.
" } }, "com.amazonaws.auditmanager#FrameworkDescription": { @@ -3526,30 +3698,30 @@ "name": { "target": "com.amazonaws.auditmanager#AssessmentName", "traits": { - "smithy.api#documentation": "\n The name of the framework. \n
" + "smithy.api#documentation": "The name of the framework.
" } }, "description": { "target": "com.amazonaws.auditmanager#AssessmentFrameworkDescription", "traits": { - "smithy.api#documentation": "\n The description of the framework. \n
" + "smithy.api#documentation": "The description of the framework.
" } }, "logo": { "target": "com.amazonaws.auditmanager#Filename", "traits": { - "smithy.api#documentation": "\n The logo associated with the framework. \n
" + "smithy.api#documentation": "The logo that's associated with the framework.
" } }, "complianceType": { "target": "com.amazonaws.auditmanager#ComplianceType", "traits": { - "smithy.api#documentation": "\n The compliance standard associated with the framework, such as PCI-DSS or HIPAA.\n
" + "smithy.api#documentation": "The compliance standard that's associated with the framework. For example, this could\n be PCI DSS or HIPAA.
" } } }, "traits": { - "smithy.api#documentation": "\n The metadata of a framework, such as the name, ID, description, and so on. \n
" + "smithy.api#documentation": "The metadata of a framework, such as the name, ID, or description.
" } }, "com.amazonaws.auditmanager#FrameworkMetadataList": { @@ -3607,7 +3779,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns the registration status of an account in Audit Manager.\n
", + "smithy.api#documentation": "Returns the registration status of an account in Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/account/status", @@ -3625,7 +3797,7 @@ "status": { "target": "com.amazonaws.auditmanager#AccountStatus", "traits": { - "smithy.api#documentation": "\n The status of the specified account.\n
" + "smithy.api#documentation": "The status of the Amazon Web Services account.
" } } } @@ -3653,7 +3825,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns an assessment from Audit Manager.\n
", + "smithy.api#documentation": "Returns an assessment from Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}", @@ -3684,7 +3856,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns a framework from Audit Manager.\n
", + "smithy.api#documentation": "Returns a framework from Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/assessmentFrameworks/{frameworkId}", @@ -3698,7 +3870,7 @@ "frameworkId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified framework. \n
", + "smithy.api#documentation": "The identifier for the framework.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3711,7 +3883,7 @@ "framework": { "target": "com.amazonaws.auditmanager#Framework", "traits": { - "smithy.api#documentation": "\n The framework returned by the GetAssessmentFramework API.\n
The framework that the GetAssessmentFramework API returned.
\n Returns the URL of a specified assessment report in Audit Manager.\n
", + "smithy.api#documentation": "Returns the URL of an assessment report in Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/reports/{assessmentReportId}/url", @@ -3753,7 +3925,7 @@ "assessmentReportId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\nThe identifier for the assessment report.\n
", + "smithy.api#documentation": "The identifier for the assessment report.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3761,7 +3933,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3782,7 +3954,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3823,7 +3995,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns a list of changelogs from Audit Manager.\n
", + "smithy.api#documentation": "Returns a list of changelogs from Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/changelogs", @@ -3842,7 +4014,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3850,28 +4022,28 @@ "controlSetId": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified control set.\n
", + "smithy.api#documentation": "The identifier for the control set.
", "smithy.api#httpQuery": "controlSetId" } }, "controlId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n \n The identifier for the specified control. \n
", + "smithy.api#documentation": "The identifier for the control.
", "smithy.api#httpQuery": "controlId" } }, "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results.\n
", + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.auditmanager#MaxResults", "traits": { - "smithy.api#documentation": "\n Represents the maximum number of results per page, or per API request call. \n
", + "smithy.api#documentation": "Represents the maximum number of results on a page or for an API request call.
", "smithy.api#httpQuery": "maxResults" } } @@ -3883,13 +4055,13 @@ "changeLogs": { "target": "com.amazonaws.auditmanager#ChangeLogs", "traits": { - "smithy.api#documentation": "\n The list of user activity for the control.\n
" + "smithy.api#documentation": "The list of user activity for the control.
" } }, "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results.\n
" + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" } } } @@ -3917,7 +4089,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns a control from Audit Manager.\n
", + "smithy.api#documentation": "Returns a control from Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/controls/{controlId}", @@ -3931,7 +4103,7 @@ "controlId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n \n The identifier for the specified control. \n
", + "smithy.api#documentation": "The identifier for the control.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3944,7 +4116,7 @@ "control": { "target": "com.amazonaws.auditmanager#Control", "traits": { - "smithy.api#documentation": "\n The name of the control returned by the GetControl API. \n
The name of the control that the GetControl API returned.
\n Returns a list of delegations from an audit owner to a delegate. \n
", + "smithy.api#documentation": "Returns a list of delegations from an audit owner to a delegate.
", "smithy.api#http": { "method": "GET", "uri": "/delegations", @@ -3988,14 +4160,14 @@ "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results. \n
", + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.auditmanager#MaxResults", "traits": { - "smithy.api#documentation": "\n Represents the maximum number of results per page, or per API request call.\n
", + "smithy.api#documentation": "Represents the maximum number of results on a page or for an API request call.
", "smithy.api#httpQuery": "maxResults" } } @@ -4007,13 +4179,13 @@ "delegations": { "target": "com.amazonaws.auditmanager#DelegationMetadataList", "traits": { - "smithy.api#documentation": "\n The list of delegations returned by the GetDelegations API. \n
The list of delegations that the GetDelegations API returned.
\n The pagination token used to fetch the next set of results.\n
" + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" } } } @@ -4041,7 +4213,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns evidence from Audit Manager.\n
", + "smithy.api#documentation": "Returns evidence from Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence/{evidenceId}", @@ -4072,7 +4244,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns all evidence from a specified evidence folder in Audit Manager.\n
", + "smithy.api#documentation": "Returns all evidence from a specified evidence folder in Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}/evidence", @@ -4091,7 +4263,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4099,7 +4271,7 @@ "controlSetId": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "\n The identifier for the control set. \n
", + "smithy.api#documentation": "The identifier for the control set.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4107,7 +4279,7 @@ "evidenceFolderId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The unique identifier for the folder in which the evidence is stored.\n
", + "smithy.api#documentation": "The unique identifier for the folder that the evidence is stored in.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4115,14 +4287,14 @@ "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results.\n
", + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.auditmanager#MaxResults", "traits": { - "smithy.api#documentation": "\n Represents the maximum number of results per page, or per API request call. \n
", + "smithy.api#documentation": "Represents the maximum number of results on a page or for an API request call.
", "smithy.api#httpQuery": "maxResults" } } @@ -4134,13 +4306,13 @@ "evidence": { "target": "com.amazonaws.auditmanager#EvidenceList", "traits": { - "smithy.api#documentation": "\n The list of evidence returned by the GetEvidenceByEvidenceFolder API.\n
The list of evidence that the GetEvidenceByEvidenceFolder API returned.\n
\n The pagination token used to fetch the next set of results.\n
" + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" } } } @@ -4168,7 +4340,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns an evidence folder from the specified assessment in Audit Manager.\n
", + "smithy.api#documentation": "Returns an evidence folder from the specified assessment in Audit Manager.\n
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/controlSets/{controlSetId}/evidenceFolders/{evidenceFolderId}", @@ -4182,7 +4354,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4190,7 +4362,7 @@ "controlSetId": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified control set.\n
", + "smithy.api#documentation": "The identifier for the control set.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4198,7 +4370,7 @@ "evidenceFolderId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the folder in which the evidence is stored.\n
", + "smithy.api#documentation": "The identifier for the folder that the evidence is stored in.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4211,7 +4383,7 @@ "evidenceFolder": { "target": "com.amazonaws.auditmanager#AssessmentEvidenceFolder", "traits": { - "smithy.api#documentation": "\nThe folder in which evidence is stored.\n
" + "smithy.api#documentation": "The folder that the evidence is stored in.
" } } } @@ -4239,7 +4411,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns the evidence folders from a specified assessment in Audit Manager.\n
", + "smithy.api#documentation": "Returns the evidence folders from a specified assessment in Audit Manager.\n
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/evidenceFolders", @@ -4275,7 +4447,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns a list of evidence folders associated with a specified control of an assessment in Audit Manager.\n
", + "smithy.api#documentation": "Returns a list of evidence folders that are associated with a specified control of an\n assessment in Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/assessments/{assessmentId}/evidenceFolders-by-assessment-control/{controlSetId}/{controlId}", @@ -4294,7 +4466,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4302,7 +4474,7 @@ "controlSetId": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified control set.\n
", + "smithy.api#documentation": "The identifier for the control set.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4310,7 +4482,7 @@ "controlId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified control. \n
", + "smithy.api#documentation": "The identifier for the control.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4318,14 +4490,14 @@ "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results.\n
", + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.auditmanager#MaxResults", "traits": { - "smithy.api#documentation": "\n Represents the maximum number of results per page, or per API request call. \n
", + "smithy.api#documentation": "Represents the maximum number of results on a page or for an API request call.
", "smithy.api#httpQuery": "maxResults" } } @@ -4337,13 +4509,13 @@ "evidenceFolders": { "target": "com.amazonaws.auditmanager#AssessmentEvidenceFolders", "traits": { - "smithy.api#documentation": "\n The list of evidence folders returned by the GetEvidenceFoldersByAssessmentControl API.\n
The list of evidence folders that the\n GetEvidenceFoldersByAssessmentControl API returned.
\n The pagination token used to fetch the next set of results.\n
" + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" } } } @@ -4354,7 +4526,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4362,14 +4534,14 @@ "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results.\n
", + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.auditmanager#MaxResults", "traits": { - "smithy.api#documentation": "\n Represents the maximum number of results per page, or per API request call. \n
", + "smithy.api#documentation": "Represents the maximum number of results on a page or for an API request call.
", "smithy.api#httpQuery": "maxResults" } } @@ -4381,13 +4553,13 @@ "evidenceFolders": { "target": "com.amazonaws.auditmanager#AssessmentEvidenceFolders", "traits": { - "smithy.api#documentation": "\n The list of evidence folders returned by the GetEvidenceFoldersByAssessment API.\n
The list of evidence folders that the GetEvidenceFoldersByAssessment API\n returned.
\n The pagination token used to fetch the next set of results.\n
" + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" } } } @@ -4398,7 +4570,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4406,7 +4578,7 @@ "controlSetId": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified control set.\n
", + "smithy.api#documentation": "The identifier for the control set.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4414,7 +4586,7 @@ "evidenceFolderId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the folder in which the evidence is stored.\n
", + "smithy.api#documentation": "The identifier for the folder that the evidence is stored in.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4422,7 +4594,7 @@ "evidenceId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the evidence. \n
", + "smithy.api#documentation": "The identifier for the evidence.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4435,7 +4607,7 @@ "evidence": { "target": "com.amazonaws.auditmanager#Evidence", "traits": { - "smithy.api#documentation": "\n The evidence returned by the GetEvidenceResponse API.\n
The evidence that the GetEvidenceResponse API returned.
\n Returns the name of the delegated Amazon Web Services administrator account for the organization. \n
", + "smithy.api#documentation": "Returns the name of the delegated Amazon Web Services administrator account for the\n organization.
", "smithy.api#http": { "method": "GET", "uri": "/account/organizationAdminAccount", @@ -4481,13 +4653,13 @@ "adminAccountId": { "target": "com.amazonaws.auditmanager#AccountId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified administrator account. \n
" + "smithy.api#documentation": "The identifier for the administrator account.
" } }, "organizationId": { "target": "com.amazonaws.auditmanager#organizationId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified organization. \n
" + "smithy.api#documentation": "The identifier for the organization.
" } } } @@ -4512,7 +4684,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns a list of the in-scope Amazon Web Services services for the specified assessment. \n
", + "smithy.api#documentation": "Returns a list of the in-scope Amazon Web Services services for the specified\n assessment.
", "smithy.api#http": { "method": "GET", "uri": "/services", @@ -4530,7 +4702,7 @@ "serviceMetadata": { "target": "com.amazonaws.auditmanager#ServiceMetadataList", "traits": { - "smithy.api#documentation": "\n The metadata associated with the Amazon Web Service.\n
" + "smithy.api#documentation": "The metadata that's associated with the Amazon Web Service.
" } } } @@ -4552,7 +4724,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns the settings for the specified account. \n
", + "smithy.api#documentation": "Returns the settings for the specified Amazon Web Services account.
", "smithy.api#http": { "method": "GET", "uri": "/settings/{attribute}", @@ -4566,7 +4738,7 @@ "attribute": { "target": "com.amazonaws.auditmanager#SettingAttribute", "traits": { - "smithy.api#documentation": "\n The list of SettingAttribute enum values. \n
The list of SettingAttribute enum values.
\n The settings object that holds all supported Audit Manager settings. \n
" + "smithy.api#documentation": "The settings object that holds all supported Audit Manager settings.
" } } } @@ -4618,7 +4790,7 @@ } }, "traits": { - "smithy.api#documentation": "\n An internal service error occurred during the processing of your request. Try again later.\n
", + "smithy.api#documentation": "An internal service error occurred during the processing of your request. Try again\n later.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -4670,6 +4842,83 @@ "smithy.api#pattern": "^[a-zA-Z0-9\\s-_()\\[\\]]+$" } }, + "com.amazonaws.auditmanager#ListAssessmentFrameworkShareRequests": { + "type": "operation", + "input": { + "target": "com.amazonaws.auditmanager#ListAssessmentFrameworkShareRequestsRequest" + }, + "output": { + "target": "com.amazonaws.auditmanager#ListAssessmentFrameworkShareRequestsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.auditmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.auditmanager#InternalServerException" + }, + { + "target": "com.amazonaws.auditmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of sent or received share requests for custom frameworks in Audit Manager.
", + "smithy.api#http": { + "method": "GET", + "uri": "/assessmentFrameworkShareRequests", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults" + } + } + }, + "com.amazonaws.auditmanager#ListAssessmentFrameworkShareRequestsRequest": { + "type": "structure", + "members": { + "requestType": { + "target": "com.amazonaws.auditmanager#ShareRequestType", + "traits": { + "smithy.api#documentation": "Specifies whether the share request is a sent request or a received request.
", + "smithy.api#httpQuery": "requestType", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.auditmanager#Token", + "traits": { + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.auditmanager#MaxResults", + "traits": { + "smithy.api#documentation": "Represents the maximum number of results on a page or for an API request call.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.auditmanager#ListAssessmentFrameworkShareRequestsResponse": { + "type": "structure", + "members": { + "assessmentFrameworkShareRequests": { + "target": "com.amazonaws.auditmanager#AssessmentFrameworkShareRequestList", + "traits": { + "smithy.api#documentation": " The list of share requests that the ListAssessmentFrameworkShareRequests\n API returned.
The pagination token that's used to fetch the next set of results.
" + } + } + } + }, "com.amazonaws.auditmanager#ListAssessmentFrameworks": { "type": "operation", "input": { @@ -4690,7 +4939,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns a list of the frameworks available in the Audit Manager framework library.\n
", + "smithy.api#documentation": "Returns a list of the frameworks that are available in the Audit Manager\n framework library.
", "smithy.api#http": { "method": "GET", "uri": "/assessmentFrameworks", @@ -4709,7 +4958,7 @@ "frameworkType": { "target": "com.amazonaws.auditmanager#FrameworkType", "traits": { - "smithy.api#documentation": "\n The type of framework, such as standard or custom. \n
", + "smithy.api#documentation": "The type of framework, such as a standard framework or a custom framework.
", "smithy.api#httpQuery": "frameworkType", "smithy.api#required": {} } @@ -4717,14 +4966,14 @@ "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results.\n
", + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.auditmanager#MaxResults", "traits": { - "smithy.api#documentation": "\n Represents the maximum number of results per page, or per API request call. \n
", + "smithy.api#documentation": "Represents the maximum number of results on a page or for an API request call.
", "smithy.api#httpQuery": "maxResults" } } @@ -4736,13 +4985,13 @@ "frameworkMetadataList": { "target": "com.amazonaws.auditmanager#FrameworkMetadataList", "traits": { - "smithy.api#documentation": "\nThe list of metadata objects for the specified framework.\n
" + "smithy.api#documentation": "The list of metadata objects for the framework.
" } }, "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results.\n
" + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" } } } @@ -4773,7 +5022,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns a list of assessment reports created in Audit Manager.\n
", + "smithy.api#documentation": "Returns a list of assessment reports created in Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/assessmentReports", @@ -4792,14 +5041,14 @@ "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results.\n
", + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.auditmanager#MaxResults", "traits": { - "smithy.api#documentation": "\n Represents the maximum number of results per page, or per API request call. \n
", + "smithy.api#documentation": "Represents the maximum number of results on a page or for an API request call.
", "smithy.api#httpQuery": "maxResults" } } @@ -4811,13 +5060,13 @@ "assessmentReports": { "target": "com.amazonaws.auditmanager#AssessmentReportsMetadata", "traits": { - "smithy.api#documentation": "\n The list of assessment reports returned by the ListAssessmentReports API.\n
The list of assessment reports that the ListAssessmentReports API\n returned.
\n The pagination token used to fetch the next set of results.\n
" + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" } } } @@ -4842,7 +5091,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns a list of current and past assessments from Audit Manager.\n
", + "smithy.api#documentation": "Returns a list of current and past assessments from Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/assessments", @@ -4861,14 +5110,14 @@ "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results.\n
", + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.auditmanager#MaxResults", "traits": { - "smithy.api#documentation": "\n Represents the maximum number of results per page, or per API request call. \n
", + "smithy.api#documentation": "Represents the maximum number of results on a page or for an API request call.
", "smithy.api#httpQuery": "maxResults" } } @@ -4880,13 +5129,13 @@ "assessmentMetadata": { "target": "com.amazonaws.auditmanager#ListAssessmentMetadata", "traits": { - "smithy.api#documentation": "\n The metadata associated with the assessment.\n
" + "smithy.api#documentation": "The metadata that's associated with the assessment.
" } }, "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results.\n
" + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" } } } @@ -4911,7 +5160,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns a list of controls from Audit Manager.\n
", + "smithy.api#documentation": "Returns a list of controls from Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/controls", @@ -4930,7 +5179,7 @@ "controlType": { "target": "com.amazonaws.auditmanager#ControlType", "traits": { - "smithy.api#documentation": "\nThe type of control, such as standard or custom.\n
", + "smithy.api#documentation": "The type of control, such as a standard control or a custom control.
", "smithy.api#httpQuery": "controlType", "smithy.api#required": {} } @@ -4938,14 +5187,14 @@ "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results.\n
", + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.auditmanager#MaxResults", "traits": { - "smithy.api#documentation": "\n Represents the maximum number of results per page, or per API request call. \n
", + "smithy.api#documentation": "Represents the maximum number of results on a page or for an API request call.
", "smithy.api#httpQuery": "maxResults" } } @@ -4957,13 +5206,13 @@ "controlMetadataList": { "target": "com.amazonaws.auditmanager#ControlMetadataList", "traits": { - "smithy.api#documentation": "\n The list of control metadata objects returned by the ListControls API. \n
The list of control metadata objects that the ListControls API returned.\n
\n The pagination token used to fetch the next set of results.\n
" + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" } } } @@ -4988,7 +5237,7 @@ } ], "traits": { - "smithy.api#documentation": "\nReturns a list of keywords that pre-mapped to the specified control data source.\n
", + "smithy.api#documentation": "Returns a list of keywords that are pre-mapped to the specified control data source.
", "smithy.api#http": { "method": "GET", "uri": "/dataSourceKeywords", @@ -5007,7 +5256,7 @@ "source": { "target": "com.amazonaws.auditmanager#SourceType", "traits": { - "smithy.api#documentation": "\nThe control mapping data source to which the keywords apply.\n
", + "smithy.api#documentation": "The control mapping data source that the keywords apply to.
", "smithy.api#httpQuery": "source", "smithy.api#required": {} } @@ -5015,14 +5264,14 @@ "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results.\n
", + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.auditmanager#MaxResults", "traits": { - "smithy.api#documentation": "\n Represents the maximum number of results per page, or per API request call. \n
", + "smithy.api#documentation": "Represents the maximum number of results on a page or for an API request call.
", "smithy.api#httpQuery": "maxResults" } } @@ -5034,13 +5283,13 @@ "keywords": { "target": "com.amazonaws.auditmanager#Keywords", "traits": { - "smithy.api#documentation": "\n The list of keywords for the specified event mapping source.\n
" + "smithy.api#documentation": "The list of keywords for the event mapping source.
" } }, "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results.\n
" + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" } } } @@ -5065,7 +5314,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns a list of all Audit Manager notifications. \n
", + "smithy.api#documentation": "Returns a list of all Audit Manager notifications.
", "smithy.api#http": { "method": "GET", "uri": "/notifications", @@ -5084,14 +5333,14 @@ "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results. \n
", + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "com.amazonaws.auditmanager#MaxResults", "traits": { - "smithy.api#documentation": "\n Represents the maximum number of results per page, or per API request call.\n
", + "smithy.api#documentation": "Represents the maximum number of results on a page or for an API request call.
", "smithy.api#httpQuery": "maxResults" } } @@ -5103,13 +5352,13 @@ "notifications": { "target": "com.amazonaws.auditmanager#Notifications", "traits": { - "smithy.api#documentation": "\n The returned list of notifications. \n
" + "smithy.api#documentation": "The returned list of notifications.
" } }, "nextToken": { "target": "com.amazonaws.auditmanager#Token", "traits": { - "smithy.api#documentation": "\n The pagination token used to fetch the next set of results.\n
" + "smithy.api#documentation": "The pagination token that's used to fetch the next set of results.
" } } } @@ -5134,7 +5383,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns a list of tags for the specified resource in Audit Manager.\n
", + "smithy.api#documentation": "Returns a list of tags for the specified resource in Audit Manager.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", @@ -5148,7 +5397,7 @@ "resourceArn": { "target": "com.amazonaws.auditmanager#AuditManagerArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the specified resource.\n
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5161,7 +5410,7 @@ "tags": { "target": "com.amazonaws.auditmanager#TagMap", "traits": { - "smithy.api#documentation": "\n The list of tags returned by the ListTagsForResource API.\n
The list of tags that the ListTagsForResource API returned.
\n The Amazon S3 URL that points to a manual evidence object. \n
" + "smithy.api#documentation": "The Amazon S3 URL that points to a manual evidence object.
" } } }, "traits": { - "smithy.api#documentation": "\n Evidence that is uploaded to Audit Manager manually. \n
" + "smithy.api#documentation": "Evidence that's uploaded to Audit Manager manually.
" } }, "com.amazonaws.auditmanager#ManualEvidenceList": { @@ -5219,54 +5468,54 @@ "id": { "target": "com.amazonaws.auditmanager#TimestampUUID", "traits": { - "smithy.api#documentation": "\n The unique identifier for the notification. \n
" + "smithy.api#documentation": "The unique identifier for the notification.
" } }, "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
" + "smithy.api#documentation": "The identifier for the assessment.
" } }, "assessmentName": { "target": "com.amazonaws.auditmanager#AssessmentName", "traits": { - "smithy.api#documentation": "\n The name of the related assessment. \n
" + "smithy.api#documentation": "The name of the related assessment.
" } }, "controlSetId": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified control set.\n
" + "smithy.api#documentation": "The identifier for the control set.
" } }, "controlSetName": { "target": "com.amazonaws.auditmanager#NonEmptyString", "traits": { - "smithy.api#documentation": "\n Specifies the name of the control set that the notification is about.\n
" + "smithy.api#documentation": "Specifies the name of the control set that the notification is about.
" } }, "description": { "target": "com.amazonaws.auditmanager#NonEmptyString", "traits": { - "smithy.api#documentation": "\n The description of the notification. \n
" + "smithy.api#documentation": "The description of the notification.
" } }, "eventTime": { "target": "com.amazonaws.auditmanager#Timestamp", "traits": { - "smithy.api#documentation": "\n The time when the notification was sent. \n
" + "smithy.api#documentation": "The time when the notification was sent.
" } }, "source": { "target": "com.amazonaws.auditmanager#NonEmptyString", "traits": { - "smithy.api#documentation": "\n The sender of the notification. \n
" + "smithy.api#documentation": "The sender of the notification.
" } } }, "traits": { - "smithy.api#documentation": "\n The notification used to inform a user of an update in Audit Manager. For example, this includes the notification that is sent when a control set is delegated for review. \n
" + "smithy.api#documentation": "The notification that informs a user of an update in Audit Manager. For\n example, this includes the notification that's sent when a control set is delegated for\n review.
" } }, "com.amazonaws.auditmanager#Notifications": { @@ -5275,6 +5524,12 @@ "target": "com.amazonaws.auditmanager#Notification" } }, + "com.amazonaws.auditmanager#NullableInteger": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.auditmanager#ObjectTypeEnum": { "type": "string", "traits": { @@ -5302,6 +5557,12 @@ ] } }, + "com.amazonaws.auditmanager#Region": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-z]{2}-[a-z]+-[0-9]{1}$" + } + }, "com.amazonaws.auditmanager#RegisterAccount": { "type": "operation", "input": { @@ -5325,7 +5586,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Enables Audit Manager for the specified account. \n
", + "smithy.api#documentation": "Enables Audit Manager for the specified Amazon Web Services account.
", "smithy.api#http": { "method": "POST", "uri": "/account/registerAccount", @@ -5339,13 +5600,13 @@ "kmsKey": { "target": "com.amazonaws.auditmanager#KmsKey", "traits": { - "smithy.api#documentation": "\n The KMS key details. \n
" + "smithy.api#documentation": "The KMS key details.
" } }, "delegatedAdminAccount": { "target": "com.amazonaws.auditmanager#AccountId", "traits": { - "smithy.api#documentation": "\n The delegated administrator account for Audit Manager. \n
" + "smithy.api#documentation": "The delegated administrator account for Audit Manager.
" } } } @@ -5356,7 +5617,7 @@ "status": { "target": "com.amazonaws.auditmanager#AccountStatus", "traits": { - "smithy.api#documentation": "\n The status of the account registration request. \n
" + "smithy.api#documentation": "The status of the account registration request.
" } } } @@ -5384,7 +5645,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Enables an account within the organization as the delegated administrator for Audit Manager.\n
", + "smithy.api#documentation": "Enables an Amazon Web Services account within the organization as the delegated\n administrator for Audit Manager.
", "smithy.api#http": { "method": "POST", "uri": "/account/registerOrganizationAdminAccount", @@ -5398,7 +5659,7 @@ "adminAccountId": { "target": "com.amazonaws.auditmanager#AccountId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified delegated administrator account. \n
", + "smithy.api#documentation": "The identifier for the delegated administrator account.
", "smithy.api#required": {} } } @@ -5410,13 +5671,13 @@ "adminAccountId": { "target": "com.amazonaws.auditmanager#AccountId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified delegated administrator account. \n
" + "smithy.api#documentation": "The identifier for the delegated administrator account.
" } }, "organizationId": { "target": "com.amazonaws.auditmanager#organizationId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified organization. \n
" + "smithy.api#documentation": "The identifier for the organization.
" } } } @@ -5427,18 +5688,18 @@ "arn": { "target": "com.amazonaws.auditmanager#GenericArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) for the specified resource.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the resource.
" } }, "value": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "\n The value of the specified resource.\n
" + "smithy.api#documentation": "The value of the resource.
" } } }, "traits": { - "smithy.api#documentation": "\n A system asset that is evaluated in an Audit Manager assessment. \n
" + "smithy.api#documentation": "A system asset that's evaluated in an Audit Manager assessment.
" } }, "com.amazonaws.auditmanager#ResourceNotFoundException": { @@ -5453,20 +5714,20 @@ "resourceId": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "\n The unique identifier for the specified resource.\n
", + "smithy.api#documentation": "The unique identifier for the resource.
", "smithy.api#required": {} } }, "resourceType": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "\n The type of resource affected by the error.\n
", + "smithy.api#documentation": "The type of resource that's affected by the error.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "\n The resource specified in the request cannot be found.\n
", + "smithy.api#documentation": "The resource that's specified in the request can't be found.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -5483,18 +5744,18 @@ "roleType": { "target": "com.amazonaws.auditmanager#RoleType", "traits": { - "smithy.api#documentation": "\n The type of customer persona.\n
\nIn CreateAssessment, roleType can only be PROCESS_OWNER.
In UpdateSettings, roleType can only be PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be RESOURCE_OWNER.
The type of customer persona.
\nIn CreateAssessment, roleType can only be\n PROCESS_OWNER.
In UpdateSettings, roleType can only be\n PROCESS_OWNER.
In BatchCreateDelegationByAssessment, roleType can only be\n RESOURCE_OWNER.
\n The Amazon Resource Name (ARN) of the IAM role. \n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role.
" } } }, "traits": { - "smithy.api#documentation": "\n The wrapper that contains the Audit Manager role information of the current user, such as the role type and IAM Amazon Resource Name (ARN).\n
" + "smithy.api#documentation": "The wrapper that contains the Audit Manager role information of the current\n user. This includes the role type and IAM Amazon Resource Name (ARN).\n
" } }, "com.amazonaws.auditmanager#RoleType": { @@ -5544,18 +5805,18 @@ "awsAccounts": { "target": "com.amazonaws.auditmanager#AWSAccounts", "traits": { - "smithy.api#documentation": "\n The accounts included in the scope of the assessment. \n
" + "smithy.api#documentation": "The Amazon Web Services accounts that are included in the scope of the assessment.\n
" } }, "awsServices": { "target": "com.amazonaws.auditmanager#AWSServices", "traits": { - "smithy.api#documentation": "\n The Amazon Web Services services included in the scope of the assessment. \n
" + "smithy.api#documentation": "The Amazon Web Services services that are included in the scope of the assessment.\n
" } } }, "traits": { - "smithy.api#documentation": "\n The wrapper that contains the accounts and services in scope for the assessment.\n
" + "smithy.api#documentation": "The wrapper that contains the Amazon Web Services accounts and services that are in\n scope for the assessment.
" } }, "com.amazonaws.auditmanager#ServiceMetadata": { @@ -5564,30 +5825,30 @@ "name": { "target": "com.amazonaws.auditmanager#AWSServiceName", "traits": { - "smithy.api#documentation": "\n The name of the Amazon Web Service.\n
" + "smithy.api#documentation": "The name of the Amazon Web Service.
" } }, "displayName": { "target": "com.amazonaws.auditmanager#NonEmptyString", "traits": { - "smithy.api#documentation": "\n The display name of the Amazon Web Service.\n
" + "smithy.api#documentation": "The display name of the Amazon Web Service.
" } }, "description": { "target": "com.amazonaws.auditmanager#NonEmptyString", "traits": { - "smithy.api#documentation": "\n The description of the specified Amazon Web Service.\n
" + "smithy.api#documentation": "The description of the Amazon Web Service.
" } }, "category": { "target": "com.amazonaws.auditmanager#NonEmptyString", "traits": { - "smithy.api#documentation": "\n The category in which the Amazon Web Service belongs, such as compute, storage, database, and so on.\n
" + "smithy.api#documentation": "The category that the Amazon Web Service belongs to, such as compute, storage,\n or database.
" } } }, "traits": { - "smithy.api#documentation": "\n The metadata associated with the specified Amazon Web Service.\n
" + "smithy.api#documentation": "The metadata that's associated with the Amazon Web Service.
" } }, "com.amazonaws.auditmanager#ServiceMetadataList": { @@ -5629,36 +5890,119 @@ "isAwsOrgEnabled": { "target": "com.amazonaws.auditmanager#Boolean", "traits": { - "smithy.api#documentation": "\n Specifies whether Organizations is enabled. \n
" + "smithy.api#documentation": "Specifies whether Organizations is enabled.
" } }, "snsTopic": { "target": "com.amazonaws.auditmanager#SNSTopic", "traits": { - "smithy.api#documentation": "\n The designated Amazon Simple Notification Service (Amazon SNS) topic. \n
" + "smithy.api#documentation": "The designated Amazon Simple Notification Service (Amazon SNS) topic.
" } }, "defaultAssessmentReportsDestination": { "target": "com.amazonaws.auditmanager#AssessmentReportsDestination", "traits": { - "smithy.api#documentation": "\n The default storage destination for assessment reports.\n
" + "smithy.api#documentation": "The default storage destination for assessment reports.
" } }, "defaultProcessOwners": { "target": "com.amazonaws.auditmanager#Roles", "traits": { - "smithy.api#documentation": "\n The designated default audit owners. \n
" + "smithy.api#documentation": "The designated default audit owners.
" } }, "kmsKey": { "target": "com.amazonaws.auditmanager#KmsKey", "traits": { - "smithy.api#documentation": "\n The KMS key details. \n
" + "smithy.api#documentation": "The KMS key details.
" } } }, "traits": { - "smithy.api#documentation": "\n The settings object that holds all supported Audit Manager settings. \n
" + "smithy.api#documentation": "The settings object that holds all supported Audit Manager settings.
" + } + }, + "com.amazonaws.auditmanager#ShareRequestAction": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACCEPT", + "name": "ACCEPT" + }, + { + "value": "DECLINE", + "name": "DECLINE" + }, + { + "value": "REVOKE", + "name": "REVOKE" + } + ] + } + }, + "com.amazonaws.auditmanager#ShareRequestComment": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^[\\w\\W\\s\\S]*$" + } + }, + "com.amazonaws.auditmanager#ShareRequestStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "REPLICATING", + "name": "REPLICATING" + }, + { + "value": "SHARED", + "name": "SHARED" + }, + { + "value": "EXPIRING", + "name": "EXPIRING" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "EXPIRED", + "name": "EXPIRED" + }, + { + "value": "DECLINED", + "name": "DECLINED" + }, + { + "value": "REVOKED", + "name": "REVOKED" + } + ] + } + }, + "com.amazonaws.auditmanager#ShareRequestType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SENT", + "name": "SENT" + }, + { + "value": "RECEIVED", + "name": "RECEIVED" + } + ] } }, "com.amazonaws.auditmanager#SnsArn": { @@ -5706,18 +6050,18 @@ "keywordInputType": { "target": "com.amazonaws.auditmanager#KeywordInputType", "traits": { - "smithy.api#documentation": "\nThe method of input for the specified keyword.\n
" + "smithy.api#documentation": "The method of input for the keyword.
" } }, "keywordValue": { "target": "com.amazonaws.auditmanager#KeywordValue", "traits": { - "smithy.api#documentation": "\n The value of the keyword used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names when mapping a control data source. \n
" + "smithy.api#documentation": "The value of the keyword that's used to search CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names\n when mapping a control data source.
" } } }, "traits": { - "smithy.api#documentation": "\n The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names.\n
" + "smithy.api#documentation": "The keyword to search for in CloudTrail logs, Config rules,\n Security Hub checks, and Amazon Web Services API names.
" } }, "com.amazonaws.auditmanager#SourceName": { @@ -5771,6 +6115,81 @@ ] } }, + "com.amazonaws.auditmanager#StartAssessmentFrameworkShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.auditmanager#StartAssessmentFrameworkShareRequest" + }, + "output": { + "target": "com.amazonaws.auditmanager#StartAssessmentFrameworkShareResponse" + }, + "errors": [ + { + "target": "com.amazonaws.auditmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.auditmanager#InternalServerException" + }, + { + "target": "com.amazonaws.auditmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.auditmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a share request for a custom framework in Audit Manager.
\nThe share request specifies a recipient and notifies them that a custom framework is available. Recipients have 120 days to accept or decline the request. If no action is taken, the share request expires.
\nWhen you invoke the StartAssessmentFrameworkShare API, you are about to\n share a custom framework with another Amazon Web Services account. You may not share a\n custom framework that is derived from a standard framework if the standard framework is\n designated as not eligible for sharing by Amazon Web Services, unless you have obtained\n permission to do so from the owner of the standard framework. To learn more about which\n standard frameworks are eligible for sharing, see Framework sharing eligibility in the Audit Manager User\n Guide.
The unique identifier for the custom framework to be shared.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "destinationAccount": { + "target": "com.amazonaws.auditmanager#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account of the recipient.
", + "smithy.api#required": {} + } + }, + "destinationRegion": { + "target": "com.amazonaws.auditmanager#Region", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region of the recipient.
", + "smithy.api#required": {} + } + }, + "comment": { + "target": "com.amazonaws.auditmanager#ShareRequestComment", + "traits": { + "smithy.api#documentation": "An optional comment from the sender about the share request.
" + } + } + } + }, + "com.amazonaws.auditmanager#StartAssessmentFrameworkShareResponse": { + "type": "structure", + "members": { + "assessmentFrameworkShareRequest": { + "target": "com.amazonaws.auditmanager#AssessmentFrameworkShareRequest", + "traits": { + "smithy.api#documentation": " The share request that's created by the StartAssessmentFrameworkShare API.\n
\n Tags the specified resource in Audit Manager.\n
", + "smithy.api#documentation": "Tags the specified resource in Audit Manager.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -5852,7 +6271,7 @@ "resourceArn": { "target": "com.amazonaws.auditmanager#AuditManagerArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the specified resource.\n
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5860,7 +6279,7 @@ "tags": { "target": "com.amazonaws.auditmanager#TagMap", "traits": { - "smithy.api#documentation": "\nThe tags to be associated with the resource.\n
", + "smithy.api#documentation": "The tags that are associated with the resource.
", "smithy.api#required": {} } } @@ -5929,18 +6348,18 @@ "hyperlinkName": { "target": "com.amazonaws.auditmanager#HyperlinkName", "traits": { - "smithy.api#documentation": "\n The name or word used as a hyperlink to the URL. \n
" + "smithy.api#documentation": "The name or word that's used as a hyperlink to the URL.
" } }, "link": { "target": "com.amazonaws.auditmanager#UrlLink", "traits": { - "smithy.api#documentation": "\n The unique identifier for the internet resource. \n
" + "smithy.api#documentation": "The unique identifier for the internet resource.
" } } }, "traits": { - "smithy.api#documentation": "\n A uniform resource locator, used as a unique identifier to locate a resource on the internet. \n
" + "smithy.api#documentation": "Short for uniform resource locator. A URL is used as a unique identifier to locate a\n resource on the internet.
" } }, "com.amazonaws.auditmanager#UUID": { @@ -5973,7 +6392,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Removes a tag from a resource in Audit Manager.\n
", + "smithy.api#documentation": "Removes a tag from a resource in Audit Manager.
", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", @@ -5987,7 +6406,7 @@ "resourceArn": { "target": "com.amazonaws.auditmanager#AuditManagerArn", "traits": { - "smithy.api#documentation": "\n The Amazon Resource Name (ARN) of the specified resource.\n
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the specified resource.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5995,7 +6414,7 @@ "tagKeys": { "target": "com.amazonaws.auditmanager#TagKeyList", "traits": { - "smithy.api#documentation": "\n The name or key of the tag. \n
", + "smithy.api#documentation": "The name or key of the tag.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } @@ -6029,7 +6448,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Edits an Audit Manager assessment. \n
", + "smithy.api#documentation": "Edits an Audit Manager assessment.
", "smithy.api#http": { "method": "PUT", "uri": "/assessments/{assessmentId}", @@ -6060,7 +6479,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Updates a control within an assessment in Audit Manager.\n
", + "smithy.api#documentation": "Updates a control within an assessment in Audit Manager.
", "smithy.api#http": { "method": "PUT", "uri": "/assessments/{assessmentId}/controlSets/{controlSetId}/controls/{controlId}", @@ -6074,7 +6493,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6082,7 +6501,7 @@ "controlSetId": { "target": "com.amazonaws.auditmanager#ControlSetId", "traits": { - "smithy.api#documentation": "\n The identifier for the specified control set.\n
", + "smithy.api#documentation": "The identifier for the control set.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6090,7 +6509,7 @@ "controlId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n \n The identifier for the specified control. \n
", + "smithy.api#documentation": "The identifier for the control.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6098,13 +6517,13 @@ "controlStatus": { "target": "com.amazonaws.auditmanager#ControlStatus", "traits": { - "smithy.api#documentation": "\n The status of the specified control. \n
" + "smithy.api#documentation": "The status of the control.
" } }, "commentBody": { "target": "com.amazonaws.auditmanager#ControlCommentBody", "traits": { - "smithy.api#documentation": "\n The comment body text for the specified control. \n
" + "smithy.api#documentation": "The comment body text for the control.
" } } } @@ -6115,7 +6534,7 @@ "control": { "target": "com.amazonaws.auditmanager#AssessmentControl", "traits": { - "smithy.api#documentation": "\n The name of the updated control set returned by the UpdateAssessmentControl API. \n
The name of the updated control set that the UpdateAssessmentControl API\n returned.
\n Updates the status of a control set in an Audit Manager assessment.\n
", + "smithy.api#documentation": "Updates the status of a control set in an Audit Manager assessment.
", "smithy.api#http": { "method": "PUT", "uri": "/assessments/{assessmentId}/controlSets/{controlSetId}/status", @@ -6157,7 +6576,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6165,7 +6584,7 @@ "controlSetId": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "\n The identifier for the specified control set.\n
", + "smithy.api#documentation": "The identifier for the control set.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6173,14 +6592,14 @@ "status": { "target": "com.amazonaws.auditmanager#ControlSetStatus", "traits": { - "smithy.api#documentation": "\nThe status of the control set that is being updated.\n
", + "smithy.api#documentation": "The status of the control set that's being updated.
", "smithy.api#required": {} } }, "comment": { "target": "com.amazonaws.auditmanager#DelegationComment", "traits": { - "smithy.api#documentation": "\n The comment related to the status update.\n
", + "smithy.api#documentation": "The comment that's related to the status update.
", "smithy.api#required": {} } } @@ -6192,7 +6611,7 @@ "controlSet": { "target": "com.amazonaws.auditmanager#AssessmentControlSet", "traits": { - "smithy.api#documentation": "\n The name of the updated control set returned by the UpdateAssessmentControlSetStatus API. \n
The name of the updated control set that the\n UpdateAssessmentControlSetStatus API returned.
\n Updates a custom framework in Audit Manager.\n
", + "smithy.api#documentation": "Updates a custom framework in Audit Manager.
", "smithy.api#http": { "method": "PUT", "uri": "/assessmentFrameworks/{frameworkId}", @@ -6234,25 +6653,25 @@ "id": { "target": "com.amazonaws.auditmanager#ControlSetName", "traits": { - "smithy.api#documentation": "\nThe unique identifier for the control set.\n
" + "smithy.api#documentation": "The unique identifier for the control set.
" } }, "name": { "target": "com.amazonaws.auditmanager#ControlSetName", "traits": { - "smithy.api#documentation": "\nThe name of the control set.\n
", + "smithy.api#documentation": "The name of the control set.
", "smithy.api#required": {} } }, "controls": { "target": "com.amazonaws.auditmanager#CreateAssessmentFrameworkControls", "traits": { - "smithy.api#documentation": "\nThe list of controls contained within the control set.\n
" + "smithy.api#documentation": "The list of controls that are contained within the control set.
" } } }, "traits": { - "smithy.api#documentation": "\n A controlSet entity that represents a collection of controls in Audit Manager. This does not contain the control set ID.\n
A controlSet entity that represents a collection of controls in Audit Manager. This doesn't contain the control set ID.
\n The identifier for the specified framework. \n
", + "smithy.api#documentation": "The identifier for the framework.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6275,26 +6694,26 @@ "name": { "target": "com.amazonaws.auditmanager#FrameworkName", "traits": { - "smithy.api#documentation": "\nThe name of the framework to be updated.\n
", + "smithy.api#documentation": "The name of the framework to be updated.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.auditmanager#FrameworkDescription", "traits": { - "smithy.api#documentation": "\nThe description of the framework that is to be updated.\n
" + "smithy.api#documentation": "The description of the updated framework.
" } }, "complianceType": { "target": "com.amazonaws.auditmanager#ComplianceType", "traits": { - "smithy.api#documentation": "\n The compliance type that the new custom framework supports, such as CIS or HIPAA.\n
" + "smithy.api#documentation": "The compliance type that the new custom framework supports, such as CIS or HIPAA.\n
" } }, "controlSets": { "target": "com.amazonaws.auditmanager#UpdateAssessmentFrameworkControlSets", "traits": { - "smithy.api#documentation": "\n The control sets associated with the framework. \n
", + "smithy.api#documentation": "The control sets that are associated with the framework.
", "smithy.api#required": {} } } @@ -6306,7 +6725,76 @@ "framework": { "target": "com.amazonaws.auditmanager#Framework", "traits": { - "smithy.api#documentation": "\nThe name of the specified framework.\n
" + "smithy.api#documentation": "The name of the framework.
" + } + } + } + }, + "com.amazonaws.auditmanager#UpdateAssessmentFrameworkShare": { + "type": "operation", + "input": { + "target": "com.amazonaws.auditmanager#UpdateAssessmentFrameworkShareRequest" + }, + "output": { + "target": "com.amazonaws.auditmanager#UpdateAssessmentFrameworkShareResponse" + }, + "errors": [ + { + "target": "com.amazonaws.auditmanager#AccessDeniedException" + }, + { + "target": "com.amazonaws.auditmanager#InternalServerException" + }, + { + "target": "com.amazonaws.auditmanager#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.auditmanager#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a share request for a custom framework in Audit Manager.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/assessmentFrameworkShareRequests/{requestId}", + "code": 200 + } + } + }, + "com.amazonaws.auditmanager#UpdateAssessmentFrameworkShareRequest": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.auditmanager#UUID", + "traits": { + "smithy.api#documentation": "The unique identifier for the share request.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "requestType": { + "target": "com.amazonaws.auditmanager#ShareRequestType", + "traits": { + "smithy.api#documentation": "Specifies whether the share request is a sent request or a received request.
", + "smithy.api#required": {} + } + }, + "action": { + "target": "com.amazonaws.auditmanager#ShareRequestAction", + "traits": { + "smithy.api#documentation": "Specifies the update action for the share request.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.auditmanager#UpdateAssessmentFrameworkShareResponse": { + "type": "structure", + "members": { + "assessmentFrameworkShareRequest": { + "target": "com.amazonaws.auditmanager#AssessmentFrameworkShareRequest", + "traits": { + "smithy.api#documentation": " The updated share request that's returned by the\n UpdateAssessmentFrameworkShare operation.
\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6325,32 +6813,32 @@ "assessmentName": { "target": "com.amazonaws.auditmanager#AssessmentName", "traits": { - "smithy.api#documentation": "\n The name of the specified assessment to be updated. \n
" + "smithy.api#documentation": "The name of the assessment to be updated.
" } }, "assessmentDescription": { "target": "com.amazonaws.auditmanager#AssessmentDescription", "traits": { - "smithy.api#documentation": "\n The description of the specified assessment. \n
" + "smithy.api#documentation": "The description of the assessment.
" } }, "scope": { "target": "com.amazonaws.auditmanager#Scope", "traits": { - "smithy.api#documentation": "\n The scope of the specified assessment. \n
", + "smithy.api#documentation": "The scope of the assessment.
", "smithy.api#required": {} } }, "assessmentReportsDestination": { "target": "com.amazonaws.auditmanager#AssessmentReportsDestination", "traits": { - "smithy.api#documentation": "\n The assessment report storage destination for the specified assessment that is being updated. \n
" + "smithy.api#documentation": "The assessment report storage destination for the assessment that's being updated.\n
" } }, "roles": { "target": "com.amazonaws.auditmanager#Roles", "traits": { - "smithy.api#documentation": "\n The list of roles for the specified assessment. \n
" + "smithy.api#documentation": "The list of roles for the assessment.
" } } } @@ -6361,7 +6849,7 @@ "assessment": { "target": "com.amazonaws.auditmanager#Assessment", "traits": { - "smithy.api#documentation": "\n The response object (name of the updated assessment) for the UpdateAssessmentRequest API. \n
The response object for the UpdateAssessmentRequest API. This is the name\n of the updated assessment.
\n Updates the status of an assessment in Audit Manager. \n
", + "smithy.api#documentation": "Updates the status of an assessment in Audit Manager.
", "smithy.api#http": { "method": "PUT", "uri": "/assessments/{assessmentId}/status", @@ -6403,7 +6891,7 @@ "assessmentId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified assessment. \n
", + "smithy.api#documentation": "The identifier for the assessment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6411,7 +6899,7 @@ "status": { "target": "com.amazonaws.auditmanager#AssessmentStatus", "traits": { - "smithy.api#documentation": "\n The current status of the specified assessment. \n
", + "smithy.api#documentation": "The current status of the assessment.
", "smithy.api#required": {} } } @@ -6423,7 +6911,7 @@ "assessment": { "target": "com.amazonaws.auditmanager#Assessment", "traits": { - "smithy.api#documentation": "\n The name of the updated assessment returned by the UpdateAssessmentStatus API. \n
The name of the updated assessment that the UpdateAssessmentStatus API\n returned.
\n Updates a custom control in Audit Manager.\n
", + "smithy.api#documentation": "Updates a custom control in Audit Manager.
", "smithy.api#http": { "method": "PUT", "uri": "/controls/{controlId}", @@ -6465,7 +6953,7 @@ "controlId": { "target": "com.amazonaws.auditmanager#UUID", "traits": { - "smithy.api#documentation": "\n The identifier for the specified control. \n
", + "smithy.api#documentation": "The identifier for the control.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6473,38 +6961,38 @@ "name": { "target": "com.amazonaws.auditmanager#ControlName", "traits": { - "smithy.api#documentation": "\nThe name of the control to be updated.\n
", + "smithy.api#documentation": "The name of the updated control.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.auditmanager#ControlDescription", "traits": { - "smithy.api#documentation": "\nThe optional description of the control.\n
" + "smithy.api#documentation": "The optional description of the control.
" } }, "testingInformation": { "target": "com.amazonaws.auditmanager#TestingInformation", "traits": { - "smithy.api#documentation": "\n The steps that to follow to determine if the control has been satisfied.\n
" + "smithy.api#documentation": "The steps that you should follow to determine if the control is met.
" } }, "actionPlanTitle": { "target": "com.amazonaws.auditmanager#ActionPlanTitle", "traits": { - "smithy.api#documentation": "\n The title of the action plan for remediating the control.\n
" + "smithy.api#documentation": "The title of the action plan for remediating the control.
" } }, "actionPlanInstructions": { "target": "com.amazonaws.auditmanager#ActionPlanInstructions", "traits": { - "smithy.api#documentation": "\n \n The recommended actions to carry out if the control is not fulfilled.\n
" + "smithy.api#documentation": "The recommended actions to carry out if the control isn't fulfilled.
" } }, "controlMappingSources": { "target": "com.amazonaws.auditmanager#ControlMappingSources", "traits": { - "smithy.api#documentation": "\n The data mapping sources for the specified control.\n
", + "smithy.api#documentation": "The data mapping sources for the control.
", "smithy.api#required": {} } } @@ -6516,7 +7004,7 @@ "control": { "target": "com.amazonaws.auditmanager#Control", "traits": { - "smithy.api#documentation": "\n The name of the updated control set returned by the UpdateControl API. \n
The name of the updated control set that the UpdateControl API returned.\n
\n Updates Audit Manager settings for the current user account. \n
", + "smithy.api#documentation": "Updates Audit Manager settings for the current user account.
", "smithy.api#http": { "method": "PUT", "uri": "/settings", @@ -6555,25 +7043,25 @@ "snsTopic": { "target": "com.amazonaws.auditmanager#SnsArn", "traits": { - "smithy.api#documentation": "\n The Amazon Simple Notification Service (Amazon SNS) topic to which Audit Manager sends notifications.\n
" + "smithy.api#documentation": "The Amazon Simple Notification Service (Amazon SNS) topic that Audit Manager sends\n notifications to.
" } }, "defaultAssessmentReportsDestination": { "target": "com.amazonaws.auditmanager#AssessmentReportsDestination", "traits": { - "smithy.api#documentation": "\n The default storage destination for assessment reports.\n
" + "smithy.api#documentation": "The default storage destination for assessment reports.
" } }, "defaultProcessOwners": { "target": "com.amazonaws.auditmanager#Roles", "traits": { - "smithy.api#documentation": "\nA list of the default audit owners.\n
" + "smithy.api#documentation": "A list of the default audit owners.
" } }, "kmsKey": { "target": "com.amazonaws.auditmanager#KmsKey", "traits": { - "smithy.api#documentation": "\n The KMS key details. \n
" + "smithy.api#documentation": "The KMS key details.
" } } } @@ -6584,7 +7072,7 @@ "settings": { "target": "com.amazonaws.auditmanager#Settings", "traits": { - "smithy.api#documentation": "\nThe current list of settings.\n
" + "smithy.api#documentation": "The current list of settings.
" } } } @@ -6632,7 +7120,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Validates the integrity of an assessment report in Audit Manager. \n
", + "smithy.api#documentation": "Validates the integrity of an assessment report in Audit Manager.
", "smithy.api#http": { "method": "POST", "uri": "/assessmentReports/integrity", @@ -6646,7 +7134,7 @@ "s3RelativePath": { "target": "com.amazonaws.auditmanager#S3Url", "traits": { - "smithy.api#documentation": "\n The relative path of the specified Amazon S3 bucket in which the assessment report is stored.\n
", + "smithy.api#documentation": "The relative path of the Amazon S3 bucket that the assessment report is stored\n in.
", "smithy.api#required": {} } } @@ -6658,31 +7146,31 @@ "signatureValid": { "target": "com.amazonaws.auditmanager#Boolean", "traits": { - "smithy.api#documentation": "\nSpecifies whether the signature key is valid.\n
" + "smithy.api#documentation": "Specifies whether the signature key is valid.
" } }, "signatureAlgorithm": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "\n The signature algorithm used to code sign the assessment report file.\n
" + "smithy.api#documentation": "The signature algorithm that's used to code sign the assessment report file.
" } }, "signatureDateTime": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "\nThe date and time signature that specifies when the assessment report was created.\n
" + "smithy.api#documentation": "The date and time signature that specifies when the assessment report was created.\n
" } }, "signatureKeyId": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "\nThe unique identifier for the validation signature key.\n
" + "smithy.api#documentation": "The unique identifier for the validation signature key.
" } }, "validationErrors": { "target": "com.amazonaws.auditmanager#ValidationErrors", "traits": { - "smithy.api#documentation": "\nRepresents any errors that occurred when validating the assessment report.\n
" + "smithy.api#documentation": "Represents any errors that occurred when validating the assessment report.
" } } } @@ -6705,18 +7193,18 @@ "reason": { "target": "com.amazonaws.auditmanager#ValidationExceptionReason", "traits": { - "smithy.api#documentation": "\n The reason the request failed validation.\n
" + "smithy.api#documentation": "The reason the request failed validation.
" } }, "fields": { "target": "com.amazonaws.auditmanager#ValidationExceptionFieldList", "traits": { - "smithy.api#documentation": "\n The fields that caused the error, if applicable.\n
" + "smithy.api#documentation": "The fields that caused the error, if applicable.
" } } }, "traits": { - "smithy.api#documentation": "\n The request has invalid or missing parameters. \n
", + "smithy.api#documentation": "The request has invalid or missing parameters.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -6727,20 +7215,20 @@ "name": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "\n The name of the validation error. \n
", + "smithy.api#documentation": "The name of the validation error.
", "smithy.api#required": {} } }, "message": { "target": "com.amazonaws.auditmanager#String", "traits": { - "smithy.api#documentation": "\n The body of the error message. \n
", + "smithy.api#documentation": "The body of the error message.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "\n Indicates that the request has invalid or missing parameters for the specified field. \n
" + "smithy.api#documentation": "Indicates that the request has invalid or missing parameters for the field.
" } }, "com.amazonaws.auditmanager#ValidationExceptionFieldList": { diff --git a/codegen/sdk/aws-models/autoscaling.2011-01-01.json b/codegen/sdk/aws-models/autoscaling.2011-01-01.json index 5b357418236..1c373a9a8c8 100644 --- a/codegen/sdk/aws-models/autoscaling.2011-01-01.json +++ b/codegen/sdk/aws-models/autoscaling.2011-01-01.json @@ -621,6 +621,12 @@ "traits": { "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.
One or more filters to limit the results based on specific tags.\n
" + } } } }, @@ -966,7 +972,7 @@ "name": "autoscaling" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances\n based on user-defined scaling policies, scheduled actions, and health checks.
\nFor more information about Amazon EC2 Auto Scaling, see the Amazon EC2 Auto Scaling User Guide. For information about granting IAM users required\n permissions for calls to Amazon EC2 Auto Scaling, see Granting\n IAM users required permissions for Amazon EC2 Auto Scaling resources in the\n Amazon EC2 Auto Scaling API Reference.
", + "smithy.api#documentation": "Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances\n based on user-defined scaling policies, scheduled actions, and health checks.
\nFor more information about Amazon EC2 Auto Scaling, see the Amazon EC2 Auto Scaling User Guide. For information about granting IAM users required\n permissions for calls to Amazon EC2 Auto Scaling, see Granting\n IAM users required permissions for Amazon EC2 Auto Scaling resources in the\n Amazon EC2 Auto Scaling API Reference.
", "smithy.api#title": "Auto Scaling", "smithy.api#xmlNamespace": { "uri": "http://autoscaling.amazonaws.com/doc/2011-01-01/" @@ -1625,7 +1631,7 @@ "EbsOptimized": { "target": "com.amazonaws.autoscaling#EbsOptimized", "traits": { - "smithy.api#documentation": "Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false). The optimization provides dedicated\n throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O\n performance. This optimization is not available with all instance types. Additional fees\n are incurred when you enable EBS optimization for an instance type that is not\n EBS-optimized by default. For more information, see Amazon EBS-Optimized\n Instances in the Amazon EC2 User Guide for Linux Instances.
The default value is false.
Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false). The optimization provides dedicated\n throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O\n performance. This optimization is not available with all instance types. Additional fees\n are incurred when you enable EBS optimization for an instance type that is not\n EBS-optimized by default. For more information, see Amazon EBS-optimized instances in\n the Amazon EC2 User Guide for Linux Instances.
The default value is false.
Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
\nWhen you establish an account, the account has initial quotas on the maximum\n number of Auto Scaling groups and launch configurations that you can create in a given Region.\n For more information, see Amazon EC2 Auto Scaling service\n quotas in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
\nWhen you establish an Amazon Web Services account, the account has initial quotas on the maximum\n number of Auto Scaling groups and launch configurations that you can create in a given Region.\n For more information, see Amazon EC2 Auto Scaling service\n quotas in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer": { @@ -2082,7 +2088,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about the Auto Scaling groups in the account and Region.
\nThis operation returns information about instances in Auto Scaling groups. To retrieve\n information about the instances in a warm pool, you must call the DescribeWarmPool API.
", + "smithy.api#documentation": "Gets information about the Auto Scaling groups in the account and Region.
\nIf you specify Auto Scaling group names, the output includes information for only the\n specified Auto Scaling groups. If you specify filters, the output includes information for only\n those Auto Scaling groups that meet the filter criteria. If you do not specify group names or\n filters, the output includes information for all Auto Scaling groups.
\nThis operation also returns information about instances in Auto Scaling groups. To retrieve\n information about the instances in a warm pool, you must call the DescribeWarmPool API.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2415,6 +2421,9 @@ "target": "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsResponse" }, "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } @@ -2473,6 +2482,9 @@ "target": "com.amazonaws.autoscaling#DescribeLoadBalancersResponse" }, "errors": [ + { + "target": "com.amazonaws.autoscaling#InvalidNextToken" + }, { "target": "com.amazonaws.autoscaling#ResourceContentionFault" } @@ -3173,7 +3185,7 @@ "VolumeType": { "target": "com.amazonaws.autoscaling#BlockDeviceEbsVolumeType", "traits": { - "smithy.api#documentation": "The volume type. For more information, see Amazon EBS Volume Types in\n the Amazon EC2 User Guide for Linux Instances.
\nValid Values: standard | io1 | gp2 |\n st1 | sc1 | gp3\n
The volume type. For more information, see Amazon EBS volume types in the\n Amazon EC2 User Guide for Linux Instances.
\nValid Values: standard | io1 | gp2 |\n st1 | sc1 | gp3\n
Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see\n Supported Instance Types. If your AMI uses encrypted volumes, you can also\n only launch it on supported instance types.
\nIf you are creating a volume from a snapshot, you cannot specify an encryption\n value. Volumes that are created from encrypted snapshots are automatically\n encrypted, and volumes that are created from unencrypted snapshots are automatically\n unencrypted. By default, encrypted snapshots use the Amazon Web Services managed CMK that is used\n for EBS encryption, but you can specify a custom CMK when you create the snapshot.\n The ability to encrypt a snapshot during copying also allows you to apply a new CMK\n to an already-encrypted snapshot. Volumes restored from the\n resulting copy are only accessible using the new CMK.
\nEnabling encryption by default results in all EBS volumes being encrypted with\n the Amazon Web Services managed CMK or a customer managed CMK, whether or not the snapshot was\n encrypted.
\nFor more information, see Using Encryption with EBS-Backed\n AMIs in the Amazon EC2 User Guide for Linux Instances and Required\n CMK key policy for use with encrypted volumes in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also\n only launch it on supported instance types.
\nIf you are creating a volume from a snapshot, you cannot create an unencrypted\n volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using\n a launch configuration.
\nIf you enable encryption by default, the EBS volumes that you create are always\n encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key,\n regardless of whether the snapshot was encrypted.
\nFor more information, see Using Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the\n Amazon EC2 Auto Scaling User Guide.
\nThe name of the filter. The valid values are: auto-scaling-group,\n key, value, and propagate-at-launch.
The name of the filter.
\nThe valid values for Name depend on the API operation that you are\n including the filter in, DescribeAutoScalingGroups or DescribeTags.
\n DescribeAutoScalingGroups\n
\nValid values for Name include the following:
\n tag-key - Accepts tag keys. The results will only include\n information about the Auto Scaling groups associated with these tag keys.
\n tag-value - Accepts tag values. The results will only include\n information about the Auto Scaling groups associated with these tag values.
\n tag: - Accepts the key/value combination of the tag.\n Use the tag key in the filter name and the tag value as the filter value. The\n results will only include information about the Auto Scaling groups associated with the\n specified key/value combination.
\n DescribeTags\n
\nValid values for Name include the following:
\n auto-scaling-group - Accepts the names of Auto Scaling groups. The\n results will only include information about the tags associated with these Auto Scaling\n groups.
\n key - Accepts tag keys. The results will only include information\n about the tags associated with these tag keys.
\n value - Accepts tag values. The results will only include\n information about the tags associated with these tag values.
\n propagate-at-launch - Accepts a boolean value, which specifies\n whether tags propagate to instances at launch. The results will only include\n information about the tags associated with the specified boolean value.
One or more filter values. Filter values are case-sensitive.
" + "smithy.api#documentation": "One or more filter values. Filter values are case-sensitive.
\nIf you specify multiple values for a filter, the values are joined with an\n OR, and the request returns all results that match any of the specified\n values. For example, specify \"tag:environment\" for the filter name and\n \"production,development\" for the filter values to find Auto Scaling groups with the tag\n \"environment=production\" or \"environment=development\".
Describes a filter that is used to return a more specific list of results when\n describing tags.
\nFor more information, see Tagging Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes a filter that is used to return a more specific list of results from a\n describe operation.
\nIf you specify multiple filters, the filters are joined with an AND, and\n the request returns only results that match all of the specified filters.
For more information, see Tagging Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#Filters": { diff --git a/codegen/sdk/aws-models/chime.2018-05-01.json b/codegen/sdk/aws-models/chime.2018-05-01.json index b6a6972ddbf..ccb6f4953fe 100644 --- a/codegen/sdk/aws-models/chime.2018-05-01.json +++ b/codegen/sdk/aws-models/chime.2018-05-01.json @@ -19698,6 +19698,12 @@ "traits": { "smithy.api#documentation": "The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
" } + }, + "VoiceConnectorArn": { + "target": "com.amazonaws.chime#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ARN of the specified Amazon Chime Voice Connector.
" + } } }, "traits": { @@ -19751,6 +19757,12 @@ "traits": { "smithy.api#documentation": "The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
" } + }, + "VoiceConnectorGroupArn": { + "target": "com.amazonaws.chime#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ARN of the specified Amazon Chime Voice Connector group.
" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/chimesdkidentity.2021-04-20.json b/codegen/sdk/aws-models/chimesdkidentity.2021-04-20.json index 7dd7224e1f9..be921a78b93 100644 --- a/codegen/sdk/aws-models/chimesdkidentity.2021-04-20.json +++ b/codegen/sdk/aws-models/chimesdkidentity.2021-04-20.json @@ -29,6 +29,21 @@ ] }, "shapes": { + "com.amazonaws.chimesdkidentity#AllowMessages": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ALL", + "name": "ALL" + }, + { + "value": "NONE", + "name": "NONE" + } + ] + } + }, "com.amazonaws.chimesdkidentity#AppInstance": { "type": "structure", "members": { @@ -197,6 +212,143 @@ "smithy.api#documentation": "The details of an AppInstanceUser.
The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
The name of the AppInstanceUserEndpoint.
The type of the AppInstanceUserEndpoint.
The ARN of the resource to which the endpoint belongs.
" + } + }, + "EndpointAttributes": { + "target": "com.amazonaws.chimesdkidentity#EndpointAttributes", + "traits": { + "smithy.api#documentation": "The attributes of an Endpoint.
The time at which an AppInstanceUserEndpoint was created.
The time at which an AppInstanceUserEndpoint was last updated.
Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. \n NONE indicates the endpoint will receive no messages.
A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:
\n ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.
\n INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive message. When INACTIVE, the corresponding reason will be \n conveyed through EndpointStatusReason.
\n INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token
\n INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input \n through the ResourceArn field.
An endpoint under an Amazon Chime AppInstanceUser that receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.
The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
The name of the AppInstanceUserEndpoint.
The type of the AppInstanceUserEndpoint.
BBoolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. \n NONE indicates the endpoint will receive no messages.
A read-only field that represent the state of an AppInstanceUserEndpoint.
Summary of the details of an AppInstanceUserEndpoint.
The Amazon Chime SDK Identity APIs in this section allow software developers to create\n and manage unique instances of their messaging applications. These APIs provide the\n overarching framework for creating and sending messages. For more information about the\n identity APIs, refer to Amazon Chime SDK identity.
", + "smithy.api#title": "Amazon Chime SDK Identity" + }, "version": "2021-04-20", "operations": [ { @@ -291,6 +458,9 @@ { "target": "com.amazonaws.chimesdkidentity#DeleteAppInstanceUser" }, + { + "target": "com.amazonaws.chimesdkidentity#DeregisterAppInstanceUserEndpoint" + }, { "target": "com.amazonaws.chimesdkidentity#DescribeAppInstance" }, @@ -300,6 +470,9 @@ { "target": "com.amazonaws.chimesdkidentity#DescribeAppInstanceUser" }, + { + "target": "com.amazonaws.chimesdkidentity#DescribeAppInstanceUserEndpoint" + }, { "target": "com.amazonaws.chimesdkidentity#GetAppInstanceRetentionSettings" }, @@ -309,34 +482,37 @@ { "target": "com.amazonaws.chimesdkidentity#ListAppInstances" }, + { + "target": "com.amazonaws.chimesdkidentity#ListAppInstanceUserEndpoints" + }, { "target": "com.amazonaws.chimesdkidentity#ListAppInstanceUsers" }, + { + "target": "com.amazonaws.chimesdkidentity#ListTagsForResource" + }, { "target": "com.amazonaws.chimesdkidentity#PutAppInstanceRetentionSettings" }, + { + "target": "com.amazonaws.chimesdkidentity#RegisterAppInstanceUserEndpoint" + }, + { + "target": "com.amazonaws.chimesdkidentity#TagResource" + }, + { + "target": "com.amazonaws.chimesdkidentity#UntagResource" + }, { "target": "com.amazonaws.chimesdkidentity#UpdateAppInstance" }, { "target": "com.amazonaws.chimesdkidentity#UpdateAppInstanceUser" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "Chime SDK Identity", - "arnNamespace": "chime", - "cloudFormationName": "ChimeSDKIdentity", - "cloudTrailEventSource": "chimesdkidentity.amazonaws.com", - "endpointPrefix": "identity-chime" - }, - "aws.auth#sigv4": { - "name": "chime" }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "The Amazon Chime SDK Identity APIs in this section allow software developers to create\n and manage unique instances of their messaging applications. These APIs provide the\n overarching framework for creating and sending messages. For more information about the\n identity APIs, refer to Amazon Chime SDK identity.
", - "smithy.api#title": "Amazon Chime SDK Identity" - } + { + "target": "com.amazonaws.chimesdkidentity#UpdateAppInstanceUserEndpoint" + } + ] }, "com.amazonaws.chimesdkidentity#ClientRequestToken": { "type": "string", @@ -795,6 +971,61 @@ } } }, + "com.amazonaws.chimesdkidentity#DeregisterAppInstanceUserEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#DeregisterAppInstanceUserEndpointRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Deregisters an AppInstanceUserEndpoint.
The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
Returns the full details of an AppInstanceUserEndpoint.
The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
The full details of an AppInstanceUserEndpoint: the AppInstanceUserArn, ID, name, type, resource ARN, attributes, \n allow messages, state, and created and last updated timestamps. All timestamps use epoch milliseconds.
The device token for the GCM, APNS, and APNS_SANDBOX endpoint types.
", + "smithy.api#required": {} + } + }, + "VoipDeviceToken": { + "target": "com.amazonaws.chimesdkidentity#NonEmptySensitiveString1600", + "traits": { + "smithy.api#documentation": "The VOIP device token for the APNS and APNS_SANDBOX endpoint types.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The attributes of an Endpoint.
Enum that indicates the Status of an AppInstanceUserEndpoint.
The reason for the EndpointStatus.
A read-only field that represents the state of an AppInstanceUserEndpoint. Supported values:
\n ACTIVE: The AppInstanceUserEndpoint is active and able to receive messages. When ACTIVE, the EndpointStatusReason remains empty.
\n INACTIVE: The AppInstanceUserEndpoint is inactive and can't receive\n message. When INACTIVE, the corresponding reason will be conveyed through\n EndpointStatusReason.
\n INVALID_DEVICE_TOKEN indicates that an AppInstanceUserEndpoint is INACTIVE due to invalid device token
\n INVALID_PINPOINT_ARN indicates that an AppInstanceUserEndpoint is INACTIVE due to an invalid pinpoint ARN that was input through the ResourceArn field.
Lists all the AppInstanceUserEndpoints created under a single AppInstanceUser.
The ARN of the AppInstanceUser.
The maximum number of endpoints that you want to return.
", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkidentity#NextToken", + "traits": { + "smithy.api#documentation": "The token passed by previous API calls until all requested endpoints are returned.
", + "smithy.api#httpQuery": "next-token" + } + } + } + }, + "com.amazonaws.chimesdkidentity#ListAppInstanceUserEndpointsResponse": { + "type": "structure", + "members": { + "AppInstanceUserEndpoints": { + "target": "com.amazonaws.chimesdkidentity#AppInstanceUserEndpointSummaryList", + "traits": { + "smithy.api#documentation": "The information for each requested AppInstanceUserEndpoint.
The token passed by previous API calls until all requested endpoints are returned.
" + } + } + } + }, "com.amazonaws.chimesdkidentity#ListAppInstanceUsers": { "type": "operation", "input": { @@ -1421,6 +1879,67 @@ } } }, + "com.amazonaws.chimesdkidentity#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the tags applied to an Amazon Chime SDK identity resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkidentity#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN of the resource.
", + "smithy.api#httpQuery": "arn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkidentity#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.chimesdkidentity#TagList", + "traits": { + "smithy.api#documentation": "The tag key-value pairs.
" + } + } + } + }, "com.amazonaws.chimesdkidentity#MaxResults": { "type": "integer", "traits": { @@ -1464,6 +1983,17 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.chimesdkidentity#NonEmptySensitiveString1600": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1600 + }, + "smithy.api#pattern": ".*", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.chimesdkidentity#PutAppInstanceRetentionSettings": { "type": "operation", "input": { @@ -1538,6 +2068,120 @@ } } }, + "com.amazonaws.chimesdkidentity#RegisterAppInstanceUserEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#RegisterAppInstanceUserEndpointRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#RegisterAppInstanceUserEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Registers an endpoint under an Amazon Chime AppInstanceUser. The endpoint receives messages for a user. For push notifications, the endpoint is a mobile device used to receive mobile push notifications for a user.
The ARN of the AppInstanceUser.
The name of the AppInstanceUserEndpoint.
The type of the AppInstanceUserEndpoint. Supported types:
\n APNS: The mobile notification service for an Apple device.
\n APNS_SANDBOX: The sandbox environment of the mobile notification service for an Apple device.
\n GCM: The mobile notification service for an Android device.
Populate the ResourceArn value of each type as PinpointAppArn.
The ARN of the resource to which the endpoint belongs.
", + "smithy.api#required": {} + } + }, + "EndpointAttributes": { + "target": "com.amazonaws.chimesdkidentity#EndpointAttributes", + "traits": { + "smithy.api#documentation": "The attributes of an Endpoint.
The idempotency token for each client request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "AllowMessages": { + "target": "com.amazonaws.chimesdkidentity#AllowMessages", + "traits": { + "smithy.api#documentation": "Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint receives all messages. \n NONE indicates the endpoint receives no messages.
The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
The key of the tag.
", + "smithy.api#documentation": "The key in a tag.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.chimesdkidentity#TagValue", "traits": { - "smithy.api#documentation": "The value of the tag.
", + "smithy.api#documentation": "The value in a tag.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Describes a tag applied to a resource.
" + "smithy.api#documentation": "A tag object containing a key-value pair.
" } }, "com.amazonaws.chimesdkidentity#TagKey": { @@ -1642,6 +2319,18 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.chimesdkidentity#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkidentity#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.chimesdkidentity#TagList": { "type": "list", "member": { @@ -1654,6 +2343,62 @@ } } }, + "com.amazonaws.chimesdkidentity#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#TagResourceRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Applies the specified tags to the specified Amazon Chime SDK identity resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags?operation=tag-resource", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkidentity#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "The resource ARN.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.chimesdkidentity#TagList", + "traits": { + "smithy.api#documentation": "The tag key-value pairs.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.chimesdkidentity#TagValue": { "type": "string", "traits": { @@ -1699,6 +2444,59 @@ "smithy.api#httpError": 401 } }, + "com.amazonaws.chimesdkidentity#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#UntagResourceRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the specified tags from the specified Amazon Chime SDK identity resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags?operation=untag-resource", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkidentity#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.chimesdkidentity#ChimeArn", + "traits": { + "smithy.api#documentation": "The resource ARN.
", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.chimesdkidentity#TagKeyList", + "traits": { + "smithy.api#documentation": "The tag keys.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.chimesdkidentity#UpdateAppInstance": { "type": "operation", "input": { @@ -1820,6 +2618,96 @@ } } }, + "com.amazonaws.chimesdkidentity#UpdateAppInstanceUserEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkidentity#UpdateAppInstanceUserEndpointRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkidentity#UpdateAppInstanceUserEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkidentity#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkidentity#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkidentity#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the details of an AppInstanceUserEndpoint. You can update the name and AllowMessage values.
The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
The name of the AppInstanceUserEndpoint.
Boolean that controls whether the AppInstanceUserEndpoint is opted in to receive messages. ALL indicates the endpoint will receive all messages. \n NONE indicates the endpoint will receive no messages.
The ARN of the AppInstanceUser.
The unique identifier of the AppInstanceUserEndpoint.
Summary of the membership details of an AppInstanceUser.
Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the \n DisassociateChannelFlow API.
Only administrators or channel moderators can associate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn \n of the user that makes the API call as the value in the header.
The ARN of the channel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChannelFlowArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN of the channel flow.
", + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The AppInstanceUserArn of the user making the API call.
The ARN of the member that the service couldn't add.
" + "smithy.api#documentation": "The AppInstanceUserArn of the member that the service couldn't add.
The ARNs of the members you want to add to the channel.
", + "smithy.api#documentation": "The AppInstanceUserArns of the members you want to add to the channel.
The time at which a channel was last updated.
" } + }, + "ChannelFlowArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN of the channel flow.
" + } } }, "traits": { "smithy.api#documentation": "The details of a channel.
" } }, + "com.amazonaws.chimesdkmessaging#ChannelAssociatedWithFlowSummary": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.chimesdkmessaging#NonEmptyResourceName", + "traits": { + "smithy.api#documentation": "The name of the channel flow.
" + } + }, + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN of the channel.
" + } + }, + "Mode": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMode", + "traits": { + "smithy.api#documentation": "The mode of the channel.
" + } + }, + "Privacy": { + "target": "com.amazonaws.chimesdkmessaging#ChannelPrivacy", + "traits": { + "smithy.api#documentation": "The channel's privacy setting.
" + } + }, + "Metadata": { + "target": "com.amazonaws.chimesdkmessaging#Metadata", + "traits": { + "smithy.api#documentation": "The channel's metadata.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of details of a channel associated with channel flow.
" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelAssociatedWithFlowSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#ChannelAssociatedWithFlowSummary" + } + }, "com.amazonaws.chimesdkmessaging#ChannelBan": { "type": "structure", "members": { @@ -331,6 +477,177 @@ "target": "com.amazonaws.chimesdkmessaging#ChannelBanSummary" } }, + "com.amazonaws.chimesdkmessaging#ChannelFlow": { + "type": "structure", + "members": { + "ChannelFlowArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN of the channel flow.
" + } + }, + "Processors": { + "target": "com.amazonaws.chimesdkmessaging#ProcessorList", + "traits": { + "smithy.api#documentation": "Information about the processor Lambda functions.
" + } + }, + "Name": { + "target": "com.amazonaws.chimesdkmessaging#NonEmptyResourceName", + "traits": { + "smithy.api#documentation": "The name of the channel flow.
" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.chimesdkmessaging#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which the channel flow was created.
" + } + }, + "LastUpdatedTimestamp": { + "target": "com.amazonaws.chimesdkmessaging#Timestamp", + "traits": { + "smithy.api#documentation": "The time at which a channel flow was updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a channel flow.
" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelFlowCallback": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#ChannelFlowCallbackRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#ChannelFlowCallbackResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.
\nYou can return one of the following processing responses:
\nUpdate message content or metadata
\nDeny a message
\nMake no changes to the message
\nThe identifier passed to the processor by the service when invoked. Use the identifier to call back the service.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + }, + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN of the channel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DeleteResource": { + "target": "com.amazonaws.chimesdkmessaging#NonNullableBoolean", + "traits": { + "smithy.api#documentation": "When a processor determines that a message needs to be DENIED, pass this parameter with a value of true.
Stores information about the processed message.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ChannelFlowCallbackResponse": { + "type": "structure", + "members": { + "ChannelArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN of the channel.
" + } + }, + "CallbackId": { + "target": "com.amazonaws.chimesdkmessaging#CallbackIdType", + "traits": { + "smithy.api#documentation": "The call back ID passed in the request.
" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ChannelFlowExecutionOrder": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.chimesdkmessaging#ChannelFlowSummary": { + "type": "structure", + "members": { + "ChannelFlowArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN of the channel flow.
" + } + }, + "Name": { + "target": "com.amazonaws.chimesdkmessaging#NonEmptyResourceName", + "traits": { + "smithy.api#documentation": "The name of the channel flow.
" + } + }, + "Processors": { + "target": "com.amazonaws.chimesdkmessaging#ProcessorList", + "traits": { + "smithy.api#documentation": "Information about the processor Lambda functions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary of details of a channel flow.
" + } + }, + "com.amazonaws.chimesdkmessaging#ChannelFlowSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#ChannelFlowSummary" + } + }, "com.amazonaws.chimesdkmessaging#ChannelMembership": { "type": "structure", "members": { @@ -401,10 +718,24 @@ "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipForAppInstanceUserSummary" } }, - "com.amazonaws.chimesdkmessaging#ChannelMembershipSummary": { + "com.amazonaws.chimesdkmessaging#ChannelMembershipPreferences": { "type": "structure", "members": { - "Member": { + "PushNotifications": { + "target": "com.amazonaws.chimesdkmessaging#PushNotificationPreferences", + "traits": { + "smithy.api#documentation": "The push notification configuration of a message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The channel membership preferences for an AppInstanceUser.
A member's summary data.
" @@ -504,12 +835,51 @@ "traits": { "smithy.api#documentation": "The persistence setting for a channel message.
" } + }, + "Status": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMessageStatusStructure", + "traits": { + "smithy.api#documentation": "The status of the channel message.
" + } + }, + "MessageAttributes": { + "target": "com.amazonaws.chimesdkmessaging#MessageAttributeMap", + "traits": { + "smithy.api#documentation": "The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
The details of a message in a channel.
" } }, + "com.amazonaws.chimesdkmessaging#ChannelMessageCallback": { + "type": "structure", + "members": { + "MessageId": { + "target": "com.amazonaws.chimesdkmessaging#MessageId", + "traits": { + "smithy.api#documentation": "The message ID.
", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.chimesdkmessaging#NonEmptyContent", + "traits": { + "smithy.api#documentation": "The message content.
" + } + }, + "Metadata": { + "target": "com.amazonaws.chimesdkmessaging#Metadata", + "traits": { + "smithy.api#documentation": "The message metadata.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Stores information about a callback.
" + } + }, "com.amazonaws.chimesdkmessaging#ChannelMessagePersistenceType": { "type": "string", "traits": { @@ -525,6 +895,49 @@ ] } }, + "com.amazonaws.chimesdkmessaging#ChannelMessageStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SENT", + "name": "SENT" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "DENIED", + "name": "DENIED" + } + ] + } + }, + "com.amazonaws.chimesdkmessaging#ChannelMessageStatusStructure": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMessageStatus", + "traits": { + "smithy.api#documentation": "The message status value.
" + } + }, + "Detail": { + "target": "com.amazonaws.chimesdkmessaging#StatusDetail", + "traits": { + "smithy.api#documentation": "Contains more details about the messasge status.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Stores information about a message status.
" + } + }, "com.amazonaws.chimesdkmessaging#ChannelMessageSummary": { "type": "structure", "members": { @@ -581,6 +994,18 @@ "traits": { "smithy.api#documentation": "Indicates whether a message was redacted.
" } + }, + "Status": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMessageStatusStructure", + "traits": { + "smithy.api#documentation": "The message status. The status value is SENT for messages sent to a channel without a channel flow. For channels associated with channel flow, the value determines the \n processing stage.
The message attribues listed in a the summary of a channel message.
" + } } }, "traits": { @@ -774,15 +1199,24 @@ "type": "service", "version": "2021-05-15", "operations": [ + { + "target": "com.amazonaws.chimesdkmessaging#AssociateChannelFlow" + }, { "target": "com.amazonaws.chimesdkmessaging#BatchCreateChannelMembership" }, + { + "target": "com.amazonaws.chimesdkmessaging#ChannelFlowCallback" + }, { "target": "com.amazonaws.chimesdkmessaging#CreateChannel" }, { "target": "com.amazonaws.chimesdkmessaging#CreateChannelBan" }, + { + "target": "com.amazonaws.chimesdkmessaging#CreateChannelFlow" + }, { "target": "com.amazonaws.chimesdkmessaging#CreateChannelMembership" }, @@ -795,6 +1229,9 @@ { "target": "com.amazonaws.chimesdkmessaging#DeleteChannelBan" }, + { + "target": "com.amazonaws.chimesdkmessaging#DeleteChannelFlow" + }, { "target": "com.amazonaws.chimesdkmessaging#DeleteChannelMembership" }, @@ -810,6 +1247,9 @@ { "target": "com.amazonaws.chimesdkmessaging#DescribeChannelBan" }, + { + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelFlow" + }, { "target": "com.amazonaws.chimesdkmessaging#DescribeChannelMembership" }, @@ -822,15 +1262,27 @@ { "target": "com.amazonaws.chimesdkmessaging#DescribeChannelModerator" }, + { + "target": "com.amazonaws.chimesdkmessaging#DisassociateChannelFlow" + }, + { + "target": "com.amazonaws.chimesdkmessaging#GetChannelMembershipPreferences" + }, { "target": "com.amazonaws.chimesdkmessaging#GetChannelMessage" }, + { + "target": "com.amazonaws.chimesdkmessaging#GetChannelMessageStatus" + }, { "target": "com.amazonaws.chimesdkmessaging#GetMessagingSessionEndpoint" }, { "target": "com.amazonaws.chimesdkmessaging#ListChannelBans" }, + { + "target": "com.amazonaws.chimesdkmessaging#ListChannelFlows" + }, { "target": "com.amazonaws.chimesdkmessaging#ListChannelMemberships" }, @@ -846,18 +1298,36 @@ { "target": "com.amazonaws.chimesdkmessaging#ListChannels" }, + { + "target": "com.amazonaws.chimesdkmessaging#ListChannelsAssociatedWithChannelFlow" + }, { "target": "com.amazonaws.chimesdkmessaging#ListChannelsModeratedByAppInstanceUser" }, + { + "target": "com.amazonaws.chimesdkmessaging#ListTagsForResource" + }, + { + "target": "com.amazonaws.chimesdkmessaging#PutChannelMembershipPreferences" + }, { "target": "com.amazonaws.chimesdkmessaging#RedactChannelMessage" }, { "target": "com.amazonaws.chimesdkmessaging#SendChannelMessage" }, + { + "target": "com.amazonaws.chimesdkmessaging#TagResource" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UntagResource" + }, { "target": "com.amazonaws.chimesdkmessaging#UpdateChannel" }, + { + "target": "com.amazonaws.chimesdkmessaging#UpdateChannelFlow" + }, { "target": "com.amazonaws.chimesdkmessaging#UpdateChannelMessage" }, @@ -1019,7 +1489,7 @@ "MemberArn": { "target": "com.amazonaws.chimesdkmessaging#ChimeArn", "traits": { - "smithy.api#documentation": "The ARN of the member being banned.
", + "smithy.api#documentation": "The AppInstanceUserArn of the member being banned.
Creates a channel flow, a container for processors. Processors are AWS Lambda functions\n that perform actions on chat messages, such as stripping out profanity. You can associate\n channel flows with channels, and the processors in the channel flow then take action on all\n messages sent to that channel. This is a developer API.
\n \nChannel flows process the following items:
\nNew and updated messages
\nPersistent and non-persistent messages
\nThe Standard message type
\nChannel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to \n Message types in the Amazon Chime developer guide.
\nThe ARN of the channel flow request.
", + "smithy.api#required": {} + } + }, + "Processors": { + "target": "com.amazonaws.chimesdkmessaging#ProcessorList", + "traits": { + "smithy.api#documentation": "Information about the processor Lambda functions.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.chimesdkmessaging#NonEmptyResourceName", + "traits": { + "smithy.api#documentation": "The name of the channel flow.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.chimesdkmessaging#TagList", + "traits": { + "smithy.api#documentation": "The tags for the creation request.
" + } + }, + "ClientRequestToken": { + "target": "com.amazonaws.chimesdkmessaging#ClientRequestToken", + "traits": { + "smithy.api#documentation": "The client token for the request. An Idempotency token.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#CreateChannelFlowResponse": { + "type": "structure", + "members": { + "ChannelFlowArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN of the channel flow.
" + } + } + } + }, "com.amazonaws.chimesdkmessaging#CreateChannelMembership": { "type": "operation", "input": { @@ -1085,7 +1648,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds a user to a channel. The InvitedBy response field is derived from the\n request header. A channel member can:
List messages
\nSend messages
\nReceive messages
\nEdit their own messages
\nLeave the channel
\nPrivacy settings impact this action as follows:
\n\nPublic Channels: You do not need to be a member to list messages, but you must be\n a member to send messages.
\nPrivate Channels: You must be a member to list or send messages.
\nThe x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.
Adds a user to a channel. The InvitedBy field in ChannelMembership is derived from the\n request header. A channel member can:
List messages
\nSend messages
\nReceive messages
\nEdit their own messages
\nLeave the channel
\nPrivacy settings impact this action as follows:
\n\nPublic Channels: You do not need to be a member to list messages, but you must be\n a member to send messages.
\nPrivate Channels: You must be a member to list or send messages.
\nThe x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.
The ARN of the member you want to add to the channel.
", + "smithy.api#documentation": "The AppInstanceUserArn of the member you want to add to the channel.
The ARN of the moderator.
", + "smithy.api#documentation": "The AppInstanceUserArn of the moderator.
Deletes a channel flow, an irreversible process. This is a developer API.
\n This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the \n ListChannelsAssociatedWithChannelFlow API. Use the DisassociateChannelFlow API to disassociate a channel flow from all channels.
The ARN of the channel flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.chimesdkmessaging#DeleteChannelMembership": { "type": "operation", "input": { @@ -1451,7 +2064,7 @@ "MemberArn": { "target": "com.amazonaws.chimesdkmessaging#ChimeArn", "traits": { - "smithy.api#documentation": "The ARN of the member that you're removing from the channel.
", + "smithy.api#documentation": "The AppInstanceUserArn of the member that you're removing from the channel.
The ARN of the moderator being deleted.
", + "smithy.api#documentation": "The AppInstanceUserArn of the moderator being deleted.
The ARN of the member being banned.
", + "smithy.api#documentation": "The AppInstanceUserArn of the member being banned.
Returns the full details of a user's channel membership.
\nThe x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.
Returns the full details of a channel flow in an Amazon Chime AppInstance. This is a developer API.
The ARN of the channel flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelFlowResponse": { + "type": "structure", + "members": { + "ChannelFlow": { + "target": "com.amazonaws.chimesdkmessaging#ChannelFlow", + "traits": { + "smithy.api#documentation": "The channel flow details.
" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#DescribeChannelMembership": { "type": "operation", "input": { - "target": "com.amazonaws.chimesdkmessaging#DescribeChannelMembershipForAppInstanceUserRequest" + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelMembershipRequest" }, "output": { - "target": "com.amazonaws.chimesdkmessaging#DescribeChannelMembershipForAppInstanceUserResponse" + "target": "com.amazonaws.chimesdkmessaging#DescribeChannelMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#NotFoundException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the full details of a user's channel membership.
\nThe x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.
The ARN of the member.
", + "smithy.api#documentation": "The AppInstanceUserArn of the member.
The ARN of the channel moderator.
", + "smithy.api#documentation": "The AppInstanceUserArn of the channel moderator.
Disassociates a channel flow from all its channels. Once disassociated, all messages to\n that channel stop going through the channel flow processor.
\nOnly administrators or channel moderators can disassociate a channel flow. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn \n of the user that makes the API call as the value in the header.
The ARN of the channel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChannelFlowArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN of the channel flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The AppInstanceUserArn of the user making the API call.
Gets the full details of a channel message.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.
Gets the membership preferences of an AppInstanceUser for the specified channel. The AppInstanceUser must be a member of the channel. \n Only the AppInstanceUser who owns the membership can retrieve preferences. Users in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users. \n Banned users can't retrieve membership preferences for the channel from which they are banned.
The ID of the message.
", + "smithy.api#documentation": "The AppInstanceUserArn of the member retrieving the preferences.
The AppInstanceUserArn of the user that makes the API call.
The AppInstanceUserARN of the user making the API call.
The details of and content in the message.
" + "smithy.api#documentation": "The ARN of the channel.
" + } + }, + "Member": { + "target": "com.amazonaws.chimesdkmessaging#Identity" + }, + "Preferences": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipPreferences", + "traits": { + "smithy.api#documentation": "The channel membership preferences for an AppInstanceUser .
The details of the endpoint for the messaging session.
", + "smithy.api#documentation": "Gets the full details of a channel message.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.
The endpoint returned in the response.
" + "smithy.api#documentation": "The ARN of the channel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MessageId": { + "target": "com.amazonaws.chimesdkmessaging#MessageId", + "traits": { + "smithy.api#documentation": "The ID of the message.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The ARN in an Identity.
" - } - }, - "Name": { - "target": "com.amazonaws.chimesdkmessaging#ResourceName", + "ChannelMessage": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMessage", "traits": { - "smithy.api#documentation": "The name in an Identity.
" + "smithy.api#documentation": "The details of and content in the message.
" } } - }, - "traits": { - "smithy.api#documentation": "The details of a user.
" } }, - "com.amazonaws.chimesdkmessaging#ListChannelBans": { + "com.amazonaws.chimesdkmessaging#GetChannelMessageStatus": { "type": "operation", "input": { - "target": "com.amazonaws.chimesdkmessaging#ListChannelBansRequest" + "target": "com.amazonaws.chimesdkmessaging#GetChannelMessageStatusRequest" }, "output": { - "target": "com.amazonaws.chimesdkmessaging#ListChannelBansResponse" + "target": "com.amazonaws.chimesdkmessaging#GetChannelMessageStatusResponse" }, "errors": [ { @@ -2337,78 +3122,353 @@ } ], "traits": { - "smithy.api#documentation": "Lists all the users banned from a particular channel.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.
Gets message status for a specified messageId. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to \n retrieving message status if the event was not received because a client wasn't connected to a websocket.
Messages can have any one of these statuses.
\n \nMessage processed successfully
\nOngoing processing
\nProcessing failed
\nMessasge denied by the processor
\nThis API does not return statuses for denied messages, because we don't store them once the processor denies them.
\nOnly the message sender can invoke this API.
\nThe x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header
The ARN of the channel.
", + "smithy.api#documentation": "The ARN of the channel
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.chimesdkmessaging#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of bans that you want returned.
", - "smithy.api#httpQuery": "max-results" - } - }, - "NextToken": { - "target": "com.amazonaws.chimesdkmessaging#NextToken", + "MessageId": { + "target": "com.amazonaws.chimesdkmessaging#MessageId", "traits": { - "smithy.api#documentation": "The token passed by previous API calls until all requested bans are returned.
", - "smithy.api#httpQuery": "next-token" + "smithy.api#documentation": "The ID of the message.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "ChimeBearer": { "target": "com.amazonaws.chimesdkmessaging#ChimeArn", "traits": { - "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The AppInstanceUserArn of the user making the API call.
The ARN of the channel.
" - } - }, - "NextToken": { - "target": "com.amazonaws.chimesdkmessaging#NextToken", + "Status": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMessageStatusStructure", "traits": { - "smithy.api#documentation": "The token passed by previous API calls until all requested bans are returned.
" - } - }, - "ChannelBans": { - "target": "com.amazonaws.chimesdkmessaging#ChannelBanSummaryList", - "traits": { - "smithy.api#documentation": "The information for each requested ban.
" + "smithy.api#documentation": "The message status and details.
" } } } }, - "com.amazonaws.chimesdkmessaging#ListChannelMemberships": { + "com.amazonaws.chimesdkmessaging#GetMessagingSessionEndpoint": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#GetMessagingSessionEndpointRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#GetMessagingSessionEndpointResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "The details of the endpoint for the messaging session.
", + "smithy.api#http": { + "method": "GET", + "uri": "/endpoints/messaging-session", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#GetMessagingSessionEndpointRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.chimesdkmessaging#GetMessagingSessionEndpointResponse": { + "type": "structure", + "members": { + "Endpoint": { + "target": "com.amazonaws.chimesdkmessaging#MessagingSessionEndpoint", + "traits": { + "smithy.api#documentation": "The endpoint returned in the response.
" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#Identity": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN in an Identity.
" + } + }, + "Name": { + "target": "com.amazonaws.chimesdkmessaging#ResourceName", + "traits": { + "smithy.api#documentation": "The name in an Identity.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a user.
" + } + }, + "com.amazonaws.chimesdkmessaging#InvocationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASYNC", + "name": "ASYNC" + } + ] + } + }, + "com.amazonaws.chimesdkmessaging#LambdaConfiguration": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.chimesdkmessaging#LambdaFunctionArn", + "traits": { + "smithy.api#documentation": "The ARN of the Lambda message processing function.
", + "smithy.api#required": {} + } + }, + "InvocationType": { + "target": "com.amazonaws.chimesdkmessaging#InvocationType", + "traits": { + "smithy.api#documentation": "Controls how the Lambda function is invoked.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Stores metadata about a Lambda processor.
" + } + }, + "com.amazonaws.chimesdkmessaging#LambdaFunctionArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9\\-_\\.]+(:(\\$LATEST|[a-zA-Z0-9\\-_]+))?$" + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelBans": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelBansRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelBansResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the users banned from a particular channel.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.
The ARN of the channel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkmessaging#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of bans that you want returned.
", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmessaging#NextToken", + "traits": { + "smithy.api#documentation": "The token passed by previous API calls until all requested bans are returned.
", + "smithy.api#httpQuery": "next-token" + } + }, + "ChimeBearer": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The AppInstanceUserArn of the user that makes the API call.
The ARN of the channel.
" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmessaging#NextToken", + "traits": { + "smithy.api#documentation": "The token passed by previous API calls until all requested bans are returned.
" + } + }, + "ChannelBans": { + "target": "com.amazonaws.chimesdkmessaging#ChannelBanSummaryList", + "traits": { + "smithy.api#documentation": "The information for each requested ban.
" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelFlows": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelFlowsRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelFlowsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.
", + "smithy.api#http": { + "method": "GET", + "uri": "/channel-flows", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelFlowsRequest": { + "type": "structure", + "members": { + "AppInstanceArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN of the app instance.
", + "smithy.api#httpQuery": "app-instance-arn", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkmessaging#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of channel flows that you want to return.
", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmessaging#NextToken", + "traits": { + "smithy.api#documentation": "The token passed by previous API calls until all requested channel flows are returned.
", + "smithy.api#httpQuery": "next-token" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelFlowsResponse": { + "type": "structure", + "members": { + "ChannelFlows": { + "target": "com.amazonaws.chimesdkmessaging#ChannelFlowSummaryList", + "traits": { + "smithy.api#documentation": "The information about each channel flow.
" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmessaging#NextToken", + "traits": { + "smithy.api#documentation": "The token passed by previous API calls until all requested channels are returned.
" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelMemberships": { "type": "operation", "input": { "target": "com.amazonaws.chimesdkmessaging#ListChannelMembershipsRequest" @@ -2437,7 +3497,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all channel memberships in a channel.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.
Lists all channel memberships in a channel.
\n\nThe x-amz-chime-bearer request header is mandatory. Use the\n AppInstanceUserArn of the user that makes the API call as the value in\n the header.
If you want to list the channels to which a specific app instance user belongs, see the \n ListChannelMembershipsForAppInstanceUser API.
", "smithy.api#http": { "method": "GET", "uri": "/channels/{ChannelArn}/memberships", @@ -2864,10 +3924,96 @@ "uri": "/channels", "code": 200 }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelsAssociatedWithChannelFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelsAssociatedWithChannelFlowRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#ListChannelsAssociatedWithChannelFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.
", + "smithy.api#http": { + "method": "GET", + "uri": "/channels?scope=channel-flow-associations", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelsAssociatedWithChannelFlowRequest": { + "type": "structure", + "members": { + "ChannelFlowArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN of the channel flow.
", + "smithy.api#httpQuery": "channel-flow-arn", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.chimesdkmessaging#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of channels that you want to return.
", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmessaging#NextToken", + "traits": { + "smithy.api#documentation": "The token passed by previous API calls until all requested channels are returned.
", + "smithy.api#httpQuery": "next-token" + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListChannelsAssociatedWithChannelFlowResponse": { + "type": "structure", + "members": { + "Channels": { + "target": "com.amazonaws.chimesdkmessaging#ChannelAssociatedWithFlowSummaryList", + "traits": { + "smithy.api#documentation": "The information about each channel.
" + } + }, + "NextToken": { + "target": "com.amazonaws.chimesdkmessaging#NextToken", + "traits": { + "smithy.api#documentation": "The token passed by previous API calls until all requested channels are returned.
" + } } } }, @@ -3023,6 +4169,67 @@ } } }, + "com.amazonaws.chimesdkmessaging#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the tags applied to an Amazon Chime SDK messaging resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN of the resource.
", + "smithy.api#httpQuery": "arn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.chimesdkmessaging#TagList", + "traits": { + "smithy.api#documentation": "The tag key-value pairs.
" + } + } + } + }, "com.amazonaws.chimesdkmessaging#MaxResults": { "type": "integer", "traits": { @@ -3051,6 +4258,57 @@ "target": "com.amazonaws.chimesdkmessaging#Identity" } }, + "com.amazonaws.chimesdkmessaging#MessageAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.chimesdkmessaging#MessageAttributeName" + }, + "value": { + "target": "com.amazonaws.chimesdkmessaging#MessageAttributeValue" + } + }, + "com.amazonaws.chimesdkmessaging#MessageAttributeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[\\s\\S]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#MessageAttributeStringValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\s\\S]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#MessageAttributeStringValues": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#MessageAttributeStringValue" + } + }, + "com.amazonaws.chimesdkmessaging#MessageAttributeValue": { + "type": "structure", + "members": { + "StringValues": { + "target": "com.amazonaws.chimesdkmessaging#MessageAttributeStringValues", + "traits": { + "smithy.api#documentation": "The strings in a message attribute value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of message attribute values.
" + } + }, "com.amazonaws.chimesdkmessaging#MessageId": { "type": "string", "traits": { @@ -3103,38 +4361,284 @@ "smithy.api#length": { "min": 1 }, - "smithy.api#pattern": "^[\\s\\S]*$", - "smithy.api#sensitive": {} + "smithy.api#pattern": "^[\\s\\S]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#NonEmptyResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#NonNullableBoolean": { + "type": "boolean" + }, + "com.amazonaws.chimesdkmessaging#NotFoundException": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.chimesdkmessaging#ErrorCode" + }, + "Message": { + "target": "com.amazonaws.chimesdkmessaging#String" + } + }, + "traits": { + "smithy.api#documentation": "One or more of the resources in the request does not exist in the system.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.chimesdkmessaging#Processor": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.chimesdkmessaging#NonEmptyResourceName", + "traits": { + "smithy.api#documentation": "The name of the channel flow.
", + "smithy.api#required": {} + } + }, + "Configuration": { + "target": "com.amazonaws.chimesdkmessaging#ProcessorConfiguration", + "traits": { + "smithy.api#documentation": "The information about the type of processor and its identifier.
", + "smithy.api#required": {} + } + }, + "ExecutionOrder": { + "target": "com.amazonaws.chimesdkmessaging#ChannelFlowExecutionOrder", + "traits": { + "smithy.api#documentation": "The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. \n At this point, we support only 1 processor within a flow.
", + "smithy.api#required": {} + } + }, + "FallbackAction": { + "target": "com.amazonaws.chimesdkmessaging#FallbackAction", + "traits": { + "smithy.api#documentation": "Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of ABORT and \n communication with it fails, the processor sets the message status to FAILED and does not send the message to any recipients. Note that if the last processor in the channel flow sequence \n has a fallback action of CONTINUE and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.
The information about a processor in a channel flow.
" + } + }, + "com.amazonaws.chimesdkmessaging#ProcessorConfiguration": { + "type": "structure", + "members": { + "Lambda": { + "target": "com.amazonaws.chimesdkmessaging#LambdaConfiguration", + "traits": { + "smithy.api#documentation": "Indicates that the processor is of type Lambda.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A processor's metadata.
" + } + }, + "com.amazonaws.chimesdkmessaging#ProcessorList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#Processor" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 3 + } + } + }, + "com.amazonaws.chimesdkmessaging#PushNotificationBody": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + }, + "smithy.api#pattern": "^[\\s\\S]*$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#PushNotificationConfiguration": { + "type": "structure", + "members": { + "Title": { + "target": "com.amazonaws.chimesdkmessaging#PushNotificationTitle", + "traits": { + "smithy.api#documentation": "The title of the push notification.
", + "smithy.api#required": {} + } + }, + "Body": { + "target": "com.amazonaws.chimesdkmessaging#PushNotificationBody", + "traits": { + "smithy.api#documentation": "The body of the push notification.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.chimesdkmessaging#PushNotificationType", + "traits": { + "smithy.api#documentation": "Enum value that indicates the type of the push notification for a message.\n DEFAULT: Normal mobile push notification.\n VOIP: VOIP mobile push notification.
The push notification configuration of the message.
" + } + }, + "com.amazonaws.chimesdkmessaging#PushNotificationPreferences": { + "type": "structure", + "members": { + "AllowNotifications": { + "target": "com.amazonaws.chimesdkmessaging#AllowNotifications", + "traits": { + "smithy.api#documentation": "Enum value that indicates which push notifications to send to the requested member of a channel.\n ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered push notifications. \n
The simple JSON object used to send a subset of a push notification to the requsted member.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The channel membership preferences for push notification.
" + } + }, + "com.amazonaws.chimesdkmessaging#PushNotificationTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#pattern": ".*", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.chimesdkmessaging#PushNotificationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DEFAULT", + "name": "DEFAULT" + }, + { + "value": "VOIP", + "name": "VOIP" + } + ] + } + }, + "com.amazonaws.chimesdkmessaging#PutChannelMembershipPreferences": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#PutChannelMembershipPreferencesRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#PutChannelMembershipPreferencesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Sets the membership preferences of an AppInstanceUser for the specified channel. The AppInstanceUser must be a member of the channel. \n Only the AppInstanceUser who owns the membership can set preferences. Users in the AppInstanceAdmin and channel moderator roles can't set preferences for other users. \n Banned users can't set membership preferences for the channel from which they are banned.
The ARN of the channel.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } }, - "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*$", - "smithy.api#sensitive": {} + "MemberArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The AppInstanceUserArn of the member setting the preferences.
The AppInstanceUserARN of the user making the API call.
The channel membership preferences of an AppInstanceUser .
The ARN of the channel.
" + } }, - "Message": { - "target": "com.amazonaws.chimesdkmessaging#String" + "Member": { + "target": "com.amazonaws.chimesdkmessaging#Identity" + }, + "Preferences": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipPreferences", + "traits": { + "smithy.api#documentation": "The ARN and metadata of the member being added.
" + } } - }, - "traits": { - "smithy.api#documentation": "One or more of the resources in the request does not exist in the system.
", - "smithy.api#error": "client", - "smithy.api#httpError": 404 } }, "com.amazonaws.chimesdkmessaging#RedactChannelMessage": { @@ -3340,6 +4844,18 @@ "smithy.api#httpHeader": "x-amz-chime-bearer", "smithy.api#required": {} } + }, + "PushNotification": { + "target": "com.amazonaws.chimesdkmessaging#PushNotificationConfiguration", + "traits": { + "smithy.api#documentation": "The push notification configuration of the message.
" + } + }, + "MessageAttributes": { + "target": "com.amazonaws.chimesdkmessaging#MessageAttributeMap", + "traits": { + "smithy.api#documentation": "The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
The ID string assigned to each message.
" } + }, + "Status": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMessageStatusStructure", + "traits": { + "smithy.api#documentation": "The status of the channel message.
" + } } } }, @@ -3407,6 +4929,16 @@ ] } }, + "com.amazonaws.chimesdkmessaging#StatusDetail": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, "com.amazonaws.chimesdkmessaging#String": { "type": "string" }, @@ -3416,20 +4948,20 @@ "Key": { "target": "com.amazonaws.chimesdkmessaging#TagKey", "traits": { - "smithy.api#documentation": "The key of the tag.
", + "smithy.api#documentation": "The key in a tag.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.chimesdkmessaging#TagValue", "traits": { - "smithy.api#documentation": "The value of the tag.
", + "smithy.api#documentation": "The value in a tag.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Describes a tag applied to a resource.
" + "smithy.api#documentation": "A tag object containing a key-value pair.
" } }, "com.amazonaws.chimesdkmessaging#TagKey": { @@ -3442,6 +4974,18 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.chimesdkmessaging#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.chimesdkmessaging#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.chimesdkmessaging#TagList": { "type": "list", "member": { @@ -3454,6 +4998,62 @@ } } }, + "com.amazonaws.chimesdkmessaging#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#TagResourceRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Applies the specified tags to the specified Amazon Chime SDK messaging resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags?operation=tag-resource", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkmessaging#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The resource ARN.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.chimesdkmessaging#TagList", + "traits": { + "smithy.api#documentation": "The tag key-value pairs.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.chimesdkmessaging#TagValue": { "type": "string", "traits": { @@ -3499,6 +5099,59 @@ "smithy.api#httpError": 401 } }, + "com.amazonaws.chimesdkmessaging#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#UntagResourceRequest" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the specified tags from the specified Amazon Chime SDK messaging resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags?operation=untag-resource", + "code": 204 + } + } + }, + "com.amazonaws.chimesdkmessaging#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceARN": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The resource ARN.
", + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.chimesdkmessaging#TagKeyList", + "traits": { + "smithy.api#documentation": "The tag keys.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.chimesdkmessaging#UpdateChannel": { "type": "operation", "input": { @@ -3539,6 +5192,84 @@ } } }, + "com.amazonaws.chimesdkmessaging#UpdateChannelFlow": { + "type": "operation", + "input": { + "target": "com.amazonaws.chimesdkmessaging#UpdateChannelFlowRequest" + }, + "output": { + "target": "com.amazonaws.chimesdkmessaging#UpdateChannelFlowResponse" + }, + "errors": [ + { + "target": "com.amazonaws.chimesdkmessaging#BadRequestException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ConflictException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ForbiddenException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceFailureException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ServiceUnavailableException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#ThrottledClientException" + }, + { + "target": "com.amazonaws.chimesdkmessaging#UnauthorizedClientException" + } + ], + "traits": { + "smithy.api#documentation": "Updates channel flow attributes. This is a developer API.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/channel-flows/{ChannelFlowArn}", + "code": 200 + } + } + }, + "com.amazonaws.chimesdkmessaging#UpdateChannelFlowRequest": { + "type": "structure", + "members": { + "ChannelFlowArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN of the channel flow.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Processors": { + "target": "com.amazonaws.chimesdkmessaging#ProcessorList", + "traits": { + "smithy.api#documentation": "Information about the processor Lambda functions
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.chimesdkmessaging#NonEmptyResourceName", + "traits": { + "smithy.api#documentation": "The name of the channel flow.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.chimesdkmessaging#UpdateChannelFlowResponse": { + "type": "structure", + "members": { + "ChannelFlowArn": { + "target": "com.amazonaws.chimesdkmessaging#ChimeArn", + "traits": { + "smithy.api#documentation": "The ARN of the channel flow.
" + } + } + } + }, "com.amazonaws.chimesdkmessaging#UpdateChannelMessage": { "type": "operation", "input": { @@ -3634,6 +5365,12 @@ "traits": { "smithy.api#documentation": "The ID string of the message being updated.
" } + }, + "Status": { + "target": "com.amazonaws.chimesdkmessaging#ChannelMessageStatusStructure", + "traits": { + "smithy.api#documentation": "The status of the message update.
" + } } } }, diff --git a/codegen/sdk/aws-models/cloudsearch.2013-01-01.json b/codegen/sdk/aws-models/cloudsearch.2013-01-01.json index 22c9918a1f0..a324ecb25bf 100644 --- a/codegen/sdk/aws-models/cloudsearch.2013-01-01.json +++ b/codegen/sdk/aws-models/cloudsearch.2013-01-01.json @@ -483,6 +483,9 @@ }, { "target": "com.amazonaws.cloudsearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudsearch#ValidationException" } ], "traits": { @@ -671,6 +674,9 @@ }, { "target": "com.amazonaws.cloudsearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudsearch#ValidationException" } ], "traits": { @@ -734,6 +740,9 @@ }, { "target": "com.amazonaws.cloudsearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudsearch#ValidationException" } ], "traits": { @@ -797,6 +806,9 @@ }, { "target": "com.amazonaws.cloudsearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudsearch#ValidationException" } ], "traits": { @@ -861,6 +873,9 @@ }, { "target": "com.amazonaws.cloudsearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudsearch#ValidationException" } ], "traits": { @@ -921,6 +936,9 @@ }, { "target": "com.amazonaws.cloudsearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudsearch#ValidationException" } ], "traits": { @@ -1029,6 +1047,9 @@ }, { "target": "com.amazonaws.cloudsearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudsearch#ValidationException" } ], "traits": { @@ -1091,6 +1112,9 @@ }, { "target": "com.amazonaws.cloudsearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudsearch#ValidationException" } ], "traits": { @@ -1153,6 +1177,9 @@ }, { "target": "com.amazonaws.cloudsearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudsearch#ValidationException" } ], "traits": { @@ -2194,6 +2221,9 @@ }, { "target": "com.amazonaws.cloudsearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudsearch#ValidationException" } ], "traits": { @@ -3323,6 +3353,9 @@ }, { "target": "com.amazonaws.cloudsearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudsearch#ValidationException" } ], "traits": { @@ -3386,6 +3419,9 @@ }, { "target": "com.amazonaws.cloudsearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.cloudsearch#ValidationException" } ], "traits": { diff --git a/codegen/sdk/aws-models/configservice.2014-11-12.json b/codegen/sdk/aws-models/configservice.2014-11-12.json index a4cc0da461e..6b636c1dbad 100644 --- a/codegen/sdk/aws-models/configservice.2014-11-12.json +++ b/codegen/sdk/aws-models/configservice.2014-11-12.json @@ -10315,6 +10315,10 @@ { "value": "AWS::EKS::Cluster", "name": "EKSCluster" + }, + { + "value": "AWS::OpenSearch::Domain", + "name": "OpenSearchDomain" } ] } diff --git a/codegen/sdk/aws-models/connect.2017-08-08.json b/codegen/sdk/aws-models/connect.2017-08-08.json index 8a0c583bc43..35cf1c115ab 100644 --- a/codegen/sdk/aws-models/connect.2017-08-08.json +++ b/codegen/sdk/aws-models/connect.2017-08-08.json @@ -1774,7 +1774,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nCreates hours of operation.
", + "smithy.api#documentation": "Creates hours of operation.
", "smithy.api#http": { "method": "PUT", "uri": "/hours-of-operations/{InstanceId}", @@ -2862,7 +2862,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nDeletes an hours of operation.
", + "smithy.api#documentation": "Deletes an hours of operation.
", "smithy.api#http": { "method": "DELETE", "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", @@ -3355,7 +3355,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nDescribes the hours of operation.
", + "smithy.api#documentation": "Describes the hours of operation.
", "smithy.api#http": { "method": "GET", "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", @@ -5493,14 +5493,14 @@ "StartTime": { "target": "com.amazonaws.connect#HoursOfOperationTimeSlice", "traits": { - "smithy.api#documentation": "The start time that your contact center is open.
", + "smithy.api#documentation": "The start time that your contact center opens.
", "smithy.api#required": {} } }, "EndTime": { "target": "com.amazonaws.connect#HoursOfOperationTimeSlice", "traits": { - "smithy.api#documentation": "The end time that your contact center is closes.
", + "smithy.api#documentation": "The end time that your contact center closes.
", "smithy.api#required": {} } } @@ -7198,7 +7198,7 @@ "target": "com.amazonaws.connect#MaxResult25", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#documentation": "The maximum number of results to return per page. If no value is specified, the default is 10.
", "smithy.api#httpQuery": "maxResults" } } @@ -11918,7 +11918,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nUpdates the hours of operation.
", + "smithy.api#documentation": "Updates the hours of operation.
", "smithy.api#http": { "method": "POST", "uri": "/hours-of-operations/{InstanceId}/{HoursOfOperationId}", diff --git a/codegen/sdk/aws-models/dataexchange.2017-07-25.json b/codegen/sdk/aws-models/dataexchange.2017-07-25.json index 67849e769c3..82228f4463a 100644 --- a/codegen/sdk/aws-models/dataexchange.2017-07-25.json +++ b/codegen/sdk/aws-models/dataexchange.2017-07-25.json @@ -50,8 +50,14 @@ "type": "structure", "members": { "ExportRevisionToS3": { - "target": "com.amazonaws.dataexchange#AutoExportRevisionToS3RequestDetails" + "target": "com.amazonaws.dataexchange#AutoExportRevisionToS3RequestDetails", + "traits": { + "smithy.api#documentation": "Details for the export revision to Amazon S3 action.
" + } } + }, + "traits": { + "smithy.api#documentation": "What occurs after a certain event.
" } }, "com.amazonaws.dataexchange#Arn": { @@ -92,8 +98,20 @@ "type": "structure", "members": { "S3SnapshotAsset": { - "target": "com.amazonaws.dataexchange#S3SnapshotAsset" + "target": "com.amazonaws.dataexchange#S3SnapshotAsset", + "traits": { + "smithy.api#documentation": "The S3 object that is the asset.
" + } + }, + "RedshiftDataShareAsset": { + "target": "com.amazonaws.dataexchange#RedshiftDataShareAsset", + "traits": { + "smithy.api#documentation": "The Amazon Redshift datashare that is the asset.
" + } } + }, + "traits": { + "smithy.api#documentation": "Information about the asset.
" } }, "com.amazonaws.dataexchange#AssetEntry": { @@ -109,14 +127,14 @@ "AssetDetails": { "target": "com.amazonaws.dataexchange#AssetDetails", "traits": { - "smithy.api#documentation": "Information about the asset, including its size.
", + "smithy.api#documentation": "Information about the asset.
", "smithy.api#required": {} } }, "AssetType": { "target": "com.amazonaws.dataexchange#AssetType", "traits": { - "smithy.api#documentation": "The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
", + "smithy.api#documentation": "The type of asset that is added to a data set.
", "smithy.api#required": {} } }, @@ -170,7 +188,7 @@ } }, "traits": { - "smithy.api#documentation": "An asset in AWS Data Exchange is a piece of data that can be stored as an S3 object. The asset can be a structured data file, an image file, or some other data file. When you create an import job for your files, you create an asset in AWS Data Exchange for each of those files.
" + "smithy.api#documentation": "An asset in AWS Data Exchange is a piece of data. The asset can be a structured data file, an image file, or some other data file that can be stored as an S3 object, or an Amazon Redshift datashare (Preview). When you create an import job for your files, you create an asset in AWS Data Exchange for each of those files.
" } }, "com.amazonaws.dataexchange#AssetName": { @@ -204,11 +222,15 @@ "com.amazonaws.dataexchange#AssetType": { "type": "string", "traits": { - "smithy.api#documentation": "The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
", + "smithy.api#documentation": "The type of asset that is added to a data set.
", "smithy.api#enum": [ { "value": "S3_SNAPSHOT", "name": "S3_SNAPSHOT" + }, + { + "value": "REDSHIFT_DATA_SHARE", + "name": "REDSHIFT_DATA_SHARE" } ] } @@ -238,11 +260,15 @@ "type": "structure", "members": { "Encryption": { - "target": "com.amazonaws.dataexchange#ExportServerSideEncryption" + "target": "com.amazonaws.dataexchange#ExportServerSideEncryption", + "traits": { + "smithy.api#documentation": "Encryption configuration for the auto export job.
" + } }, "RevisionDestination": { "target": "com.amazonaws.dataexchange#AutoExportRevisionDestinationEntry", "traits": { + "smithy.api#documentation": "A revision destination is the Amazon S3 bucket folder destination to where the export will be sent.
", "smithy.api#required": {} } } @@ -399,7 +425,7 @@ "AssetType": { "target": "com.amazonaws.dataexchange#AssetType", "traits": { - "smithy.api#documentation": "The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
", + "smithy.api#documentation": "The type of asset that is added to a data set.
", "smithy.api#required": {} } }, @@ -440,7 +466,7 @@ "AssetType": { "target": "com.amazonaws.dataexchange#AssetType", "traits": { - "smithy.api#documentation": "The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
" + "smithy.api#documentation": "The type of asset that is added to a data set.
" } }, "CreatedAt": { @@ -773,7 +799,7 @@ "Arn": { "target": "com.amazonaws.dataexchange#Arn", "traits": { - "smithy.api#documentation": "The ARN for the revision
" + "smithy.api#documentation": "The ARN for the revision.
" } }, "Comment": { @@ -941,7 +967,7 @@ "AssetType": { "target": "com.amazonaws.dataexchange#AssetType", "traits": { - "smithy.api#documentation": "The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
", + "smithy.api#documentation": "The type of asset that is added to a data set.
", "smithy.api#required": {} } }, @@ -1220,19 +1246,34 @@ "type": "structure", "members": { "ImportAssetFromSignedUrlJobErrorDetails": { - "target": "com.amazonaws.dataexchange#ImportAssetFromSignedUrlJobErrorDetails" + "target": "com.amazonaws.dataexchange#ImportAssetFromSignedUrlJobErrorDetails", + "traits": { + "smithy.api#documentation": "Information about the job error.
" + } }, "ImportAssetsFromS3JobErrorDetails": { - "target": "com.amazonaws.dataexchange#ListOfAssetSourceEntry" + "target": "com.amazonaws.dataexchange#ListOfAssetSourceEntry", + "traits": { + "smithy.api#documentation": "Information about the job error.
" + } } + }, + "traits": { + "smithy.api#documentation": "Information about the job error.
" } }, "com.amazonaws.dataexchange#Event": { "type": "structure", "members": { "RevisionPublished": { - "target": "com.amazonaws.dataexchange#RevisionPublished" + "target": "com.amazonaws.dataexchange#RevisionPublished", + "traits": { + "smithy.api#documentation": "What occurs to start the revision publish action.
" + } } + }, + "traits": { + "smithy.api#documentation": "What occurs to start an action.
" } }, "com.amazonaws.dataexchange#EventActionEntry": { @@ -1248,7 +1289,7 @@ "Arn": { "target": "com.amazonaws.dataexchange#Arn", "traits": { - "smithy.api#documentation": "The ARN for the event action.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the event action.
", "smithy.api#required": {} } }, @@ -1490,6 +1531,12 @@ "smithy.api#documentation": "The destination in Amazon S3 where the revision is exported.
", "smithy.api#required": {} } + }, + "EventActionArn": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the event action.
" + } } }, "traits": { @@ -1589,13 +1636,13 @@ "AssetDetails": { "target": "com.amazonaws.dataexchange#AssetDetails", "traits": { - "smithy.api#documentation": "Information about the asset, including its size.
" + "smithy.api#documentation": "Information about the asset.
" } }, "AssetType": { "target": "com.amazonaws.dataexchange#AssetType", "traits": { - "smithy.api#documentation": "The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
" + "smithy.api#documentation": "The type of asset that is added to a data set.
" } }, "CreatedAt": { @@ -1619,7 +1666,7 @@ "Name": { "target": "com.amazonaws.dataexchange#AssetName", "traits": { - "smithy.api#documentation": "The name of the asset When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
" + "smithy.api#documentation": "The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
" } }, "RevisionId": { @@ -1698,7 +1745,7 @@ "AssetType": { "target": "com.amazonaws.dataexchange#AssetType", "traits": { - "smithy.api#documentation": "The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
" + "smithy.api#documentation": "The type of asset that is added to a data set.
" } }, "CreatedAt": { @@ -1997,7 +2044,7 @@ "Arn": { "target": "com.amazonaws.dataexchange#Arn", "traits": { - "smithy.api#documentation": "The ARN for the revision
" + "smithy.api#documentation": "The ARN for the revision.
" } }, "Comment": { @@ -2062,9 +2109,13 @@ "AssetName": { "target": "com.amazonaws.dataexchange#AssetName", "traits": { + "smithy.api#documentation": "Information about the job error.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Information about the job error.
" } }, "com.amazonaws.dataexchange#ImportAssetFromSignedUrlRequestDetails": { @@ -2109,7 +2160,7 @@ "AssetName": { "target": "com.amazonaws.dataexchange#AssetName", "traits": { - "smithy.api#documentation": "The name for the asset associated with this import response.
", + "smithy.api#documentation": "The name for the asset associated with this import job.
", "smithy.api#required": {} } }, @@ -2150,6 +2201,64 @@ "smithy.api#documentation": "The details in the response for an import request, including the signed URL and other information.
" } }, + "com.amazonaws.dataexchange#ImportAssetsFromRedshiftDataSharesRequestDetails": { + "type": "structure", + "members": { + "AssetSources": { + "target": "com.amazonaws.dataexchange#ListOfRedshiftDataShareAssetSourceEntry", + "traits": { + "smithy.api#documentation": "A list of Amazon Redshift datashare assets.", + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "The unique identifier for the data set associated with this import job.", + "smithy.api#required": {} + } + }, + "RevisionId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "The unique identifier for the revision associated with this import job.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details from an import from Amazon Redshift datashare request." + } + }, + "com.amazonaws.dataexchange#ImportAssetsFromRedshiftDataSharesResponseDetails": { + "type": "structure", + "members": { + "AssetSources": { + "target": "com.amazonaws.dataexchange#ListOfRedshiftDataShareAssetSourceEntry", + "traits": { + "smithy.api#documentation": "A list of Amazon Redshift datashare asset sources.", + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "The unique identifier for the data set associated with this import job.", + "smithy.api#required": {} + } + }, + "RevisionId": { + "target": "com.amazonaws.dataexchange#Id", + "traits": { + "smithy.api#documentation": "The unique identifier for the revision associated with this import job.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Details from an import from Amazon Redshift datashare response." + } + }, "com.amazonaws.dataexchange#ImportAssetsFromS3RequestDetails": { "type": "structure", "members": { @@ -2299,7 +2408,10 @@ } }, "Details": { - "target": "com.amazonaws.dataexchange#Details" + "target": "com.amazonaws.dataexchange#Details", + "traits": { + "smithy.api#documentation": "The details about the job error.
" + } }, "LimitName": { "target": "com.amazonaws.dataexchange#JobErrorLimitName", @@ -2349,6 +2461,10 @@ { "value": "Asset size in GB", "name": "Asset_size_in_GB" + }, + { + "value": "Amazon Redshift datashare assets per revision", + "name": "Amazon_Redshift_datashare_assets_per_revision" } ] } @@ -2409,14 +2525,6 @@ "value": "Asset size in GB", "name": "Asset_size_in_GB" }, - { - "value": "Concurrent in progress jobs to import assets from Amazon S3", - "name": "Concurrent_in_progress_jobs_to_import_assets_from_Amazon_S3" - }, - { - "value": "Concurrent in progress jobs to import assets from a signed URL", - "name": "Concurrent_in_progress_jobs_to_import_assets_from_a_signed_URL" - }, { "value": "Concurrent in progress jobs to export assets to Amazon S3", "name": "Concurrent_in_progress_jobs_to_export_assets_to_Amazon_S3" @@ -2425,6 +2533,14 @@ "value": "Concurrent in progress jobs to export assets to a signed URL", "name": "Concurrent_in_progress_jobs_to_export_assets_to_a_signed_URL" }, + { + "value": "Concurrent in progress jobs to import assets from Amazon S3", + "name": "Concurrent_in_progress_jobs_to_import_assets_from_Amazon_S3" + }, + { + "value": "Concurrent in progress jobs to import assets from a signed URL", + "name": "Concurrent_in_progress_jobs_to_import_assets_from_a_signed_URL" + }, { "value": "Concurrent in progress jobs to export revisions to Amazon S3", "name": "Concurrent_in_progress_jobs_to_export_revisions_to_Amazon_S3" @@ -2436,6 +2552,22 @@ { "value": "Auto export event actions per data set", "name": "Auto_export_event_actions_per_data_set" + }, + { + "value": "Amazon Redshift datashare assets per import job from Redshift", + "name": "Amazon_Redshift_datashare_assets_per_import_job_from_Redshift" + }, + { + "value": "Concurrent in progress jobs to import assets from Amazon Redshift datashares", + "name": "Concurrent_in_progress_jobs_to_import_assets_from_Amazon_Redshift_datashares" + }, + { + "value": "Revisions per Amazon Redshift datashare data set", + "name": "Revisions_per_Amazon_Redshift_datashare_data_set" + }, + { + "value": "Amazon Redshift datashare assets per revision", + "name": "Amazon_Redshift_datashare_assets_per_revision" } ] } @@ -2816,6 +2948,15 @@ "target": "com.amazonaws.dataexchange#JobError" } }, + "com.amazonaws.dataexchange#ListOfRedshiftDataShareAssetSourceEntry": { + "type": "list", + "member": { + "target": "com.amazonaws.dataexchange#RedshiftDataShareAssetSourceEntry" + }, + "traits": { + "smithy.api#documentation": "A list of Amazon Redshift datashare asset sources." + } + }, "com.amazonaws.dataexchange#ListOfRevisionDestinationEntry": { "type": "list", "member": { @@ -3020,9 +3161,43 @@ "ProductId": { "target": "com.amazonaws.dataexchange#__string", "traits": { + "smithy.api#documentation": "The product ID of the origin of the data set.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Information about the origin of the data set.
" + } + }, + "com.amazonaws.dataexchange#RedshiftDataShareAsset": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the datashare asset.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The Amazon Redshift datashare asset." + } + }, + "com.amazonaws.dataexchange#RedshiftDataShareAssetSourceEntry": { + "type": "structure", + "members": { + "DataShareArn": { + "target": "com.amazonaws.dataexchange#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the datashare asset.", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The source of the Amazon Redshift datashare asset.
" } }, "com.amazonaws.dataexchange#RequestDetails": { @@ -3057,6 +3232,12 @@ "traits": { "smithy.api#documentation": "Details about the import from Amazon S3 request.
" } + }, + "ImportAssetsFromRedshiftDataShares": { + "target": "com.amazonaws.dataexchange#ImportAssetsFromRedshiftDataSharesRequestDetails", + "traits": { + "smithy.api#documentation": "Details from an import from Amazon Redshift datashare request.
" + } } }, "traits": { @@ -3151,6 +3332,12 @@ "traits": { "smithy.api#documentation": "Details for the import from Amazon S3 response.
" } + }, + "ImportAssetsFromRedshiftDataShares": { + "target": "com.amazonaws.dataexchange#ImportAssetsFromRedshiftDataSharesResponseDetails", + "traits": { + "smithy.api#documentation": "Details from an import from Amazon Redshift datashare response.
" + } } }, "traits": { @@ -3252,9 +3439,13 @@ "DataSetId": { "target": "com.amazonaws.dataexchange#Id", "traits": { + "smithy.api#documentation": "The data set ID of the published revision.
", "smithy.api#required": {} } } + }, + "traits": { + "smithy.api#documentation": "Information about the published revision.
" } }, "com.amazonaws.dataexchange#S3SnapshotAsset": { @@ -3487,6 +3678,10 @@ { "value": "EXPORT_REVISIONS_TO_S3", "name": "EXPORT_REVISIONS_TO_S3" + }, + { + "value": "IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES", + "name": "IMPORT_ASSETS_FROM_REDSHIFT_DATA_SHARES" } ] } @@ -3614,13 +3809,13 @@ "AssetDetails": { "target": "com.amazonaws.dataexchange#AssetDetails", "traits": { - "smithy.api#documentation": "Information about the asset, including its size.
" + "smithy.api#documentation": "Information about the asset.
" } }, "AssetType": { "target": "com.amazonaws.dataexchange#AssetType", "traits": { - "smithy.api#documentation": "The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
" + "smithy.api#documentation": "The type of asset that is added to a data set.
" } }, "CreatedAt": { @@ -3644,7 +3839,7 @@ "Name": { "target": "com.amazonaws.dataexchange#AssetName", "traits": { - "smithy.api#documentation": "The name of the asset When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
" + "smithy.api#documentation": "The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting to Amazon S3, the asset name is used as default target S3 object key.
" } }, "RevisionId": { @@ -3741,7 +3936,7 @@ "AssetType": { "target": "com.amazonaws.dataexchange#AssetType", "traits": { - "smithy.api#documentation": "The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
" + "smithy.api#documentation": "The type of asset that is added to a data set.
" } }, "CreatedAt": { diff --git a/codegen/sdk/aws-models/directconnect.2012-10-25.json b/codegen/sdk/aws-models/directconnect.2012-10-25.json index 4ed757427c3..09061bdf624 100644 --- a/codegen/sdk/aws-models/directconnect.2012-10-25.json +++ b/codegen/sdk/aws-models/directconnect.2012-10-25.json @@ -72,7 +72,7 @@ "associatedGatewayOwnerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "The ID of the account that owns the virtual private gateway or transit gateway.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the virtual private gateway or transit gateway.
", "smithy.api#required": {} } }, @@ -107,6 +107,21 @@ ] } }, + "com.amazonaws.directconnect#AgreementList": { + "type": "list", + "member": { + "target": "com.amazonaws.directconnect#CustomerAgreement" + } + }, + "com.amazonaws.directconnect#AgreementName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, "com.amazonaws.directconnect#AllocateConnectionOnInterconnect": { "type": "operation", "input": { @@ -148,7 +163,7 @@ "ownerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "The ID of the account of the customer for whom the connection will be provisioned.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account of the customer for whom the connection will be provisioned.
", "smithy.api#required": {} } }, @@ -207,7 +222,7 @@ "ownerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "The ID of the account ID of the customer for the connection.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account ID of the customer for the connection.
", "smithy.api#required": {} } }, @@ -263,7 +278,7 @@ } ], "traits": { - "smithy.api#documentation": "Provisions a private virtual interface to be owned by the specified account.
\nVirtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. \n Until then, the virtual interface is in the Confirming state and is not available to handle traffic.
Provisions a private virtual interface to be owned by the specified Amazon Web Services account.
\nVirtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. \n Until then, the virtual interface is in the Confirming state and is not available to handle traffic.
The ID of the account that owns the virtual private interface.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the virtual private interface.
", "smithy.api#required": {} } }, @@ -315,7 +330,7 @@ } ], "traits": { - "smithy.api#documentation": "Provisions a public virtual interface to be owned by the specified account.
\nThe owner of a connection calls this function to provision a public virtual interface to be owned by the specified account.
\nVirtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface.\n Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.
When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from\n the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.
" + "smithy.api#documentation": "Provisions a public virtual interface to be owned by the specified Amazon Web Services account.
\nThe owner of a connection calls this function to provision a public virtual interface to be owned by the specified Amazon Web Services account.
\nVirtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface.\n Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.
When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from\n the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.
" } }, "com.amazonaws.directconnect#AllocatePublicVirtualInterfaceRequest": { @@ -331,7 +346,7 @@ "ownerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "The ID of the account that owns the public virtual interface.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the public virtual interface.
", "smithy.api#required": {} } }, @@ -367,7 +382,7 @@ } ], "traits": { - "smithy.api#documentation": "Provisions a transit virtual interface to be owned by the specified account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.
\nThe owner of a connection provisions a transit virtual interface to be owned by the specified account.
\nAfter you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.
Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.
\nThe owner of a connection provisions a transit virtual interface to be owned by the specified Amazon Web Services account.
\nAfter you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.
The ID of the account that owns the transit virtual interface.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the transit virtual interface.
", "smithy.api#required": {} } }, @@ -609,7 +624,7 @@ "ownerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "The ID of the account that owns the associated virtual private gateway or transit gateway.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.
" } }, "region": { @@ -840,6 +855,48 @@ } } }, + "com.amazonaws.directconnect#ConfirmCustomerAgreement": { + "type": "operation", + "input": { + "target": "com.amazonaws.directconnect#ConfirmCustomerAgreementRequest" + }, + "output": { + "target": "com.amazonaws.directconnect#ConfirmCustomerAgreementResponse" + }, + "errors": [ + { + "target": "com.amazonaws.directconnect#DirectConnectClientException" + }, + { + "target": "com.amazonaws.directconnect#DirectConnectServerException" + } + ], + "traits": { + "smithy.api#documentation": "\n The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).\n
" + } + }, + "com.amazonaws.directconnect#ConfirmCustomerAgreementRequest": { + "type": "structure", + "members": { + "agreementName": { + "target": "com.amazonaws.directconnect#AgreementName", + "traits": { + "smithy.api#documentation": "\n The name of the customer agreement.\n
" + } + } + } + }, + "com.amazonaws.directconnect#ConfirmCustomerAgreementResponse": { + "type": "structure", + "members": { + "status": { + "target": "com.amazonaws.directconnect#Status", + "traits": { + "smithy.api#documentation": "\n The status of the customer agreement when the connection was created. This will be either signed or unsigned.\n
Accepts ownership of a private virtual interface created by another account.
\nAfter the virtual interface owner makes this call, the virtual interface is\n created and attached to the specified virtual private gateway or Direct Connect gateway, and is\n made available to handle traffic.
" + "smithy.api#documentation": "Accepts ownership of a private virtual interface created by another Amazon Web Services account.
\nAfter the virtual interface owner makes this call, the virtual interface is\n created and attached to the specified virtual private gateway or Direct Connect gateway, and is\n made available to handle traffic.
" } }, "com.amazonaws.directconnect#ConfirmPrivateVirtualInterfaceRequest": { @@ -912,7 +969,7 @@ } ], "traits": { - "smithy.api#documentation": "Accepts ownership of a public virtual interface created by another account.
\nAfter the virtual interface owner makes this call, the specified virtual interface is \n created and made available to handle traffic.
" + "smithy.api#documentation": "Accepts ownership of a public virtual interface created by another Amazon Web Services account.
\nAfter the virtual interface owner makes this call, the specified virtual interface is \n created and made available to handle traffic.
" } }, "com.amazonaws.directconnect#ConfirmPublicVirtualInterfaceRequest": { @@ -955,7 +1012,7 @@ } ], "traits": { - "smithy.api#documentation": "Accepts ownership of a transit virtual interface created by another account.
\n \nAfter the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.
" + "smithy.api#documentation": "Accepts ownership of a transit virtual interface created by another Amazon Web Services account.
\n \nAfter the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.
" } }, "com.amazonaws.directconnect#ConfirmTransitVirtualInterfaceRequest": { @@ -994,7 +1051,7 @@ "ownerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "The ID of the account that owns the connection.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the connection.
" } }, "connectionId": { @@ -1018,7 +1075,7 @@ "region": { "target": "com.amazonaws.directconnect#Region", "traits": { - "smithy.api#documentation": "The Region where the connection is located.
" + "smithy.api#documentation": "The Amazon Web Services Region where the connection is located.
" } }, "location": { @@ -1338,7 +1395,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set \n of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any \n Region after it is created. The virtual interfaces and virtual private gateways that \n are connected through a Direct Connect gateway can be in different Regions. This enables you to\n connect to a VPC in any Region, regardless of the Region in which the virtual interfaces\n are located, and pass traffic between them.
" + "smithy.api#documentation": "Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set \n of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any \n Amazon Web Services Region after it is created. The virtual interfaces and virtual private gateways that \n are connected through a Direct Connect gateway can be in different Amazon Web Services Regions. This enables you to\n connect to a VPC in any Region, regardless of the Region in which the virtual interfaces\n are located, and pass traffic between them.
" } }, "com.amazonaws.directconnect#CreateDirectConnectGatewayAssociation": { @@ -1378,7 +1435,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
\nYou can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any account.
" + "smithy.api#documentation": "Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.
\nYou can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any Amazon Web Services account.
" } }, "com.amazonaws.directconnect#CreateDirectConnectGatewayAssociationProposalRequest": { @@ -1394,7 +1451,7 @@ "directConnectGatewayOwnerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "The ID of the account that owns the Direct Connect gateway.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the Direct Connect gateway.
", "smithy.api#required": {} } }, @@ -1593,7 +1650,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a link aggregation group (LAG) with the specified number of bundled\n physical dedicated connections between the customer network and a specific Direct Connect location.\n A LAG is a logical interface that uses the Link Aggregation Control Protocol\n (LACP) to aggregate multiple interfaces, enabling you to treat them as a single \n interface.
\nAll connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same Direct Connect endpoint.
\nYou can have up to 10 dedicated connections per LAG. Regardless of this limit, if you\n request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is\n created.
\nYou can specify an existing physical dedicated connection or interconnect to include in\n the LAG (which counts towards the total number of connections). Doing so interrupts the\n current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG\n will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any\n virtual interfaces associated with the dedicated connection are automatically disassociated\n and re-associated with the LAG. The connection ID does not change.
\nIf the account used to create a LAG is a registered Direct Connect Partner, the LAG is \n automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual \n interfaces cannot be directly configured.
" + "smithy.api#documentation": "Creates a link aggregation group (LAG) with the specified number of bundled\n physical dedicated connections between the customer network and a specific Direct Connect location.\n A LAG is a logical interface that uses the Link Aggregation Control Protocol\n (LACP) to aggregate multiple interfaces, enabling you to treat them as a single \n interface.
\nAll connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same Direct Connect endpoint.
\nYou can have up to 10 dedicated connections per LAG. Regardless of this limit, if you\n request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is\n created.
\nYou can specify an existing physical dedicated connection or interconnect to include in\n the LAG (which counts towards the total number of connections). Doing so interrupts the\n current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG\n will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any\n virtual interfaces associated with the dedicated connection are automatically disassociated\n and re-associated with the LAG. The connection ID does not change.
\nIf the Amazon Web Services account used to create a LAG is a registered Direct Connect Partner, the LAG is \n automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual \n interfaces cannot be directly configured.
" } }, "com.amazonaws.directconnect#CreateLagRequest": { @@ -1682,7 +1739,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic.\n A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW).\n Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple \n VPCs, including VPCs in different Regions. Connecting the private virtual interface \n to a VGW only provides access to a single VPC within the same Region.
\nSetting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to\n the underlying physical connection if it wasn't updated to support jumbo frames. Updating \n the connection disrupts network connectivity for all virtual interfaces associated with \n the connection for up to 30 seconds. To check whether your connection supports jumbo \n frames, call DescribeConnections. To check whether your virtual \n interface supports jumbo frames, call DescribeVirtualInterfaces.
" + "smithy.api#documentation": "Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic.\n A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW).\n Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple \n VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface \n to a VGW only provides access to a single VPC within the same Region.
\nSetting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to\n the underlying physical connection if it wasn't updated to support jumbo frames. Updating \n the connection disrupts network connectivity for all virtual interfaces associated with \n the connection for up to 30 seconds. To check whether your connection supports jumbo \n frames, call DescribeConnections. To check whether your virtual \n interface supports jumbo frames, call DescribeVirtualInterfaces.
" } }, "com.amazonaws.directconnect#CreatePrivateVirtualInterfaceRequest": { @@ -1805,6 +1862,26 @@ "com.amazonaws.directconnect#CustomerAddress": { "type": "string" }, + "com.amazonaws.directconnect#CustomerAgreement": { + "type": "structure", + "members": { + "agreementName": { + "target": "com.amazonaws.directconnect#AgreementName", + "traits": { + "smithy.api#documentation": "The name of the agreement.
" + } + }, + "status": { + "target": "com.amazonaws.directconnect#Status", + "traits": { + "smithy.api#documentation": "The status of the customer agreement. This will be either signed or unsigned\n
The name and status of a customer agreement.
" + } + }, "com.amazonaws.directconnect#DeleteBGPPeer": { "type": "operation", "input": { @@ -2275,6 +2352,40 @@ } } }, + "com.amazonaws.directconnect#DescribeCustomerMetadata": { + "type": "operation", + "output": { + "target": "com.amazonaws.directconnect#DescribeCustomerMetadataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.directconnect#DirectConnectClientException" + }, + { + "target": "com.amazonaws.directconnect#DirectConnectServerException" + } + ], + "traits": { + "smithy.api#documentation": "Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.
" + } + }, + "com.amazonaws.directconnect#DescribeCustomerMetadataResponse": { + "type": "structure", + "members": { + "agreements": { + "target": "com.amazonaws.directconnect#AgreementList", + "traits": { + "smithy.api#documentation": "The list of customer agreements.
" + } + }, + "nniPartnerType": { + "target": "com.amazonaws.directconnect#NniPartnerType", + "traits": { + "smithy.api#documentation": "The type of network-to-network interface (NNI) partner. The partner type will be one of the following:
\nV1: This partner can only allocate 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps subgigabit connections.
\nV2: This partner can only allocate 1GB, 2GB, 5GB, or 10GB hosted connections.
\nnonPartner: The customer is not a partner.
\nLists the interconnects owned by the account or only the specified interconnect.
" + "smithy.api#documentation": "Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.
" } }, "com.amazonaws.directconnect#DescribeInterconnectsRequest": { @@ -2759,7 +2870,77 @@ } ], "traits": { - "smithy.api#documentation": "Lists the Direct Connect locations in the current Region. These are the locations that can be selected when calling\n CreateConnection or CreateInterconnect.
" + "smithy.api#documentation": "Lists the Direct Connect locations in the current Amazon Web Services Region. These are the locations that can be selected when calling\n CreateConnection or CreateInterconnect.
" + } + }, + "com.amazonaws.directconnect#DescribeRouterConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.directconnect#DescribeRouterConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.directconnect#DescribeRouterConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.directconnect#DirectConnectClientException" + }, + { + "target": "com.amazonaws.directconnect#DirectConnectServerException" + } + ], + "traits": { + "smithy.api#documentation": "\n Details about the router.\n
" + } + }, + "com.amazonaws.directconnect#DescribeRouterConfigurationRequest": { + "type": "structure", + "members": { + "virtualInterfaceId": { + "target": "com.amazonaws.directconnect#VirtualInterfaceId", + "traits": { + "smithy.api#documentation": "The ID of the virtual interface.
", + "smithy.api#required": {} + } + }, + "routerTypeIdentifier": { + "target": "com.amazonaws.directconnect#RouterTypeIdentifier", + "traits": { + "smithy.api#documentation": "Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.
Provides the details about a virtual interface's router.
" + } + }, + "com.amazonaws.directconnect#DescribeRouterConfigurationResponse": { + "type": "structure", + "members": { + "customerRouterConfig": { + "target": "com.amazonaws.directconnect#RouterConfig", + "traits": { + "smithy.api#documentation": "The customer router configuration.
" + } + }, + "router": { + "target": "com.amazonaws.directconnect#RouterType", + "traits": { + "smithy.api#documentation": "The details about the router.
" + } + }, + "virtualInterfaceId": { + "target": "com.amazonaws.directconnect#VirtualInterfaceId", + "traits": { + "smithy.api#documentation": "The ID assigned to the virtual interface.
" + } + }, + "virtualInterfaceName": { + "target": "com.amazonaws.directconnect#VirtualInterfaceName", + "traits": { + "smithy.api#documentation": "The name of the virtual interface assigned by the customer network.
" + } + } } }, "com.amazonaws.directconnect#DescribeTags": { @@ -2819,7 +3000,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the virtual private gateways owned by the account.
\nYou can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.
" + "smithy.api#documentation": "Lists the virtual private gateways owned by the Amazon Web Services account.
\nYou can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.
" } }, "com.amazonaws.directconnect#DescribeVirtualInterfaces": { @@ -2839,7 +3020,7 @@ } ], "traits": { - "smithy.api#documentation": "Displays all virtual interfaces for an account. Virtual interfaces deleted fewer\n than 15 minutes before you make the request are also returned. If you specify a\n connection ID, only the virtual interfaces associated with the connection are returned.\n If you specify a virtual interface ID, then only a single virtual interface is returned.
\nA virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.
" + "smithy.api#documentation": "Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer\n than 15 minutes before you make the request are also returned. If you specify a\n connection ID, only the virtual interfaces associated with the connection are returned.\n If you specify a virtual interface ID, then only a single virtual interface is returned.
\nA virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.
" } }, "com.amazonaws.directconnect#DescribeVirtualInterfacesRequest": { @@ -2895,7 +3076,7 @@ "ownerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "The ID of the account that owns the Direct Connect gateway.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the Direct Connect gateway.
" } }, "directConnectGatewayState": { @@ -2927,7 +3108,7 @@ "directConnectGatewayOwnerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "The ID of the account that owns the associated gateway.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the associated gateway.
" } }, "associationState": { @@ -2969,13 +3150,13 @@ "virtualGatewayRegion": { "target": "com.amazonaws.directconnect#VirtualGatewayRegion", "traits": { - "smithy.api#documentation": "The Region where the virtual private gateway is located.
" + "smithy.api#documentation": "The Amazon Web Services Region where the virtual private gateway is located.
" } }, "virtualGatewayOwnerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "The ID of the account that owns the virtual private gateway.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the virtual private gateway.
" } } }, @@ -3010,7 +3191,7 @@ "directConnectGatewayOwnerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "The ID of the account that owns the Direct Connect gateway.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the Direct Connect gateway.
" } }, "proposalState": { @@ -3115,13 +3296,13 @@ "virtualInterfaceRegion": { "target": "com.amazonaws.directconnect#VirtualInterfaceRegion", "traits": { - "smithy.api#documentation": "The Region where the virtual interface is located.
" + "smithy.api#documentation": "The Amazon Web Services Region where the virtual interface is located.
" } }, "virtualInterfaceOwnerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "The ID of the account that owns the virtual interface.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the virtual interface.
" } }, "attachmentState": { @@ -3422,7 +3603,7 @@ "region": { "target": "com.amazonaws.directconnect#Region", "traits": { - "smithy.api#documentation": "The Region where the connection is located.
" + "smithy.api#documentation": "The Amazon Web Services Region where the connection is located.
" } }, "location": { @@ -3584,7 +3765,7 @@ "ownerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "The ID of the account that owns the LAG.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the LAG.
" } }, "lagName": { @@ -3608,7 +3789,7 @@ "region": { "target": "com.amazonaws.directconnect#Region", "traits": { - "smithy.api#documentation": "The Region where the connection is located.
" + "smithy.api#documentation": "The Amazon Web Services Region where the connection is located.
" } }, "minimumLinks": { @@ -3885,7 +4066,7 @@ "region": { "target": "com.amazonaws.directconnect#Region", "traits": { - "smithy.api#documentation": "The Region for the location.
" + "smithy.api#documentation": "The Amazon Web Services Region for the location.
" } }, "availablePortSpeeds": { @@ -4436,6 +4617,25 @@ "smithy.api#documentation": "Information about a transit virtual interface to be provisioned on a connection.
" } }, + "com.amazonaws.directconnect#NniPartnerType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "v1", + "name": "V1" + }, + { + "value": "v2", + "name": "V2" + }, + { + "value": "nonPartner", + "name": "NonPartner" + } + ] + } + }, "com.amazonaws.directconnect#OvertureService": { "type": "service", "version": "2012-10-25", @@ -4473,6 +4673,9 @@ { "target": "com.amazonaws.directconnect#ConfirmConnection" }, + { + "target": "com.amazonaws.directconnect#ConfirmCustomerAgreement" + }, { "target": "com.amazonaws.directconnect#ConfirmPrivateVirtualInterface" }, @@ -4545,6 +4748,9 @@ { "target": "com.amazonaws.directconnect#DescribeConnectionsOnInterconnect" }, + { + "target": "com.amazonaws.directconnect#DescribeCustomerMetadata" + }, { "target": "com.amazonaws.directconnect#DescribeDirectConnectGatewayAssociationProposals" }, @@ -4575,6 +4781,9 @@ { "target": "com.amazonaws.directconnect#DescribeLocations" }, + { + "target": "com.amazonaws.directconnect#DescribeRouterConfiguration" + }, { "target": "com.amazonaws.directconnect#DescribeTags" }, @@ -4608,6 +4817,9 @@ { "target": "com.amazonaws.directconnect#UpdateConnection" }, + { + "target": "com.amazonaws.directconnect#UpdateDirectConnectGateway" + }, { "target": "com.amazonaws.directconnect#UpdateDirectConnectGatewayAssociation" }, @@ -4630,7 +4842,7 @@ "name": "directconnect" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. \n One end of the cable is connected to your router, the other to an Direct Connect router. With this connection\n in place, you can create virtual interfaces directly to the Cloud (for example, to Amazon EC2 \n and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A \n connection provides access to all Regions except the China (Beijing) and (China) Ningxia Regions. \n Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.
", + "smithy.api#documentation": "Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. \n One end of the cable is connected to your router, the other to an Direct Connect router. With this connection\n in place, you can create virtual interfaces directly to the Amazon Web Services Cloud (for example, to Amazon EC2 \n and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A \n connection provides access to all Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions. \n Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.
", "smithy.api#title": "AWS Direct Connect", "smithy.api#xmlNamespace": { "uri": "http://directconnect.amazonaws.com/doc/2012-10-25/" @@ -4646,6 +4858,9 @@ "com.amazonaws.directconnect#PartnerName": { "type": "string" }, + "com.amazonaws.directconnect#Platform": { + "type": "string" + }, "com.amazonaws.directconnect#PortEncryptionStatus": { "type": "string" }, @@ -4728,9 +4943,59 @@ "com.amazonaws.directconnect#RouterConfig": { "type": "string" }, + "com.amazonaws.directconnect#RouterType": { + "type": "structure", + "members": { + "vendor": { + "target": "com.amazonaws.directconnect#Vendor", + "traits": { + "smithy.api#documentation": "The vendor for the virtual interface's router.
" + } + }, + "platform": { + "target": "com.amazonaws.directconnect#Platform", + "traits": { + "smithy.api#documentation": "The virtual interface router platform.
" + } + }, + "software": { + "target": "com.amazonaws.directconnect#Software", + "traits": { + "smithy.api#documentation": "The router software.
" + } + }, + "xsltTemplateName": { + "target": "com.amazonaws.directconnect#XsltTemplateName", + "traits": { + "smithy.api#documentation": "The template for the virtual interface's router.
" + } + }, + "xsltTemplateNameForMacSec": { + "target": "com.amazonaws.directconnect#XsltTemplateNameForMacSec", + "traits": { + "smithy.api#documentation": "The MAC Security (MACsec) template for the virtual interface's router.
" + } + }, + "routerTypeIdentifier": { + "target": "com.amazonaws.directconnect#RouterTypeIdentifier", + "traits": { + "smithy.api#documentation": "Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.
Information about the virtual router.
" + } + }, + "com.amazonaws.directconnect#RouterTypeIdentifier": { + "type": "string" + }, "com.amazonaws.directconnect#SecretARN": { "type": "string" }, + "com.amazonaws.directconnect#Software": { + "type": "string" + }, "com.amazonaws.directconnect#StartBgpFailoverTest": { "type": "operation", "input": { @@ -4798,6 +5063,15 @@ "com.amazonaws.directconnect#StateChangeError": { "type": "string" }, + "com.amazonaws.directconnect#Status": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, "com.amazonaws.directconnect#StopBgpFailoverTest": { "type": "operation", "input": { @@ -5056,6 +5330,26 @@ } } }, + "com.amazonaws.directconnect#UpdateDirectConnectGateway": { + "type": "operation", + "input": { + "target": "com.amazonaws.directconnect#UpdateDirectConnectGatewayRequest" + }, + "output": { + "target": "com.amazonaws.directconnect#UpdateDirectConnectGatewayResponse" + }, + "errors": [ + { + "target": "com.amazonaws.directconnect#DirectConnectClientException" + }, + { + "target": "com.amazonaws.directconnect#DirectConnectServerException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the name of a current Direct Connect gateway.
" + } + }, "com.amazonaws.directconnect#UpdateDirectConnectGatewayAssociation": { "type": "operation", "input": { @@ -5107,6 +5401,33 @@ } } }, + "com.amazonaws.directconnect#UpdateDirectConnectGatewayRequest": { + "type": "structure", + "members": { + "directConnectGatewayId": { + "target": "com.amazonaws.directconnect#DirectConnectGatewayId", + "traits": { + "smithy.api#documentation": "The ID of the Direct Connect gateway to update.
", + "smithy.api#required": {} + } + }, + "newDirectConnectGatewayName": { + "target": "com.amazonaws.directconnect#DirectConnectGatewayName", + "traits": { + "smithy.api#documentation": "The new name for the Direct Connect gateway.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.directconnect#UpdateDirectConnectGatewayResponse": { + "type": "structure", + "members": { + "directConnectGateway": { + "target": "com.amazonaws.directconnect#DirectConnectGateway" + } + } + }, "com.amazonaws.directconnect#UpdateLag": { "type": "operation", "input": { @@ -5198,6 +5519,9 @@ "com.amazonaws.directconnect#VLAN": { "type": "integer" }, + "com.amazonaws.directconnect#Vendor": { + "type": "string" + }, "com.amazonaws.directconnect#VirtualGateway": { "type": "structure", "members": { @@ -5253,7 +5577,7 @@ "ownerAccount": { "target": "com.amazonaws.directconnect#OwnerAccount", "traits": { - "smithy.api#documentation": "The ID of the account that owns the virtual interface.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account that owns the virtual interface.
" } }, "virtualInterfaceId": { @@ -5379,7 +5703,7 @@ "region": { "target": "com.amazonaws.directconnect#Region", "traits": { - "smithy.api#documentation": "The Region where the virtual interface is located.
" + "smithy.api#documentation": "The Amazon Web Services Region where the virtual interface is located.
" } }, "awsDeviceV2": { @@ -5538,6 +5862,12 @@ } } } + }, + "com.amazonaws.directconnect#XsltTemplateName": { + "type": "string" + }, + "com.amazonaws.directconnect#XsltTemplateNameForMacSec": { + "type": "string" } } } diff --git a/codegen/sdk/aws-models/ec2.2016-11-15.json b/codegen/sdk/aws-models/ec2.2016-11-15.json index 85fe7fad2e7..3c8e1d13c2d 100644 --- a/codegen/sdk/aws-models/ec2.2016-11-15.json +++ b/codegen/sdk/aws-models/ec2.2016-11-15.json @@ -3035,6 +3035,10 @@ { "value": "arm64", "name": "arm64" + }, + { + "value": "x86_64_mac", + "name": "x86_64_mac" } ] } @@ -10154,13 +10158,13 @@ "LogDestinationType": { "target": "com.amazonaws.ec2#LogDestinationType", "traits": { - "smithy.api#documentation": "Specifies the type of destination to which the flow log data is to be published. Flow log data can be \n published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To \n publish flow log data to Amazon S3, specify s3.
If you specify LogDestinationType as s3, do not specify \n DeliverLogsPermissionArn or LogGroupName.
Default: cloud-watch-logs\n
The type of destination to which the flow log data is to be published. Flow log data can be \n published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To \n publish flow log data to Amazon S3, specify s3.
If you specify LogDestinationType as s3, do not specify \n DeliverLogsPermissionArn or LogGroupName.
Default: cloud-watch-logs\n
Specifies the destination to which the flow log data is to be published. Flow log data can be published \n to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified\n for LogDestinationType.
If LogDestinationType is not specified or cloud-watch-logs,\n specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish\n to a log group called my-logs, specify\n arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively,\n use LogGroupName instead.
If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a \n subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: \n bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a \n bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You \n cannot use AWSLogs as a subfolder name. This is a reserved term.
The destination to which the flow log data is to be published. Flow log data can be published \n to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified\n for LogDestinationType.
If LogDestinationType is not specified or cloud-watch-logs,\n specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish\n to a log group called my-logs, specify\n arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively,\n use LogGroupName instead.
If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a \n subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: \n bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a \n bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You \n cannot use AWSLogs as a subfolder name. This is a reserved term.
The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
\nWhen a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds or less, regardless\n of the value that you specify.
\nDefault: 600
" } + }, + "DestinationOptions": { + "target": "com.amazonaws.ec2#DestinationOptionsRequest", + "traits": { + "smithy.api#documentation": "The destination options.
" + } } } }, @@ -21202,7 +21212,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters. Filter names and values are case-sensitive.
\n\n auto-recovery-supported - Indicates whether auto recovery is supported (true | false).
\n bare-metal - Indicates whether it is a bare metal instance type (true | false).
\n burstable-performance-supported - Indicates whether it is a burstable\n performance instance type (true | false).
\n current-generation - Indicates whether this instance type is the latest\n generation instance type of an instance family (true | false).
\n ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline\n bandwidth performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth\n performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-support - Indicates whether the instance type is\n EBS-optimized (supported | unsupported |\n default).
\n ebs-info.encryption-support - Indicates whether EBS encryption is supported\n (supported | unsupported).
\n ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe)\n is supported for EBS volumes (required | supported | unsupported).
\n free-tier-eligible - Indicates whether the instance type is eligible to use\n in the free tier (true | false).
\n hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
\n hypervisor - The hypervisor (nitro | xen).
\n instance-storage-info.disk.count - The number of local disks.
\n instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in\n GB.
\n instance-storage-info.disk.type - The storage technology for the local\n instance storage disks (hdd | ssd).
\n instance-storage-info.nvme-support - Indicates whether non-volatile memory\n express (NVMe) is supported for instance store (required | supported)\n | unsupported).
\n instance-storage-info.total-size-in-gb - The total amount of storage available from all local\n instance storage, in GB.
\n instance-storage-supported - Indicates whether the instance type has local\n instance storage (true | false).
\n instance-type - The instance type (for example c5.2xlarge or\n c5*).
\n memory-info.size-in-mib - The memory size.
\n network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic \n Fabric Adapters (EFAs) per instance.
\n network-info.efa-supported - Indicates whether the instance type supports\n Elastic Fabric Adapter (EFA) (true | false).
\n network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is\n supported or required (required | supported |\n unsupported).
\n network-info.encryption-in-transit-supported - Indicates whether the instance type \n automatically encrypts in-transit traffic between instances (true | false).
\n network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per\n network interface.
\n network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per\n network interface.
\n network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
\n network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
\n network-info.network-performance - The network performance (for example, \"25\n Gigabit\").
\n processor-info.supported-architecture - The CPU architecture\n (arm64 | i386 | x86_64).
\n processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
\n supported-boot-mode - The boot mode (legacy-bios |\n uefi).
\n supported-root-device-type - The root device type (ebs |\n instance-store).
\n supported-usage-class - The usage class (on-demand |\n spot).
\n supported-virtualization-type - The virtualization type (hvm |\n paravirtual).
\n vcpu-info.default-cores - The default number of cores for the instance type.
\n vcpu-info.default-threads-per-core - The default number of threads per core for the instance\n type.
\n vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
\n vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
\n vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type.\n For example, \"1\" or \"1,2\".
One or more filters. Filter names and values are case-sensitive.
\n\n auto-recovery-supported - Indicates whether auto recovery is supported (true | false).
\n bare-metal - Indicates whether it is a bare metal instance type (true | false).
\n burstable-performance-supported - Indicates whether it is a burstable\n performance instance type (true | false).
\n current-generation - Indicates whether this instance type is the latest\n generation instance type of an instance family (true | false).
\n ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline\n bandwidth performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth\n performance for an EBS-optimized instance type, in Mbps.
\n ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage\n operations per second for an EBS-optimized instance type.
\n ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum\n throughput performance for an EBS-optimized instance type, in MB/s.
\n ebs-info.ebs-optimized-support - Indicates whether the instance type is\n EBS-optimized (supported | unsupported |\n default).
\n ebs-info.encryption-support - Indicates whether EBS encryption is supported\n (supported | unsupported).
\n ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe)\n is supported for EBS volumes (required | supported | unsupported).
\n free-tier-eligible - Indicates whether the instance type is eligible to use\n in the free tier (true | false).
\n hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
\n hypervisor - The hypervisor (nitro | xen).
\n instance-storage-info.disk.count - The number of local disks.
\n instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in\n GB.
\n instance-storage-info.disk.type - The storage technology for the local\n instance storage disks (hdd | ssd).
\n instance-storage-info.encryption-supported - Indicates whether data is encrypted at rest \n (required | unsupported).
\n instance-storage-info.nvme-support - Indicates whether non-volatile memory\n express (NVMe) is supported for instance store (required | supported |\n unsupported).
\n instance-storage-info.total-size-in-gb - The total amount of storage available from all local\n instance storage, in GB.
\n instance-storage-supported - Indicates whether the instance type has local\n instance storage (true | false).
\n instance-type - The instance type (for example c5.2xlarge or\n c5*).
\n memory-info.size-in-mib - The memory size.
\n network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic \n Fabric Adapters (EFAs) per instance.
\n network-info.efa-supported - Indicates whether the instance type supports\n Elastic Fabric Adapter (EFA) (true | false).
\n network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is\n supported or required (required | supported |\n unsupported).
\n network-info.encryption-in-transit-supported - Indicates whether the instance type \n automatically encrypts in-transit traffic between instances (true | false).
\n network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per\n network interface.
\n network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per\n network interface.
\n network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
\n network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
\n network-info.network-performance - The network performance (for example, \"25\n Gigabit\").
\n processor-info.supported-architecture - The CPU architecture\n (arm64 | i386 | x86_64).
\n processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
\n supported-boot-mode - The boot mode (legacy-bios |\n uefi).
\n supported-root-device-type - The root device type (ebs |\n instance-store).
\n supported-usage-class - The usage class (on-demand |\n spot).
\n supported-virtualization-type - The virtualization type (hvm |\n paravirtual).
\n vcpu-info.default-cores - The default number of cores for the instance type.
\n vcpu-info.default-threads-per-core - The default number of threads per core for the instance\n type.
\n vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
\n vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
\n vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type.\n For example, \"1\" or \"1,2\".
Contains the output of DescribeVpnGateways.
" } }, + "com.amazonaws.ec2#DestinationFileFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "plain-text", + "name": "plain_text" + }, + { + "value": "parquet", + "name": "parquet" + } + ] + } + }, + "com.amazonaws.ec2#DestinationOptionsRequest": { + "type": "structure", + "members": { + "FileFormat": { + "target": "com.amazonaws.ec2#DestinationFileFormat", + "traits": { + "smithy.api#documentation": "The format for the flow log. The default is plain-text.
Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.\n The default is false.
Indicates whether to partition the flow log per hour. This reduces the cost and response \n time for queries. The default is false.
Describes the destination options for a flow log.
" + } + }, + "com.amazonaws.ec2#DestinationOptionsResponse": { + "type": "structure", + "members": { + "FileFormat": { + "target": "com.amazonaws.ec2#DestinationFileFormat", + "traits": { + "aws.protocols#ec2QueryName": "FileFormat", + "smithy.api#documentation": "The format for the flow log.
", + "smithy.api#xmlName": "fileFormat" + } + }, + "HiveCompatiblePartitions": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "HiveCompatiblePartitions", + "smithy.api#documentation": "Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.
", + "smithy.api#xmlName": "hiveCompatiblePartitions" + } + }, + "PerHourPartition": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "PerHourPartition", + "smithy.api#documentation": "Indicates whether to partition the flow log per hour.
", + "smithy.api#xmlName": "perHourPartition" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the destination options for a flow log.
" + } + }, "com.amazonaws.ec2#DetachClassicLinkVpc": { "type": "operation", "input": { @@ -29727,7 +29810,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the disk.
" + "smithy.api#documentation": "Describes a disk.
" } }, "com.amazonaws.ec2#DiskInfoList": { @@ -33425,7 +33508,7 @@ "target": "com.amazonaws.ec2#LogDestinationType", "traits": { "aws.protocols#ec2QueryName": "LogDestinationType", - "smithy.api#documentation": "Specifies the type of destination to which the flow log data is published. Flow log data can be \n published to CloudWatch Logs or Amazon S3.
", + "smithy.api#documentation": "The type of destination to which the flow log data is published. Flow log data can be \n published to CloudWatch Logs or Amazon S3.
", "smithy.api#xmlName": "logDestinationType" } }, @@ -33433,7 +33516,7 @@ "target": "com.amazonaws.ec2#String", "traits": { "aws.protocols#ec2QueryName": "LogDestination", - "smithy.api#documentation": "Specifies the destination to which the flow log data is published. Flow log data can be\n published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs,\n this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which\n the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN\n of the Amazon S3 bucket to which the data is published.
", + "smithy.api#documentation": "The destination to which the flow log data is published. Flow log data can be\n published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs,\n this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which\n the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN\n of the Amazon S3 bucket to which the data is published.
", "smithy.api#xmlName": "logDestination" } }, @@ -33460,6 +33543,14 @@ "smithy.api#documentation": "The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
\nWhen a network interface is attached to a Nitro-based\n instance, the aggregation interval is always 60 seconds (1 minute) or less,\n regardless of the specified value.
\nValid Values: 60 | 600\n
The destination options.
", + "smithy.api#xmlName": "destinationOptions" + } } }, "traits": { @@ -40868,6 +40959,21 @@ "smithy.api#documentation": "Describes the status of an instance.
" } }, + "com.amazonaws.ec2#InstanceStorageEncryptionSupport": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "unsupported", + "name": "unsupported" + }, + { + "value": "required", + "name": "required" + } + ] + } + }, "com.amazonaws.ec2#InstanceStorageFlag": { "type": "boolean", "traits": { @@ -40897,13 +41003,21 @@ "target": "com.amazonaws.ec2#EphemeralNvmeSupport", "traits": { "aws.protocols#ec2QueryName": "NvmeSupport", - "smithy.api#documentation": "Indicates whether non-volatile memory express (NVMe) is supported for instance store.
", + "smithy.api#documentation": "Indicates whether non-volatile memory express (NVMe) is supported.
", "smithy.api#xmlName": "nvmeSupport" } + }, + "EncryptionSupport": { + "target": "com.amazonaws.ec2#InstanceStorageEncryptionSupport", + "traits": { + "aws.protocols#ec2QueryName": "EncryptionSupport", + "smithy.api#documentation": "Indicates whether data is encrypted at rest.
", + "smithy.api#xmlName": "encryptionSupport" + } } }, "traits": { - "smithy.api#documentation": "Describes the disks that are available for the instance type.
" + "smithy.api#documentation": "Describes the instance store features that are supported by the instance type.
" } }, "com.amazonaws.ec2#InstanceTagKeySet": { @@ -70142,6 +70256,30 @@ "smithy.api#xmlName": "transitGatewayId" } }, + "CoreNetworkArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkArn", + "smithy.api#documentation": "The ARN of the core network.
", + "smithy.api#xmlName": "coreNetworkArn" + } + }, + "CoreNetworkAttachmentArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "CoreNetworkAttachmentArn", + "smithy.api#documentation": "The ARN of the core network attachment.
", + "smithy.api#xmlName": "coreNetworkAttachmentArn" + } + }, + "GatewayAssociationState": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GatewayAssociationState", + "smithy.api#documentation": "The current state of the gateway association.
", + "smithy.api#xmlName": "gatewayAssociationState" + } + }, "Options": { "target": "com.amazonaws.ec2#VpnConnectionOptions", "traits": { diff --git a/codegen/sdk/aws-models/ecs.2014-11-13.json b/codegen/sdk/aws-models/ecs.2014-11-13.json index a1a78a12238..45e3c4ee45d 100644 --- a/codegen/sdk/aws-models/ecs.2014-11-13.json +++ b/codegen/sdk/aws-models/ecs.2014-11-13.json @@ -1947,7 +1947,7 @@ "propagateTags": { "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "smithy.api#documentation": "Specifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttasks in the service. If no value is specified, the tags are not propagated. Tags can\n\t\t\tonly be propagated to the tasks within the service during service creation. To add tags\n\t\t\tto a task after service creation, use the TagResource API\n\t\t\taction.
" + "smithy.api#documentation": "Specifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttasks in the service. If no value is specified, the tags are not propagated. Tags can\n\t\t\tonly be propagated to the tasks within the service during service creation. To add tags\n\t\t\tto a task after service creation or task creation, use the TagResource API\n\t\t\taction.
" } }, "enableExecuteCommand": { @@ -4114,7 +4114,7 @@ } }, "traits": { - "smithy.api#documentation": "Details on a Elastic Inference accelerator. For more information, see Working with\n\t\t\t\tAmazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Details on a Elastic Inference accelerator. For more information, see Working with\n\t\t\t\tAmazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#InferenceAcceleratorOverride": { @@ -4134,7 +4134,7 @@ } }, "traits": { - "smithy.api#documentation": "Details on an Elastic Inference accelerator task override. This parameter is used to\n\t\t\toverride the Elastic Inference accelerator specified in the task definition. For more\n\t\t\tinformation, see Working with Amazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Details on an Elastic Inference accelerator task override. This parameter is used to\n\t\t\toverride the Elastic Inference accelerator specified in the task definition. For more\n\t\t\tinformation, see Working with Amazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#InferenceAcceleratorOverrides": { @@ -6325,7 +6325,7 @@ } }, "traits": { - "smithy.api#documentation": "The type and amount of a resource to assign to a container. The supported resource\n\t\t\ttypes are GPUs and Elastic Inference accelerators. For more information, see Working with\n\t\t\t\tGPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide\n
" + "smithy.api#documentation": "The type and amount of a resource to assign to a container. The supported resource\n\t\t\ttypes are GPUs and Elastic Inference accelerators. For more information, see Working with\n\t\t\t\tGPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide\n
" } }, "com.amazonaws.ecs#ResourceRequirements": { @@ -6498,7 +6498,7 @@ "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run. If a revision is not specified,\n\t\t\tthe latest ACTIVE revision is used.
The family and revision (family:revision) or\n\t\t\tfull ARN of the task definition to run. If a revision is not specified,\n\t\t\tthe latest ACTIVE revision is used.
The full ARN value must match the value that you specified ias the Resource\n\t\t\tof the IAM principal's permissions policy. For example, if the Resource is\n\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the\n\t\t\t\ttaskDefinition ARN value must be\n\t\t\t\tarn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName.
The Amazon Resource Name (ARN) of the task execution IAM role override for the task.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information,\n\t\t\tsee Amazon ECS task\n\t\t\t\texecution IAM role in the Amazon Elastic Container Service Developer Guide.
" } }, "memory": { @@ -8175,7 +8175,7 @@ "taskRoleArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers\n\t\t\tin this task are granted the permissions that are specified in this role.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in\n\t\t\tthis task are granted the permissions that are specified in this role. For more\n\t\t\tinformation, see IAM Role for Tasks\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" } }, "ephemeralStorage": { diff --git a/codegen/sdk/aws-models/efs.2015-02-01.json b/codegen/sdk/aws-models/efs.2015-02-01.json index a85c33726c9..a92be2db5a4 100644 --- a/codegen/sdk/aws-models/efs.2015-02-01.json +++ b/codegen/sdk/aws-models/efs.2015-02-01.json @@ -2004,18 +2004,18 @@ "TransitionToIA": { "target": "com.amazonaws.efs#TransitionToIARules", "traits": { - "smithy.api#documentation": "\n Describes the period of time that a file is not accessed, after which it transitions to the IA storage class. Metadata\n operations such as listing the contents of a directory don't count as file access\n events.
" + "smithy.api#documentation": "\n Describes the period of time that a file is not accessed, after which it transitions to IA storage. Metadata\n operations such as listing the contents of a directory don't count as file access\n events.
" } }, "TransitionToPrimaryStorageClass": { "target": "com.amazonaws.efs#TransitionToPrimaryStorageClassRules", "traits": { - "smithy.api#documentation": "Describes the policy used to transition a file from infequent access storage to primary storage.
" + "smithy.api#documentation": "Describes when to transition a file from IA storage to primary storage. Metadata\n operations such as listing the contents of a directory don't count as file access\n events.
" } } }, "traits": { - "smithy.api#documentation": "Describes a policy used by EFS lifecycle management to transition files to the Infrequent\n Access (IA) storage class.
" + "smithy.api#documentation": "Describes a policy used by EFS lifecycle management and EFS intelligent tiering that specifies when to transition \n files into and out of the file system's Infrequent Access (IA) storage class. For more information, see \n EFS Intelligent‐Tiering and EFS Lifecycle Management.
\nWhen using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, \n Amazon EFS requires that each LifecyclePolicy \n object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as\n an array of LifecyclePolicy objects, one object for each transition, TransitionToIA, \n TransitionToPrimaryStorageClass. For more information, see the request examples in PutLifecycleConfiguration.
Use this operation to set the account preference in the current Amazon Web Services Region to use either long 17 character (63 bit) or short 8 character (32 bit) IDs for \n new EFS file systems and mount targets created. All existing resource IDs are not affected by any changes you make. You can set the ID preference during the\n opt-in period as EFS transitions to long resource IDs. For more information, \n see Managing Amazon EFS resource IDs.
", + "smithy.api#documentation": "Use this operation to set the account preference in the current Amazon Web Services Region to use long 17 character (63 bit) or short 8 character (32 bit) resource IDs for \n new EFS file system and mount target resources. All existing resource IDs are not affected by any changes you make. You can set the ID preference during the\n opt-in period as EFS transitions to long resource IDs. For more information, \n see Managing Amazon EFS resource IDs.
\nStarting in October, 2021, you will receive an error if you try to set the account preference to use the short 8 character format resource ID. \n Contact Amazon Web Services support if you receive an error and need to use short IDs for file system and mount target resources.
\nSpecifies the EFS resource ID preference to set for the user's Amazon Web Services account, in the current Amazon Web Services Region, \n either LONG_ID (17 characters), or SHORT_ID (8 characters).
Specifies the EFS resource ID preference to set for the user's Amazon Web Services account, in the current Amazon Web Services Region, \n either LONG_ID (17 characters), or SHORT_ID (8 characters).
Starting in October, 2021, you will receive an error when setting the account preference to SHORT_ID. \n Contact Amazon Web Services support if you receive an error and need to use short IDs for file system and mount target resources.
Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system. \n A file system policy is an IAM resource-based policy and can contain multiple policy statements. \n A file system always has exactly one file system policy, which can be the default policy or \n an explicit policy set or updated using this API operation.\n EFS file system policies have a 20,000 character limit.\n When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see \n Default EFS File System Policy.\n
EFS file system policies have a 20,000 character limit.
\nThis operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.
Applies an Amazon EFS FileSystemPolicy to an Amazon EFS file system. \n A file system policy is an IAM resource-based policy and can contain multiple policy statements. \n A file system always has exactly one file system policy, which can be the default policy or \n an explicit policy set or updated using this API operation.\n EFS file system policies have a 20,000 character limit.\n When an explicit policy is set, it overrides the default policy. For more information about the default file system policy, see \n Default EFS File System Policy.\n
EFS file system policies have a 20,000 character limit.
\nThis operation requires permissions for the elasticfilesystem:PutFileSystemPolicy action.
Enables lifecycle management by creating a new LifecycleConfiguration\n object. A LifecycleConfiguration object defines when files in an Amazon EFS file\n system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class.\n To enable EFS Intelligent Tiering, set the value of TransitionToPrimaryStorageClass to AFTER_1_ACCESS.\n For more information, see EFS Lifecycle Management.
A LifecycleConfiguration applies to all files in a file system.
Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a\n LifecycleConfiguration object already exists for the specified file system, a\n PutLifecycleConfiguration call modifies the existing configuration. A\n PutLifecycleConfiguration call with an empty LifecyclePolicies\n array in the request body deletes any existing LifecycleConfiguration and\n disables lifecycle management.
In the request, specify the following:
\nThe ID for the file system for which you are enabling, disabling, or modifying lifecycle management.
\nA LifecyclePolicies array of LifecyclePolicy objects that\n define when files are moved to the IA storage class. The array can contain only one\n LifecyclePolicy item.
This operation requires permissions for the\n elasticfilesystem:PutLifecycleConfiguration operation.
To apply a LifecycleConfiguration object to an encrypted file system, you\n need the same Key Management Service permissions as when you created the encrypted\n file system.
Enables lifecycle management by creating a new LifecycleConfiguration\n object. A LifecycleConfiguration object defines when files in an Amazon EFS file\n system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class.\n To enable EFS Intelligent Tiering, set the value of TransitionToPrimaryStorageClass to AFTER_1_ACCESS.\n For more information, see EFS Lifecycle Management.
Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a\n LifecycleConfiguration object already exists for the specified file system, a\n PutLifecycleConfiguration call modifies the existing configuration. A\n PutLifecycleConfiguration call with an empty LifecyclePolicies\n array in the request body deletes any existing LifecycleConfiguration and\n turns off lifecycle management for the file system.
In the request, specify the following:
\nThe ID for the file system for which you are enabling, disabling, or modifying lifecycle management.
\nA LifecyclePolicies array of LifecyclePolicy objects that\n define when files are moved to the IA storage class. Amazon EFS requires that each LifecyclePolicy \n object have only have a single transition, so the LifecyclePolicies array needs to be structured with separate \n LifecyclePolicy objects. See the example requests in the following section for more information.
This operation requires permissions for the\n elasticfilesystem:PutLifecycleConfiguration operation.
To apply a LifecycleConfiguration object to an encrypted file system, you\n need the same Key Management Service permissions as when you created the encrypted\n file system.
An array of LifecyclePolicy objects that define the file system's\n LifecycleConfiguration object. A LifecycleConfiguration object\n tells lifecycle management when to transition files from the Standard storage class to the\n Infrequent Access storage class.
An array of LifecyclePolicy objects that define the file system's\n LifecycleConfiguration object. A LifecycleConfiguration object\n informs EFS lifecycle management and intelligent tiering of the following:
When to move files in the file system from primary storage to the IA storage class.
\nWhen to move files that are in IA storage to primary storage.
\nWhen using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, \n Amazon EFS requires that each LifecyclePolicy \n object have only a single transition. This means that in a request body, LifecyclePolicies needs to be structured as\n an array of LifecyclePolicy objects, one object for each transition, TransitionToIA, TransitionToPrimaryStorageClass. \n See the example requests in the following section for more information.
The maximum number of results to return with this call.
" } + }, + "LoadBalancerType": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerTypeEnum", + "traits": { + "smithy.api#documentation": "The type of load balancer. The default lists the SSL policies for all load\n balancers.
" + } } } }, @@ -4433,6 +4439,12 @@ "traits": { "smithy.api#documentation": "The name of the policy.
" } + }, + "SupportedLoadBalancerTypes": { + "target": "com.amazonaws.elasticloadbalancingv2#ListOfString", + "traits": { + "smithy.api#documentation": "\n The supported load balancers.\n
" + } } }, "traits": { diff --git a/codegen/sdk/aws-models/emrcontainers.2020-10-01.json b/codegen/sdk/aws-models/emrcontainers.2020-10-01.json index 5a6baef6e02..1ed30a44ccb 100644 --- a/codegen/sdk/aws-models/emrcontainers.2020-10-01.json +++ b/codegen/sdk/aws-models/emrcontainers.2020-10-01.json @@ -105,6 +105,16 @@ "smithy.api#title": "Amazon EMR Containers" } }, + "com.amazonaws.emrcontainers#Base64Encoded": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5000 + }, + "smithy.api#pattern": "^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{4}|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$" + } + }, "com.amazonaws.emrcontainers#CancelJobRun": { "type": "operation", "input": { @@ -168,6 +178,26 @@ } } }, + "com.amazonaws.emrcontainers#Certificate": { + "type": "structure", + "members": { + "certificateArn": { + "target": "com.amazonaws.emrcontainers#ACMCertArn", + "traits": { + "smithy.api#documentation": "The ARN of the certificate generated for managed endpoint.
" + } + }, + "certificateData": { + "target": "com.amazonaws.emrcontainers#Base64Encoded", + "traits": { + "smithy.api#documentation": "The base64 encoded PEM certificate data generated for managed endpoint.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The entity representing certificate data generated for managed endpoint.
" + } + }, "com.amazonaws.emrcontainers#ClientToken": { "type": "string", "traits": { @@ -391,8 +421,10 @@ "certificateArn": { "target": "com.amazonaws.emrcontainers#ACMCertArn", "traits": { - "smithy.api#documentation": "The certificate ARN of the managed endpoint.
", - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "Customer provided certificate-arn is deprecated and would be removed in future." + }, + "smithy.api#documentation": "The certificate ARN provided by users for the managed endpoint. This fiedd is under deprecation and will be removed in future releases.
" } }, "configurationOverrides": { @@ -885,7 +917,16 @@ "certificateArn": { "target": "com.amazonaws.emrcontainers#ACMCertArn", "traits": { - "smithy.api#documentation": "The certificate ARN of the endpoint.
" + "smithy.api#deprecated": { + "message": "Customer provided certificate-arn is deprecated and would be removed in future." + }, + "smithy.api#documentation": "The certificate ARN of the endpoint. This field is under deprecation and will be removed in future.
" + } + }, + "certificateAuthority": { + "target": "com.amazonaws.emrcontainers#Certificate", + "traits": { + "smithy.api#documentation": "The certificate generated by emr control plane on customer behalf to secure the managed endpoint.
" } }, "configurationOverrides": { diff --git a/codegen/sdk/aws-models/glue.2017-03-31.json b/codegen/sdk/aws-models/glue.2017-03-31.json index 1891f9e9415..7813ff1bf12 100644 --- a/codegen/sdk/aws-models/glue.2017-03-31.json +++ b/codegen/sdk/aws-models/glue.2017-03-31.json @@ -7834,6 +7834,9 @@ "smithy.api#documentation": "Batch condition that must be met (specified number of events received or batch time window expired)\n before EventBridge event trigger fires.
" } }, + "com.amazonaws.glue#EventQueueArn": { + "type": "string" + }, "com.amazonaws.glue#ExecutionProperty": { "type": "structure", "members": { @@ -15579,6 +15582,10 @@ { "value": "CRAWL_NEW_FOLDERS_ONLY", "name": "CRAWL_NEW_FOLDERS_ONLY" + }, + { + "value": "CRAWL_EVENT_MODE", + "name": "CRAWL_EVENT_MODE" } ] } @@ -15589,7 +15596,7 @@ "RecrawlBehavior": { "target": "com.amazonaws.glue#RecrawlBehavior", "traits": { - "smithy.api#documentation": "Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
\n\t\n\tA value of CRAWL_EVERYTHING specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
\n\t\n\tA value of CRAWL_EVERYTHING specifies crawling the entire dataset again.
A value of CRAWL_NEW_FOLDERS_ONLY specifies crawling only folders that were added since the last crawler run.
A value of CRAWL_EVENT_MODE specifies crawling only the changes identified by Amazon S3 events.
Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. If not set, all the files are crawled. A valid value is an integer between 1 and 249.
" } + }, + "EventQueueArn": { + "target": "com.amazonaws.glue#EventQueueArn", + "traits": { + "smithy.api#documentation": "A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.
A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.
\n Introduction\n
\n\nThe Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP\n API and an AWS EventBridge event stream for responses. JSON is used for both requests and\n responses, including errors.
\n\nThe API is an AWS regional service, currently in these regions: us-west-2, us-east-1, and\n eu-west-1.
\n\n \n All API request parameters and URLs are case sensitive.\n \n \n
\n\nFor a summary of notable documentation changes in each release, see Document\n History.
\n\n\n Service Endpoints\n
\nThe following are the Amazon IVS service endpoints (all HTTPS):
\nRegion name: US West (Oregon)
\nRegion: us-west-2\n
Endpoint: ivs.us-west-2.amazonaws.com\n
Region name: US East (Virginia)
\nRegion: us-east-1\n
Endpoint: ivs.us-east-1.amazonaws.com\n
Region name: EU West (Dublin)
\nRegion: eu-west-1\n
Endpoint: ivs.eu-west-1.amazonaws.com\n
\n Allowed Header Values\n
\n\n\n \n Accept:\n application/json
\n \n Accept-Encoding:\n gzip, deflate
\n \n Content-Type:\n application/json
\n Resources\n
\nThe following resources contain information about your IVS live stream (see Getting Started with Amazon\n IVS):
\n\nChannel — Stores configuration data related to your live stream. You first create a\n channel and then use the channel’s stream key to start your live stream. See the Channel\n endpoints for more information.
\nStream key — An identifier assigned by Amazon IVS when you create a channel, which is\n then used to authorize streaming. See the StreamKey endpoints for more information.\n \n Treat the stream key like a secret, since it allows\n anyone to stream to the channel.\n \n
\nPlayback key pair — Video playback may be restricted using playback-authorization\n tokens, which use public-key encryption. A playback key pair is the public-private pair of\n keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair\n endpoints for more information.
\nRecording configuration — Stores configuration related to recording a live stream and\n where to store the recorded content. Multiple channels can reference the same recording\n configuration. See the Recording Configuration endpoints for more information.
\n\n Tagging\n
\n\nA tag is a metadata label that you assign to an AWS resource. A tag\n comprises a key and a value, both set by you. For\n example, you might set a tag as topic:nature to label a particular video\n category. See Tagging AWS\n Resources for more information, including restrictions that apply to tags.
Tags can help you identify and organize your AWS resources. For example, you can use the\n same tag for different resources to indicate that they are related. You can also use tags to\n manage access (see \n Access Tags).
\n\nThe Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following\n resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording\n Configurations.
\n\n\n Authentication versus Authorization\n
\nNote the differences between these concepts:
\n\n Authentication is about verifying identity. You need to be authenticated to sign Amazon IVS\n API requests.
\n\n Authorization is about granting permissions. You need to be authorized to\n view Amazon IVS private channels. (Private channels are channels that are enabled for\n \"playback authorization.\")
\n\n Authentication\n
\nAll Amazon IVS API requests must be authenticated with a signature. The AWS Command-Line\n Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for\n you. However, if your application calls the Amazon IVS API directly, it’s your responsibility\n to sign the requests.
\nYou generate a signature using valid AWS credentials that have permission to perform the\n requested action. For example, you must sign PutMetadata requests with a signature generated\n from an IAM user account that has the ivs:PutMetadata permission.
For more information:
\nAuthentication and generating signatures — See Authenticating Requests (AWS Signature Version\n 4) in the AWS General Reference.
\nManaging Amazon IVS permissions — See Identity and Access Management on the Security page of\n the Amazon IVS User Guide.
\n\n Channel Endpoints\n
\n\n CreateChannel — Creates a new channel and an associated stream\n key to start streaming.
\n\n GetChannel — Gets the channel configuration for the specified\n channel ARN (Amazon Resource Name).
\n\n BatchGetChannel — Performs GetChannel on\n multiple ARNs simultaneously.
\n\n ListChannels — Gets summary information about all channels in\n your account, in the AWS region where the API request is processed. This list can be\n filtered to match a specified name or recording-configuration ARN. Filters are mutually\n exclusive and cannot be used together. If you try to use both filters, you will get an\n error (409 Conflict Exception).
\n\n UpdateChannel — Updates a channel's configuration. This does\n not affect an ongoing stream of this channel. You must stop and restart the stream for the\n changes to take effect.
\n\n DeleteChannel — Deletes the specified channel.
\n\n StreamKey Endpoints\n
\n\n CreateStreamKey — Creates a stream key, used to initiate a\n stream, for the specified channel ARN.
\n\n GetStreamKey — Gets stream key information for the specified\n ARN.
\n\n BatchGetStreamKey — Performs GetStreamKey on\n multiple ARNs simultaneously.
\n\n ListStreamKeys — Gets summary information about stream keys\n for the specified channel.
\n\n DeleteStreamKey — Deletes the stream key for the specified\n ARN, so it can no longer be used to stream.
\n\n Stream Endpoints\n
\n\n GetStream — Gets information about the active (live) stream on\n a specified channel.
\n\n ListStreams — Gets summary information about live streams in\n your account, in the AWS region where the API request is processed.
\n\n StopStream — Disconnects the incoming RTMPS stream for the\n specified channel. Can be used in conjunction with DeleteStreamKey to\n prevent further streaming to a channel.
\n\n PutMetadata — Inserts metadata into the active stream of the\n specified channel. A maximum of 5 requests per second per channel is allowed, each with a\n maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching\n your data into a single PutMetadata call.)
\n\n PlaybackKeyPair Endpoints\n
\nFor more information, see Setting Up Private Channels in the\n Amazon IVS User Guide.
\n\n ImportPlaybackKeyPair — Imports the public portion of a new\n key pair and returns its arn and fingerprint. The\n privateKey can then be used to generate viewer authorization tokens, to\n grant viewers access to private channels (channels enabled for playback\n authorization).
\n GetPlaybackKeyPair — Gets a specified playback authorization\n key pair and returns the arn and fingerprint. The\n privateKey held by the caller can be used to generate viewer authorization\n tokens, to grant viewers access to private channels.
\n ListPlaybackKeyPairs — Gets summary information about playback\n key pairs.
\n\n DeletePlaybackKeyPair — Deletes a specified authorization key\n pair. This invalidates future viewer tokens generated using the key pair’s\n privateKey.
\n RecordingConfiguration Endpoints\n
\n\n CreateRecordingConfiguration — Creates a new recording configuration,\n used to enable recording to Amazon S3.
\n\n GetRecordingConfiguration — Gets the recording-configuration metadata\n for the specified ARN.
\n\n ListRecordingConfigurations — Gets summary information about all\n recording configurations in your account, in the AWS region where the API request is\n processed.
\n\n DeleteRecordingConfiguration — Deletes the recording\n configuration for the specified ARN.
\n\n AWS Tags Endpoints\n
\n\n TagResource — Adds or updates tags for the AWS resource with\n the specified ARN.
\n\n UntagResource — Removes tags from the resource with the\n specified ARN.
\n\n ListTagsForResource — Gets information about AWS tags for the\n specified ARN.
\n\n Introduction\n
\nThe Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP\n API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both\n requests and responses, including errors.
\nThe API is an Amazon Web Services regional service. For a list of supported regions and\n Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the\n Amazon Web Services General Reference.
\n\n \n All API request parameters and URLs are case sensitive.\n \n \n
\nFor a summary of notable documentation changes in each release, see Document\n History.
\n\n\n Allowed Header Values\n
\n\n \n Accept:\n application/json
\n \n Accept-Encoding:\n gzip, deflate
\n \n Content-Type:\n application/json
\n Resources\n
\nThe following resources contain information about your IVS live stream (see Getting Started with\n Amazon IVS):
\nChannel — Stores configuration data related to your live stream. You first create a\n channel and then use the channel’s stream key to start your live stream. See the Channel\n endpoints for more information.
\nStream key — An identifier assigned by Amazon IVS when you create a channel, which is\n then used to authorize streaming. See the StreamKey endpoints for more information.\n \n Treat the stream key like a secret, since it allows\n anyone to stream to the channel.\n \n
\nPlayback key pair — Video playback may be restricted using playback-authorization\n tokens, which use public-key encryption. A playback key pair is the public-private pair of\n keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair\n endpoints for more information.
\nRecording configuration — Stores configuration related to recording a live stream and\n where to store the recorded content. Multiple channels can reference the same recording\n configuration. See the Recording Configuration endpoints for more information.
\n\n Tagging\n
\nA tag is a metadata label that you assign to an Amazon Web Services\n resource. A tag comprises a key and a value, both\n set by you. For example, you might set a tag as topic:nature to label a\n particular video category. See Tagging Amazon Web Services Resources for\n more information, including restrictions that apply to tags.
Tags can help you identify and organize your Amazon Web Services resources. For example,\n you can use the same tag for different resources to indicate that they are related. You can\n also use tags to manage access (see Access Tags).
\nThe Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following\n resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording\n Configurations.
\nAt most 50 tags can be applied to a resource.
\n\n Authentication versus Authorization\n
\nNote the differences between these concepts:
\n\n Authentication is about verifying identity. You need to be\n authenticated to sign Amazon IVS API requests.
\n\n Authorization is about granting permissions. You need to be\n authorized to view Amazon IVS private channels.\n (Private channels are channels that are enabled for \"playback authorization.\")
\n\n Authentication\n
\nAll Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services\n Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying\n API calls for you. However, if your application calls the Amazon IVS API directly, it’s your\n responsibility to sign the requests.
\nYou generate a signature using valid Amazon Web Services credentials that have permission\n to perform the requested action. For example, you must sign PutMetadata requests with a\n signature generated from an IAM user account that has the ivs:PutMetadata\n permission.
For more information:
\nAuthentication and generating signatures — See Authenticating Requests\n (Amazon Web Services Signature Version 4) in the Amazon Web Services\n General Reference.
\nManaging Amazon IVS permissions — See Identity and Access Management on\n the Security page of the Amazon IVS User Guide.
\n\n Channel Endpoints\n
\n\n CreateChannel — Creates a new channel and an associated stream\n key to start streaming.
\n\n GetChannel — Gets the channel configuration for the specified\n channel ARN (Amazon Resource Name).
\n\n BatchGetChannel — Performs GetChannel on\n multiple ARNs simultaneously.
\n\n ListChannels — Gets summary information about all channels in\n your account, in the Amazon Web Services region where the API request is processed. This\n list can be filtered to match a specified name or recording-configuration ARN. Filters are\n mutually exclusive and cannot be used together. If you try to use both filters, you will\n get an error (409 Conflict Exception).
\n\n UpdateChannel — Updates a channel's configuration. This does\n not affect an ongoing stream of this channel. You must stop and restart the stream for the\n changes to take effect.
\n\n DeleteChannel — Deletes the specified channel.
\n\n StreamKey Endpoints\n
\n\n CreateStreamKey — Creates a stream key, used to initiate a\n stream, for the specified channel ARN.
\n\n GetStreamKey — Gets stream key information for the specified\n ARN.
\n\n BatchGetStreamKey — Performs GetStreamKey on\n multiple ARNs simultaneously.
\n\n ListStreamKeys — Gets summary information about stream keys\n for the specified channel.
\n\n DeleteStreamKey — Deletes the stream key for the specified\n ARN, so it can no longer be used to stream.
\n\n Stream Endpoints\n
\n\n GetStream — Gets information about the active (live) stream on\n a specified channel.
\n\n ListStreams — Gets summary information about live streams in\n your account, in the Amazon Web Services region where the API request is processed.
\n\n StopStream — Disconnects the incoming RTMPS stream for the\n specified channel. Can be used in conjunction with DeleteStreamKey to\n prevent further streaming to a channel.
\n\n PutMetadata — Inserts metadata into the active stream of the\n specified channel. At most 5 requests per second per channel are allowed, each with a\n maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching\n your data into a single PutMetadata call.) At most 155 requests per second per account are\n allowed.
\n\n PlaybackKeyPair Endpoints\n
\nFor more information, see Setting Up Private Channels in the\n Amazon IVS User Guide.
\n\n ImportPlaybackKeyPair — Imports the public portion of a new\n key pair and returns its arn and fingerprint. The\n privateKey can then be used to generate viewer authorization tokens, to\n grant viewers access to private channels (channels enabled for playback\n authorization).
\n GetPlaybackKeyPair — Gets a specified playback authorization\n key pair and returns the arn and fingerprint. The\n privateKey held by the caller can be used to generate viewer authorization\n tokens, to grant viewers access to private channels.
\n ListPlaybackKeyPairs — Gets summary information about playback\n key pairs.
\n\n DeletePlaybackKeyPair — Deletes a specified authorization key\n pair. This invalidates future viewer tokens generated using the key pair’s\n privateKey.
\n RecordingConfiguration Endpoints\n
\n\n CreateRecordingConfiguration — Creates a new recording\n configuration, used to enable recording to Amazon S3.
\n\n GetRecordingConfiguration — Gets the recording-configuration\n metadata for the specified ARN.
\n\n ListRecordingConfigurations — Gets summary information about\n all recording configurations in your account, in the Amazon Web Services region where the\n API request is processed.
\n\n DeleteRecordingConfiguration — Deletes the recording\n configuration for the specified ARN.
\n\n Amazon Web Services Tags Endpoints\n
\n\n TagResource — Adds or updates tags for the Amazon Web Services\n resource with the specified ARN.
\n\n UntagResource — Removes tags from the resource with the\n specified ARN.
\n\n ListTagsForResource — Gets information about Amazon Web Services tags for the specified ARN.
\nChannel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS console, LOW and\n NORMAL correspond to Ultra-low and Standard, respectively.)
Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. Default:\n LOW. (Note: In the Amazon IVS console, LOW and NORMAL\n correspond to Ultra-low and Standard, respectively.)
Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Default: STANDARD. Valid values:
\n STANDARD: Multiple qualities are generated from the original input, to\n automatically give viewers the best experience for their devices and network conditions.\n Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
\n BASIC: Amazon IVS delivers the original input to viewers. The viewer’s\n video-quality choice is limited to the original input. Vertical resolution can be up to\n 480 and bitrate can be up to 1.5 Mbps.
Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Default: STANDARD. Valid values:
\n STANDARD: Multiple qualities are generated from the original input, to\n automatically give viewers the best experience for their devices and network conditions.\n Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only\n for renditions 360p and below; above that, audio is passed through.
\n BASIC: Amazon IVS delivers the original input to viewers. The viewer’s\n video-quality choice is limited to the original input. Resolution can be up to 480p and\n bitrate can be up to 1.5 Mbps.
Channel latency mode. Use NORMAL to broadcast and deliver live video up to Full HD. Use\n LOW for near-real-time interaction with viewers. Default: LOW. (Note: In the Amazon IVS\n console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)
Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. Default:\n LOW. (Note: In the Amazon IVS console, LOW and NORMAL\n correspond to Ultra-low and Standard, respectively.)
Whether the channel is private (enabled for playback authorization). Default: false.
Whether the channel is private (enabled for playback authorization). Default:\n false.
Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the\n Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard, respectively.)\n Default: LOW.
Channel latency mode. Use NORMAL to broadcast and deliver live video up to\n Full HD. Use LOW for near-real-time interaction with viewers. (Note: In the\n Amazon IVS console, LOW and NORMAL correspond to Ultra-low and Standard,\n respectively.) Default: LOW.
Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Default: STANDARD. Valid values:
\n STANDARD: Multiple qualities are generated from the original input, to\n automatically give viewers the best experience for their devices and network conditions.\n Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
\n BASIC: Amazon IVS delivers the original input to viewers. The viewer’s\n video-quality choice is limited to the original input. Vertical resolution can be up to\n 480 and bitrate can be up to 1.5 Mbps.
Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Default: STANDARD. Valid values:
\n STANDARD: Multiple qualities are generated from the original input, to\n automatically give viewers the best experience for their devices and network conditions.\n Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only\n for renditions 360p and below; above that, audio is passed through.
\n BASIC: Amazon IVS delivers the original input to viewers. The viewer’s\n video-quality choice is limited to the original input. Resolution can be up to 480p and\n bitrate can be up to 1.5 Mbps.
Creates a new recording configuration, used to enable recording to Amazon S3.
\n\n Known issue: In the us-east-1 region, if you use the AWS\n CLI to create a recording configuration, it returns success even if the S3 bucket is in a\n different region. In this case, the state of the recording configuration is\n CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI\n correctly returns failure if the bucket is in a different region.)
\n Workaround: Ensure that your S3 bucket is in the same region as the recording\n configuration. If you create a recording configuration in a different region as your S3\n bucket, delete that recording configuration and create a new one with an S3 bucket from the\n correct region.
", + "smithy.api#documentation": "Creates a new recording configuration, used to enable recording to Amazon S3.
\n\n Known issue: In the us-east-1 region, if you use the Amazon Web Services\n CLI to create a recording configuration, it returns success even if the S3 bucket is in a\n different region. In this case, the state of the recording configuration is\n CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI\n correctly returns failure if the bucket is in a different region.)
\n Workaround: Ensure that your S3 bucket is in the same region as the recording\n configuration. If you create a recording configuration in a different region as your S3\n bucket, delete that recording configuration and create a new one with an S3 bucket from the\n correct region.
", "smithy.api#http": { "method": "POST", "uri": "/CreateRecordingConfiguration", @@ -610,7 +620,7 @@ "name": { "target": "com.amazonaws.ivs#RecordingConfigurationName", "traits": { - "smithy.api#documentation": "An arbitrary string (a nickname) that helps the customer identify that resource. The value\n does not need to be unique.
" + "smithy.api#documentation": "Recording-configuration name. The value does not need to be unique.
" } }, "destinationConfiguration": { @@ -632,7 +642,10 @@ "type": "structure", "members": { "recordingConfiguration": { - "target": "com.amazonaws.ivs#RecordingConfiguration" + "target": "com.amazonaws.ivs#RecordingConfiguration", + "traits": { + "smithy.api#documentation": "" + } } } }, @@ -911,7 +924,8 @@ "method": "POST", "uri": "/GetChannel", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.ivs#GetChannelRequest": { @@ -930,7 +944,10 @@ "type": "structure", "members": { "channel": { - "target": "com.amazonaws.ivs#Channel" + "target": "com.amazonaws.ivs#Channel", + "traits": { + "smithy.api#documentation": "" + } } } }, @@ -959,7 +976,8 @@ "method": "POST", "uri": "/GetPlaybackKeyPair", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.ivs#GetPlaybackKeyPairRequest": { @@ -978,7 +996,10 @@ "type": "structure", "members": { "keyPair": { - "target": "com.amazonaws.ivs#PlaybackKeyPair" + "target": "com.amazonaws.ivs#PlaybackKeyPair", + "traits": { + "smithy.api#documentation": "" + } } } }, @@ -1010,7 +1031,8 @@ "method": "POST", "uri": "/GetRecordingConfiguration", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.ivs#GetRecordingConfigurationRequest": { @@ -1029,7 +1051,10 @@ "type": "structure", "members": { "recordingConfiguration": { - "target": "com.amazonaws.ivs#RecordingConfiguration" + "target": "com.amazonaws.ivs#RecordingConfiguration", + "traits": { + "smithy.api#documentation": "" + } } } }, @@ -1061,7 +1086,8 @@ "method": "POST", "uri": "/GetStream", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.ivs#GetStreamKey": { @@ -1089,7 +1115,8 @@ "method": "POST", "uri": "/GetStreamKey", "code": 200 - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.ivs#GetStreamKeyRequest": { @@ -1108,7 +1135,10 @@ "type": "structure", "members": { "streamKey": { - "target": "com.amazonaws.ivs#StreamKey" + "target": "com.amazonaws.ivs#StreamKey", + "traits": { + "smithy.api#documentation": "" + } } } }, @@ -1128,7 +1158,10 @@ "type": "structure", "members": { "stream": { - "target": "com.amazonaws.ivs#Stream" + "target": "com.amazonaws.ivs#Stream", + "traits": { + "smithy.api#documentation": "" + } } } }, @@ -1179,7 +1212,7 @@ "name": { "target": "com.amazonaws.ivs#PlaybackKeyPairName", "traits": { - "smithy.api#documentation": "An arbitrary string (a nickname) assigned to a playback key pair that helps the customer\n identify that resource. The value does not need to be unique.
" + "smithy.api#documentation": "Playback-key-pair name. The value does not need to be unique.
" } }, "tags": { @@ -1194,7 +1227,10 @@ "type": "structure", "members": { "keyPair": { - "target": "com.amazonaws.ivs#PlaybackKeyPair" + "target": "com.amazonaws.ivs#PlaybackKeyPair", + "traits": { + "smithy.api#documentation": "" + } } } }, @@ -1212,6 +1248,7 @@ } }, "traits": { + "smithy.api#documentation": "", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -1239,7 +1276,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets summary information about all channels in your account, in the AWS region where the\n API request is processed. This list can be filtered to match a specified name or\n recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If\n you try to use both filters, you will get an error (409 ConflictException).
", + "smithy.api#documentation": "Gets summary information about all channels in your account, in the Amazon Web Services region where the\n API request is processed. This list can be filtered to match a specified name or\n recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If\n you try to use both filters, you will get an error (409 ConflictException).
", "smithy.api#http": { "method": "POST", "uri": "/ListChannels", @@ -1249,7 +1286,8 @@ "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.ivs#ListChannelsRequest": { @@ -1326,7 +1364,8 @@ "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.ivs#ListPlaybackKeyPairsRequest": { @@ -1384,7 +1423,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets summary information about all recording configurations in your account, in the AWS\n region where the API request is processed.
", + "smithy.api#documentation": "Gets summary information about all recording configurations in your account, in the Amazon Web Services\n region where the API request is processed.
", "smithy.api#http": { "method": "POST", "uri": "/ListRecordingConfigurations", @@ -1394,7 +1433,8 @@ "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.ivs#ListRecordingConfigurationsRequest": { @@ -1462,7 +1502,8 @@ "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.ivs#ListStreamKeysRequest": { @@ -1521,7 +1562,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets summary information about live streams in your account, in the AWS region where the\n API request is processed.
", + "smithy.api#documentation": "Gets summary information about live streams in your account, in the Amazon Web Services region where the\n API request is processed.
", "smithy.api#http": { "method": "POST", "uri": "/ListStreams", @@ -1531,7 +1572,8 @@ "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.ivs#ListStreamsRequest": { @@ -1589,17 +1631,13 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about AWS tags for the specified ARN.
", + "smithy.api#documentation": "Gets information about Amazon Web Services tags for the specified ARN.
", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", "code": 200 }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } + "smithy.api#readonly": {} } }, "com.amazonaws.ivs#ListTagsForResourceRequest": { @@ -1612,18 +1650,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.ivs#String", - "traits": { - "smithy.api#documentation": "The first tag to retrieve. This is used for pagination; see the nextToken\n response field.
Maximum number of tags to return. Default: 50.
" - } } } }, @@ -1633,14 +1659,9 @@ "tags": { "target": "com.amazonaws.ivs#Tags", "traits": { + "smithy.api#documentation": "", "smithy.api#required": {} } - }, - "nextToken": { - "target": "com.amazonaws.ivs#String", - "traits": { - "smithy.api#documentation": "If there are more tags than maxResults, use nextToken in the\n request to get the next set.
An arbitrary string (a nickname) assigned to a playback key pair that helps the customer\n identify that resource. The value does not need to be unique.
" + "smithy.api#documentation": "Playback-key-pair name. The value does not need to be unique.
" } }, "fingerprint": { @@ -1795,7 +1808,7 @@ "name": { "target": "com.amazonaws.ivs#PlaybackKeyPairName", "traits": { - "smithy.api#documentation": "An arbitrary string (a nickname) assigned to a playback key pair that helps the customer\n identify that resource. The value does not need to be unique.
" + "smithy.api#documentation": "Playback-key-pair name. The value does not need to be unique.
" } }, "tags": { @@ -1838,7 +1851,7 @@ } ], "traits": { - "smithy.api#documentation": "Inserts metadata into the active stream of the specified channel. A maximum of 5 requests\n per second per channel is allowed, each with a maximum 1 KB payload. (If 5 TPS is not\n sufficient for your needs, we recommend batching your data into a single PutMetadata call.)\n\n Also see Embedding Metadata\n\n within a Video Stream in the Amazon IVS User Guide.
", + "smithy.api#documentation": "Inserts metadata into the active stream of the specified channel. At most 5 requests per\n second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient\n for your needs, we recommend batching your data into a single PutMetadata call.) At most 155\n requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in\n the Amazon IVS User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/PutMetadata", @@ -1878,7 +1891,7 @@ "name": { "target": "com.amazonaws.ivs#RecordingConfigurationName", "traits": { - "smithy.api#documentation": "An arbitrary string (a nickname) assigned to a recording configuration that helps the\n customer identify that resource. The value does not need to be unique.
" + "smithy.api#documentation": "Recording-configuration name. The value does not need to be unique.
" } }, "destinationConfiguration": { @@ -1964,7 +1977,7 @@ "name": { "target": "com.amazonaws.ivs#RecordingConfigurationName", "traits": { - "smithy.api#documentation": "An arbitrary string (a nickname) assigned to a recording configuration that helps the\n customer identify that resource. The value does not need to be unique.
" + "smithy.api#documentation": "Recording-configuration name. The value does not need to be unique.
" } }, "destinationConfiguration": { @@ -1977,7 +1990,7 @@ "state": { "target": "com.amazonaws.ivs#RecordingConfigurationState", "traits": { - "smithy.api#documentation": "Indicates the current state of the recording configuration. When the state is\n ACTIVE, the configuration is ready for recording a channel stream.
Indicates the current state of the recording configuration. When the state is\n ACTIVE, the configuration is ready for recording a channel stream.
ISO-8601 formatted timestamp of the stream’s start.
" + "smithy.api#documentation": "Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
" } }, "state": { @@ -2143,7 +2158,7 @@ "viewerCount": { "target": "com.amazonaws.ivs#StreamViewerCount", "traits": { - "smithy.api#documentation": "Number of current viewers of the stream. A value of -1 indicates that the request timed\n out; in this case, retry.
" + "smithy.api#documentation": "A count of concurrent views of the stream. Typically, a new view appears in\n viewerCount within 15 seconds of when video playback starts and a view is\n removed from viewerCount within 1 minute of when video playback ends. A value of\n -1 indicates that the request timed out; in this case, retry.
Number of current viewers of the stream. A value of -1 indicates that the request timed\n out; in this case, retry.
" + "smithy.api#documentation": "A count of concurrent views of the stream. Typically, a new view appears in\n viewerCount within 15 seconds of when video playback starts and a view is\n removed from viewerCount within 1 minute of when video playback ends. A value of\n -1 indicates that the request timed out; in this case, retry.
ISO-8601 formatted timestamp of the stream’s start.
" + "smithy.api#documentation": "Time of the stream’s start. This is an ISO 8601 timestamp returned as a string.
" } } }, @@ -2349,6 +2368,7 @@ } }, "traits": { + "smithy.api#documentation": "", "smithy.api#error": "server", "smithy.api#httpError": 503 } @@ -2356,9 +2376,6 @@ "com.amazonaws.ivs#StreamViewerCount": { "type": "long" }, - "com.amazonaws.ivs#String": { - "type": "string" - }, "com.amazonaws.ivs#TagKey": { "type": "string", "traits": { @@ -2400,7 +2417,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds or updates tags for the AWS resource with the specified ARN.
", + "smithy.api#documentation": "Adds or updates tags for the Amazon Web Services resource with the specified ARN.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -2436,7 +2453,6 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 0, "max": 256 } } @@ -2467,6 +2483,7 @@ } }, "traits": { + "smithy.api#documentation": "", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -2496,7 +2513,8 @@ "method": "DELETE", "uri": "/tags/{resourceArn}", "code": 200 - } + }, + "smithy.api#idempotent": {} } }, "com.amazonaws.ivs#UntagResourceRequest": { @@ -2583,7 +2601,7 @@ "type": { "target": "com.amazonaws.ivs#ChannelType", "traits": { - "smithy.api#documentation": "Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Valid values:
\n\n STANDARD: Multiple qualities are generated from the original input, to\n automatically give viewers the best experience for their devices and network conditions.\n Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.
\n BASIC: Amazon IVS delivers the original input to viewers. The viewer’s\n video-quality choice is limited to the original input. Vertical resolution can be up to\n 480 and bitrate can be up to 1.5 Mbps.
Channel type, which determines the allowable resolution and bitrate. If you\n exceed the allowable resolution or bitrate, the stream probably will disconnect\n immediately. Valid values:
\n\n STANDARD: Multiple qualities are generated from the original input, to\n automatically give viewers the best experience for their devices and network conditions.\n Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is transcoded only\n for renditions 360p and below; above that, audio is passed through.
\n BASIC: Amazon IVS delivers the original input to viewers. The viewer’s\n video-quality choice is limited to the original input. Resolution can be up to 480p and\n bitrate can be up to 1.5 Mbps.
The input fails to satisfy the constraints specified by an AWS service.
" + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
" } } }, "traits": { + "smithy.api#documentation": "", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2630,4 +2649,4 @@ "type": "string" } } -} +} \ No newline at end of file diff --git a/codegen/sdk/aws-models/kinesisanalyticsv2.2018-05-23.json b/codegen/sdk/aws-models/kinesisanalyticsv2.2018-05-23.json index 57180fd0f68..1a4d9a1848e 100644 --- a/codegen/sdk/aws-models/kinesisanalyticsv2.2018-05-23.json +++ b/codegen/sdk/aws-models/kinesisanalyticsv2.2018-05-23.json @@ -173,7 +173,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records \n on the input stream before the\n application's SQL code executes. Currently, the only input processor available is AWS Lambda.
" + "smithy.api#documentation": "Adds an InputProcessingConfiguration to a SQL-based Kinesis Data Analytics application. An input processor pre-processes records \n on the input stream before the\n application's SQL code executes. Currently, the only input processor available is Amazon Lambda.
" } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationInputProcessingConfigurationRequest": { @@ -313,7 +313,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds an external destination to your SQL-based Kinesis Data Analytics application.
\nIf you want Kinesis Data Analytics to deliver data from an in-application stream within\n your application to an external destination (such as an Kinesis data stream, a Kinesis Data\n Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to\n your application using this operation. You can configure one or more outputs for your\n application. Each output configuration maps an in-application stream and an external\n destination.
\nYou can use one of the output configurations to deliver data from your\n in-application error stream to an external destination so that you can analyze the\n errors.
\nAny configuration update, including adding a streaming source using this\n operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application\n version.
" + "smithy.api#documentation": "Adds an external destination to your SQL-based Kinesis Data Analytics application.
\nIf you want Kinesis Data Analytics to deliver data from an in-application stream within\n your application to an external destination (such as an Kinesis data stream, a Kinesis Data\n Firehose delivery stream, or an Amazon Lambda function), you add the relevant configuration to\n your application using this operation. You can configure one or more outputs for your\n application. Each output configuration maps an in-application stream and an external\n destination.
\nYou can use one of the output configurations to deliver data from your\n in-application error stream to an external destination so that you can analyze the\n errors.
\nAny configuration update, including adding a streaming source using this\n operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application\n version.
" } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationOutputRequest": { @@ -336,7 +336,7 @@ "Output": { "target": "com.amazonaws.kinesisanalyticsv2#Output", "traits": { - "smithy.api#documentation": "An array of objects, each describing one output configuration. In the output\n configuration, you specify the name of an in-application stream, a destination (that is, a\n Kinesis data stream, a Kinesis Data Firehose delivery stream, or an AWS Lambda function), and\n record the formation to use when writing to the destination.
", + "smithy.api#documentation": "An array of objects, each describing one output configuration. In the output\n configuration, you specify the name of an in-application stream, a destination (that is, a\n Kinesis data stream, a Kinesis Data Firehose delivery stream, or an Amazon Lambda function), and\n record the formation to use when writing to the destination.
", "smithy.api#required": {} } } @@ -912,7 +912,7 @@ "min": 5, "max": 5 }, - "smithy.api#pattern": "([01][0-9]|2[0-3]):[0-5][0-9]" + "smithy.api#pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationMaintenanceWindowStartTime": { @@ -922,7 +922,7 @@ "min": 5, "max": 5 }, - "smithy.api#pattern": "([01][0-9]|2[0-3]):[0-5][0-9]" + "smithy.api#pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationMode": { @@ -947,7 +947,7 @@ "min": 1, "max": 128 }, - "smithy.api#pattern": "[a-zA-Z0-9_.-]+" + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.kinesisanalyticsv2#ApplicationRestoreConfiguration": { @@ -1071,14 +1071,14 @@ "value": "FORCE_STOPPING", "name": "FORCE_STOPPING" }, - { - "value": "MAINTENANCE", - "name": "MAINTENANCE" - }, { "value": "ROLLING_BACK", "name": "ROLLING_BACK" }, + { + "value": "MAINTENANCE", + "name": "MAINTENANCE" + }, { "value": "ROLLED_BACK", "name": "ROLLED_BACK" @@ -1210,7 +1210,7 @@ "min": 1, "max": 1024 }, - "smithy.api#pattern": "[a-zA-Z0-9/!-_.*'()]+" + "smithy.api#pattern": "^[a-zA-Z0-9/!-_.*'()]+$" } }, "com.amazonaws.kinesisanalyticsv2#BooleanObject": { @@ -1226,7 +1226,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "arn:.*" + "smithy.api#pattern": "^arn:" } }, "com.amazonaws.kinesisanalyticsv2#CSVMappingParameters": { @@ -1257,13 +1257,13 @@ "GlueDataCatalogConfiguration": { "target": "com.amazonaws.kinesisanalyticsv2#GlueDataCatalogConfiguration", "traits": { - "smithy.api#documentation": "The configuration parameters for the default AWS Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook.
", + "smithy.api#documentation": "The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The configuration parameters for the default AWS Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.
" + "smithy.api#documentation": "The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.
" } }, "com.amazonaws.kinesisanalyticsv2#CatalogConfigurationDescription": { @@ -1272,13 +1272,13 @@ "GlueDataCatalogConfigurationDescription": { "target": "com.amazonaws.kinesisanalyticsv2#GlueDataCatalogConfigurationDescription", "traits": { - "smithy.api#documentation": "The configuration parameters for the default AWS Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.
", + "smithy.api#documentation": "The configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The configuration parameters for the default AWS Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook.
" + "smithy.api#documentation": "The configuration parameters for the default Amazon Glue database. You use this database for Apache Flink SQL queries and table API transforms that you write in a Kinesis Data Analytics Studio notebook.
" } }, "com.amazonaws.kinesisanalyticsv2#CatalogConfigurationUpdate": { @@ -1287,13 +1287,13 @@ "GlueDataCatalogConfigurationUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#GlueDataCatalogConfigurationUpdate", "traits": { - "smithy.api#documentation": "Updates to the configuration parameters for the default AWS Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.
", + "smithy.api#documentation": "Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Updates to
" + "smithy.api#documentation": "Updates to the configuration parameters for the default Amazon Glue database. You use this database for SQL queries that you write in a Kinesis Data Analytics Studio notebook.
" } }, "com.amazonaws.kinesisanalyticsv2#CheckpointConfiguration": { @@ -1633,7 +1633,7 @@ "min": 1, "max": 512 }, - "smithy.api#pattern": "[a-zA-Z0-9-_+/=]+" + "smithy.api#pattern": "^[a-zA-Z0-9-_+/=]+$" } }, "com.amazonaws.kinesisanalyticsv2#ConfigurationType": { @@ -1680,6 +1680,9 @@ }, { "target": "com.amazonaws.kinesisanalyticsv2#TooManyTagsException" + }, + { + "target": "com.amazonaws.kinesisanalyticsv2#UnsupportedOperationException" } ], "traits": { @@ -1949,7 +1952,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "arn:.*" + "smithy.api#pattern": "^arn:" } }, "com.amazonaws.kinesisanalyticsv2#DeleteApplication": { @@ -2457,7 +2460,7 @@ } }, "traits": { - "smithy.api#documentation": "The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state..
" + "smithy.api#documentation": "The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.
" } }, "com.amazonaws.kinesisanalyticsv2#DeployAsApplicationConfigurationDescription": { @@ -2481,13 +2484,12 @@ "S3ContentLocationUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#S3ContentBaseLocationUpdate", "traits": { - "smithy.api#documentation": "Updates to the location that holds the data required to specify an Amazon Data Analytics application.
", - "smithy.api#required": {} + "smithy.api#documentation": "Updates to the location that holds the data required to specify an Amazon Data Analytics application.
" } } }, "traits": { - "smithy.api#documentation": "Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state..
" + "smithy.api#documentation": "Updates to the configuration information required to deploy an Amazon Data Analytics Studio notebook as an application with durable state.
" } }, "com.amazonaws.kinesisanalyticsv2#DescribeApplication": { @@ -2685,6 +2687,9 @@ }, { "target": "com.amazonaws.kinesisanalyticsv2#UnableToDetectSchemaException" + }, + { + "target": "com.amazonaws.kinesisanalyticsv2#UnsupportedOperationException" } ], "traits": { @@ -2946,7 +2951,8 @@ "DatabaseARNUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#DatabaseARN", "traits": { - "smithy.api#documentation": "The updated Amazon Resource Name (ARN) of the database.
" + "smithy.api#documentation": "The updated Amazon Resource Name (ARN) of the database.
", + "smithy.api#required": {} } } }, @@ -2961,7 +2967,7 @@ "min": 1, "max": 50 }, - "smithy.api#pattern": "[a-zA-Z0-9_.-]+" + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.kinesisanalyticsv2#InAppStreamName": { @@ -2971,7 +2977,7 @@ "min": 1, "max": 32 }, - "smithy.api#pattern": "[^-\\s<>&]*" + "smithy.api#pattern": "^[^-\\s<>&]*$" } }, "com.amazonaws.kinesisanalyticsv2#InAppStreamNames": { @@ -3109,13 +3115,13 @@ "ResourceARN": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { - "smithy.api#documentation": "The ARN of the AWS Lambda function that operates on records in the stream.
\nTo specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n
\nThe ARN of the Amazon Lambda function that operates on records in the stream.
\nTo specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda\n
\nAn object that contains the Amazon Resource Name (ARN) of the AWS Lambda function that is\n used to preprocess records in the stream in a SQL-based Kinesis Data Analytics application.
" + "smithy.api#documentation": "An object that contains the Amazon Resource Name (ARN) of the Amazon Lambda function that is\n used to preprocess records in the stream in a SQL-based Kinesis Data Analytics application.
" } }, "com.amazonaws.kinesisanalyticsv2#InputLambdaProcessorDescription": { @@ -3124,19 +3130,19 @@ "ResourceARN": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { - "smithy.api#documentation": "The ARN of the AWS Lambda function that is used to preprocess the records in the\n stream.
\nTo specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n
\nThe ARN of the Amazon Lambda function that is used to preprocess the records in the\n stream.
\nTo specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda\n
\nThe ARN of the IAM role that is used to access the AWS Lambda function.
\nProvided for backward compatibility. Applications that are created with the current API\n version have an application-level service execution role rather than a resource-level\n role.
\nThe ARN of the IAM role that is used to access the Amazon Lambda function.
\nProvided for backward compatibility. Applications that are created with the current API\n version have an application-level service execution role rather than a resource-level\n role.
\nFor a SQL-based Kinesis Data Analytics application, an object that contains the\n Amazon Resource Name (ARN) of the AWS Lambda function that is used to preprocess records in\n the stream.
" + "smithy.api#documentation": "For a SQL-based Kinesis Data Analytics application, an object that contains the\n Amazon Resource Name (ARN) of the Amazon Lambda function that is used to preprocess records in\n the stream.
" } }, "com.amazonaws.kinesisanalyticsv2#InputLambdaProcessorUpdate": { @@ -3145,7 +3151,7 @@ "ResourceARNUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the new AWS Lambda function that is used to preprocess\n the records in the stream.
\nTo specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n
\nThe Amazon Resource Name (ARN) of the new Amazon Lambda function that is used to preprocess\n the records in the stream.
\nTo specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda\n
\nFor a SQL-based Kinesis Data Analytics application, describes a processor that is\n used to preprocess the records in the stream before being processed by your application code.\n Currently, the only input processor available is AWS Lambda.
" + "smithy.api#documentation": "For a SQL-based Kinesis Data Analytics application, describes a processor that is\n used to preprocess the records in the stream before being processed by your application code.\n Currently, the only input processor available is Amazon Lambda.
" } }, "com.amazonaws.kinesisanalyticsv2#InputProcessingConfigurationDescription": { @@ -3219,7 +3225,7 @@ } }, "traits": { - "smithy.api#documentation": "For a SQL-based Kinesis Data Analytics application, provides the configuration\n information about an input processor. Currently, the only input processor available is AWS Lambda.
" + "smithy.api#documentation": "For a SQL-based Kinesis Data Analytics application, provides the configuration\n information about an input processor. Currently, the only input processor available is Amazon Lambda.
" } }, "com.amazonaws.kinesisanalyticsv2#InputProcessingConfigurationUpdate": { @@ -3420,7 +3426,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "arn:.*" + "smithy.api#pattern": "^arn:" } }, "com.amazonaws.kinesisanalyticsv2#KinesisAnalytics_20180523": { @@ -3750,13 +3756,13 @@ "ResourceARN": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination Lambda function to write to.
\nTo specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n
\nThe Amazon Resource Name (ARN) of the destination Lambda function to write to.
\nTo specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda\n
\nWhen you configure a SQL-based Kinesis Data Analytics application's output,\n identifies an AWS Lambda function as the destination. You provide the function Amazon Resource\n Name (ARN) of the Lambda function.
" + "smithy.api#documentation": "When you configure a SQL-based Kinesis Data Analytics application's output,\n identifies an Amazon Lambda function as the destination. You provide the function Amazon Resource\n Name (ARN) of the Lambda function.
" } }, "com.amazonaws.kinesisanalyticsv2#LambdaOutputDescription": { @@ -3777,7 +3783,7 @@ } }, "traits": { - "smithy.api#documentation": "For a SQL-based Kinesis Data Analytics application's output, describes the AWS\n Lambda function that is configured as its destination.
" + "smithy.api#documentation": "For a SQL-based Kinesis Data Analytics application's output, describes the Amazon\n Lambda function that is configured as its destination.
" } }, "com.amazonaws.kinesisanalyticsv2#LambdaOutputUpdate": { @@ -3786,13 +3792,13 @@ "ResourceARNUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#ResourceARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination AWS Lambda function.
\nTo specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda\n
\nThe Amazon Resource Name (ARN) of the destination Amazon Lambda function.
\nTo specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda\n
\nWhen you update an SQL-based Kinesis Data Analytics application's output\n configuration using the UpdateApplication operation, provides information\n about an AWS Lambda function that is configured as the destination.
" + "smithy.api#documentation": "When you update an SQL-based Kinesis Data Analytics application's output\n configuration using the UpdateApplication operation, provides information\n about an Amazon Lambda function that is configured as the destination.
" } }, "com.amazonaws.kinesisanalyticsv2#LimitExceededException": { @@ -3920,7 +3926,7 @@ "NextToken": { "target": "com.amazonaws.kinesisanalyticsv2#NextToken", "traits": { - "smithy.api#documentation": "If a previous invocation of this operation returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see \n Using the AWS Command Line Interface's Pagination Options.
" + "smithy.api#documentation": "If a previous invocation of this operation returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see \n Using the Amazon Command Line Interface's Pagination Options.
" } } } @@ -3937,7 +3943,7 @@ "NextToken": { "target": "com.amazonaws.kinesisanalyticsv2#NextToken", "traits": { - "smithy.api#documentation": "The pagination token for the next set of results, or null if there are no additional results. \n To retrieve the next set of items, pass this token into a subsequent invocation of this operation. For more information about pagination, see \n Using the AWS Command Line Interface's Pagination Options.
The pagination token for the next set of results, or null if there are no additional results. \n To retrieve the next set of items, pass this token into a subsequent invocation of this operation. For more information about pagination, see \n Using the Amazon Command Line Interface's Pagination Options.
If a previous command returned a pagination token, \n pass it into this value to retrieve the next set of results.\n For more information about pagination, see \n Using the AWS Command Line Interface's Pagination Options.
" + "smithy.api#documentation": "If a previous command returned a pagination token, \n pass it into this value to retrieve the next set of results.\n For more information about pagination, see \n Using the Amazon Command Line Interface's Pagination Options.
" } } } @@ -3999,7 +4005,7 @@ "NextToken": { "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", "traits": { - "smithy.api#documentation": "The pagination token for the next set of results, or null if there are no additional results.\n Pass this token into a subsequent command to retrieve the next set of items\n For more information about pagination, see \n Using the AWS Command Line Interface's Pagination Options.
The pagination token for the next set of results, or null if there are no additional results.\n Pass this token into a subsequent command to retrieve the next set of items\n For more information about pagination, see \n Using the Amazon Command Line Interface's Pagination Options.
Identifies an AWS Lambda function as the destination.
" + "smithy.api#documentation": "Identifies an Amazon Lambda function as the destination.
" } }, "DestinationSchema": { @@ -4422,7 +4428,7 @@ "LambdaOutputUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#LambdaOutputUpdate", "traits": { - "smithy.api#documentation": "Describes an AWS Lambda function as the destination for the output.
" + "smithy.api#documentation": "Describes an Amazon Lambda function as the destination for the output.
" } }, "DestinationSchemaUpdate": { @@ -4722,7 +4728,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[^-\\s<>&]*" + "smithy.api#pattern": "^[^-\\s<>&]*$" } }, "com.amazonaws.kinesisanalyticsv2#RecordColumnSqlType": { @@ -4753,7 +4759,7 @@ "min": 5, "max": 5 }, - "smithy.api#pattern": "UTF-8" + "smithy.api#pattern": "^UTF-8$" } }, "com.amazonaws.kinesisanalyticsv2#RecordFormat": { @@ -4932,7 +4938,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "arn:.*" + "smithy.api#pattern": "^arn:" } }, "com.amazonaws.kinesisanalyticsv2#ResourceInUseException": { @@ -4978,7 +4984,7 @@ "min": 1, "max": 2048 }, - "smithy.api#pattern": "arn:.*" + "smithy.api#pattern": "^arn:" } }, "com.amazonaws.kinesisanalyticsv2#RollbackApplication": { @@ -5122,13 +5128,21 @@ "value": "FLINK-1_8", "name": "FLINK_1_8" }, + { + "value": "ZEPPELIN-FLINK-1_0", + "name": "ZEPPELIN_FLINK_1_0" + }, { "value": "FLINK-1_11", "name": "FLINK_1_11" }, { - "value": "ZEPPELIN-FLINK-1_0", - "name": "ZEPPELIN_FLINK_1_0" + "value": "FLINK-1_13", + "name": "FLINK_1_13" + }, + { + "value": "ZEPPELIN-FLINK-2_0", + "name": "ZEPPELIN_FLINK_2_0" } ] } @@ -5231,8 +5245,7 @@ "BucketARNUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#BucketARN", "traits": { - "smithy.api#documentation": "The updated Amazon Resource Name (ARN) of the S3 bucket.
", - "smithy.api#required": {} + "smithy.api#documentation": "The updated Amazon Resource Name (ARN) of the S3 bucket.
" } }, "BasePathUpdate": { @@ -5448,7 +5461,7 @@ "min": 1, "max": 256 }, - "smithy.api#pattern": "[a-zA-Z0-9_.-]+" + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, "com.amazonaws.kinesisanalyticsv2#SnapshotStatus": { @@ -5752,7 +5765,7 @@ } }, "traits": { - "smithy.api#documentation": "A key-value pair (the value is optional) that you can define and assign to AWS resources. \n If you specify a tag that already exists, the tag value is replaced with the value that you \n specify in the request. Note that \n the maximum number of application tags includes system tags. The maximum number of user-defined \n application tags is 50.\n For more information, see \n Using Tagging.
" + "smithy.api#documentation": "A key-value pair (the value is optional) that you can define and assign to Amazon resources. \n If you specify a tag that already exists, the tag value is replaced with the value that you \n specify in the request. Note that \n the maximum number of application tags includes system tags. The maximum number of user-defined \n application tags is 50.\n For more information, see \n Using Tagging.
" } }, "com.amazonaws.kinesisanalyticsv2#TagKey": { @@ -6257,13 +6270,13 @@ "CatalogConfiguration": { "target": "com.amazonaws.kinesisanalyticsv2#CatalogConfiguration", "traits": { - "smithy.api#documentation": "The AWS Glue Data Catalog that you use in queries in a Kinesis Data Analytics Studio notebook.
" + "smithy.api#documentation": "The Amazon Glue Data Catalog that you use in queries in a Kinesis Data Analytics Studio notebook.
" } }, "DeployAsApplicationConfiguration": { "target": "com.amazonaws.kinesisanalyticsv2#DeployAsApplicationConfiguration", "traits": { - "smithy.api#documentation": "The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state..
" + "smithy.api#documentation": "The information required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.
" } }, "CustomArtifactsConfiguration": { @@ -6290,13 +6303,13 @@ "CatalogConfigurationDescription": { "target": "com.amazonaws.kinesisanalyticsv2#CatalogConfigurationDescription", "traits": { - "smithy.api#documentation": "The AWS Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook.
" + "smithy.api#documentation": "The Amazon Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook.
" } }, "DeployAsApplicationConfigurationDescription": { "target": "com.amazonaws.kinesisanalyticsv2#DeployAsApplicationConfigurationDescription", "traits": { - "smithy.api#documentation": "The parameters required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state..
" + "smithy.api#documentation": "The parameters required to deploy a Kinesis Data Analytics Studio notebook as an application with durable state.
" } }, "CustomArtifactsConfigurationDescription": { @@ -6322,7 +6335,7 @@ "CatalogConfigurationUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#CatalogConfigurationUpdate", "traits": { - "smithy.api#documentation": "Updates to the configuration of the AWS Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook.
" + "smithy.api#documentation": "Updates to the configuration of the Amazon Glue Data Catalog that is associated with the Kinesis Data Analytics Studio notebook.
" } }, "DeployAsApplicationConfigurationUpdate": { diff --git a/codegen/sdk/aws-models/mediaconvert.2017-08-29.json b/codegen/sdk/aws-models/mediaconvert.2017-08-29.json index 9f934908d2c..28155f7bc00 100644 --- a/codegen/sdk/aws-models/mediaconvert.2017-08-29.json +++ b/codegen/sdk/aws-models/mediaconvert.2017-08-29.json @@ -1902,7 +1902,7 @@ "com.amazonaws.mediaconvert#BurnInSubtitleStylePassthrough": { "type": "string", "traits": { - "smithy.api#documentation": "Ignore this setting unless your output captions are burned in. Choose which set of style and position values the service applies to your output captions. When you choose ENABLED, the service uses the input style and position information from your input. When you choose DISABLED, the service uses any style values that you specify in your output settings. If you don't specify values, the service uses default style and position values. When you choose DISABLED, the service ignores all style and position values from your input.", + "smithy.api#documentation": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings.", "smithy.api#enum": [ { "value": "ENABLED", @@ -1921,159 +1921,159 @@ "Alignment": { "target": "com.amazonaws.mediaconvert#BurninSubtitleAlignment", "traits": { - "smithy.api#documentation": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates.", "smithy.api#jsonName": "alignment" } }, "ApplyFontColor": { "target": "com.amazonaws.mediaconvert#BurninSubtitleApplyFontColor", "traits": { - "smithy.api#documentation": "Ignore this setting unless your input captions are STL, any type of 608, teletext, or TTML, and your output captions are burned in. Specify how the service applies the color specified in the setting Font color (BurninSubtitleFontColor). By default, this color is white. When you choose WHITE_TEXT_ONLY, the service uses the specified font color only for text that is white in the input. When you choose ALL_TEXT, the service uses the specified font color for all output captions text. If you leave both settings at their default value, your output font color is the same as your input font color.", + "smithy.api#documentation": "Ignore this setting unless Style passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text.", "smithy.api#jsonName": "applyFontColor" } }, "BackgroundColor": { "target": "com.amazonaws.mediaconvert#BurninSubtitleBackgroundColor", "traits": { - "smithy.api#documentation": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "backgroundColor" } }, "BackgroundOpacity": { "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the opacity of the background rectangle. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough (StylePassthrough) is set to enabled, leave blank to pass through the background style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all backgrounds from your output captions.", "smithy.api#jsonName": "backgroundOpacity" } }, "FallbackFont": { "target": "com.amazonaws.mediaconvert#BurninSubtitleFallbackFont", "traits": { - "smithy.api#documentation": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you keep the default value, Best match (BEST_MATCH), MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.", + "smithy.api#documentation": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.", "smithy.api#jsonName": "fallbackFont" } }, "FontColor": { "target": "com.amazonaws.mediaconvert#BurninSubtitleFontColor", "traits": { - "smithy.api#documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the color of the burned-in captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font color data from your input captions, if present.", "smithy.api#jsonName": "fontColor" } }, "FontOpacity": { "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the opacity of the burned-in captions. 255 is opaque; 0 is transparent.", "smithy.api#jsonName": "fontOpacity" } }, "FontResolution": { "target": "com.amazonaws.mediaconvert#__integerMin96Max600", "traits": { - "smithy.api#documentation": "Font resolution in DPI (dots per inch); default is 96 dpi.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the Font resolution (FontResolution) in DPI (dots per inch).", "smithy.api#jsonName": "fontResolution" } }, "FontScript": { "target": "com.amazonaws.mediaconvert#FontScript", "traits": { - "smithy.api#documentation": "Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use \"AUTOMATIC\" or leave unset. This is used to help determine the appropriate font for rendering burn-in captions.", + "smithy.api#documentation": "Set Font script (FontScript) to Automatically determined (AUTOMATIC), or leave blank, to automatically determine the font script in your input captions. Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) if your input font script uses Simplified or Traditional Chinese.", "smithy.api#jsonName": "fontScript" } }, "FontSize": { "target": "com.amazonaws.mediaconvert#__integerMin0Max96", "traits": { - "smithy.api#documentation": "A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the Font size (FontSize) in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size.", "smithy.api#jsonName": "fontSize" } }, "HexFontColor": { "target": "com.amazonaws.mediaconvert#__stringMin6Max8Pattern09aFAF609aFAF2", "traits": { - "smithy.api#documentation": "Ignore this setting unless your BurninSubtitleFontColor setting is HEX. Format is six or eight hexidecimal digits, representing the red, green, and blue components, with the two extra digits used for an optional alpha value. For example a value of 1122AABB is a red value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB.", + "smithy.api#documentation": "Ignore this setting unless your Font color is set to Hex. Enter either six or eight hexidecimal digits, representing red, green, and blue, with two optional extra digits for alpha. For example a value of 1122AABB is a red value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB.", "smithy.api#jsonName": "hexFontColor" } }, "OutlineColor": { "target": "com.amazonaws.mediaconvert#BurninSubtitleOutlineColor", "traits": { - "smithy.api#documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font outline color data from your input captions, if present.", "smithy.api#jsonName": "outlineColor" } }, "OutlineSize": { "target": "com.amazonaws.mediaconvert#__integerMin0Max10", "traits": { - "smithy.api#documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the Outline size (OutlineSize) of the caption text, in pixels. Leave Outline size blank and set Style passthrough (StylePassthrough) to enabled to use the outline size data from your input captions, if present.", "smithy.api#jsonName": "outlineSize" } }, "ShadowColor": { "target": "com.amazonaws.mediaconvert#BurninSubtitleShadowColor", "traits": { - "smithy.api#documentation": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow color data from your input captions, if present.", "smithy.api#jsonName": "shadowColor" } }, "ShadowOpacity": { "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the opacity of the shadow. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough (StylePassthrough) is set to Enabled, leave Shadow opacity (ShadowOpacity) blank to pass through the shadow style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all shadows from your output captions.", "smithy.api#jsonName": "shadowOpacity" } }, "ShadowXOffset": { "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { - "smithy.api#documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the horizontal offset of the shadow, relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left.", "smithy.api#jsonName": "shadowXOffset" } }, "ShadowYOffset": { "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { - "smithy.api#documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. Leave Shadow y-offset (ShadowYOffset) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow y-offset data from your input captions, if present.", "smithy.api#jsonName": "shadowYOffset" } }, "StylePassthrough": { "target": "com.amazonaws.mediaconvert#BurnInSubtitleStylePassthrough", "traits": { - "smithy.api#documentation": "Ignore this setting unless your output captions are burned in. Choose which set of style and position values the service applies to your output captions. When you choose ENABLED, the service uses the input style and position information from your input. When you choose DISABLED, the service uses any style values that you specify in your output settings. If you don't specify values, the service uses default style and position values. When you choose DISABLED, the service ignores all style and position values from your input.", + "smithy.api#documentation": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings.", "smithy.api#jsonName": "stylePassthrough" } }, "TeletextSpacing": { "target": "com.amazonaws.mediaconvert#BurninSubtitleTeletextSpacing", "traits": { - "smithy.api#documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", + "smithy.api#documentation": "Specify whether the text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions.", "smithy.api#jsonName": "teletextSpacing" } }, "XPosition": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the horizontal position (XPosition) of the captions, relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter.", "smithy.api#jsonName": "xPosition" } }, "YPosition": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the vertical position (YPosition) of the captions, relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output.", "smithy.api#jsonName": "yPosition" } } }, "traits": { - "smithy.api#documentation": "Settings related to burn-in captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN." + "smithy.api#documentation": "Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video content with the captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN." } }, "com.amazonaws.mediaconvert#BurninSubtitleAlignment": { "type": "string", "traits": { - "smithy.api#documentation": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates.", "smithy.api#enum": [ { "value": "CENTERED", @@ -2093,7 +2093,7 @@ "com.amazonaws.mediaconvert#BurninSubtitleApplyFontColor": { "type": "string", "traits": { - "smithy.api#documentation": "Ignore this setting unless your input captions are STL, any type of 608, teletext, or TTML, and your output captions are burned in. Specify how the service applies the color specified in the setting Font color (BurninSubtitleFontColor). By default, this color is white. When you choose WHITE_TEXT_ONLY, the service uses the specified font color only for text that is white in the input. When you choose ALL_TEXT, the service uses the specified font color for all output captions text. If you leave both settings at their default value, your output font color is the same as your input font color.", + "smithy.api#documentation": "Ignore this setting unless Style passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text.", "smithy.api#enum": [ { "value": "WHITE_TEXT_ONLY", @@ -2109,7 +2109,7 @@ "com.amazonaws.mediaconvert#BurninSubtitleBackgroundColor": { "type": "string", "traits": { - "smithy.api#documentation": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#enum": [ { "value": "NONE", @@ -2133,7 +2133,7 @@ "com.amazonaws.mediaconvert#BurninSubtitleFallbackFont": { "type": "string", "traits": { - "smithy.api#documentation": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you keep the default value, Best match (BEST_MATCH), MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.", + "smithy.api#documentation": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.", "smithy.api#enum": [ { "value": "BEST_MATCH", @@ -2161,7 +2161,7 @@ "com.amazonaws.mediaconvert#BurninSubtitleFontColor": { "type": "string", "traits": { - "smithy.api#documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the color of the burned-in captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font color data from your input captions, if present.", "smithy.api#enum": [ { "value": "WHITE", @@ -2201,7 +2201,7 @@ "com.amazonaws.mediaconvert#BurninSubtitleOutlineColor": { "type": "string", "traits": { - "smithy.api#documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font outline color data from your input captions, if present.", "smithy.api#enum": [ { "value": "BLACK", @@ -2237,7 +2237,7 @@ "com.amazonaws.mediaconvert#BurninSubtitleShadowColor": { "type": "string", "traits": { - "smithy.api#documentation": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow color data from your input captions, if present.", "smithy.api#enum": [ { "value": "NONE", @@ -2261,7 +2261,7 @@ "com.amazonaws.mediaconvert#BurninSubtitleTeletextSpacing": { "type": "string", "traits": { - "smithy.api#documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", + "smithy.api#documentation": "Specify whether the text spacing (TeletextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions.", "smithy.api#enum": [ { "value": "FIXED_GRID", @@ -2417,7 +2417,7 @@ "BurninDestinationSettings": { "target": "com.amazonaws.mediaconvert#BurninDestinationSettings", "traits": { - "smithy.api#documentation": "Settings related to burn-in captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN.", + "smithy.api#documentation": "Burn-in is a captions delivery method, rather than a captions format. Burn-in writes the captions directly on your video frames, replacing pixels of video content with the captions. Set up burn-in captions in the same output as your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to BURN_IN.", "smithy.api#jsonName": "burninDestinationSettings" } }, @@ -2459,7 +2459,7 @@ "SrtDestinationSettings": { "target": "com.amazonaws.mediaconvert#SrtDestinationSettings", "traits": { - "smithy.api#documentation": "SRT Destination Settings", + "smithy.api#documentation": "Settings related to SRT captions. SRT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SRT.", "smithy.api#jsonName": "srtDestinationSettings" } }, @@ -2480,7 +2480,7 @@ "WebvttDestinationSettings": { "target": "com.amazonaws.mediaconvert#WebvttDestinationSettings", "traits": { - "smithy.api#documentation": "WEBVTT Destination Settings", + "smithy.api#documentation": "Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to WebVTT.", "smithy.api#jsonName": "webvttDestinationSettings" } } @@ -2593,7 +2593,7 @@ } }, "traits": { - "smithy.api#documentation": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction, using the settings Framerate numerator (framerateNumerator) and Framerate denominator (framerateDenominator). For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps." + "smithy.api#documentation": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction. When you work directly in your JSON job specification, use the settings framerateNumerator and framerateDenominator. For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps." } }, "com.amazonaws.mediaconvert#CaptionSourceSettings": { @@ -5329,28 +5329,28 @@ "Alignment": { "target": "com.amazonaws.mediaconvert#DvbSubtitleAlignment", "traits": { - "smithy.api#documentation": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "alignment" } }, "ApplyFontColor": { "target": "com.amazonaws.mediaconvert#DvbSubtitleApplyFontColor", "traits": { - "smithy.api#documentation": "Ignore this setting unless your input captions are STL, any type of 608, teletext, or TTML, and your output captions are DVB-SUB. Specify how the service applies the color specified in the setting Font color (DvbSubtitleFontColor). By default, this color is white. When you choose WHITE_TEXT_ONLY, the service uses the specified font color only for text that is white in the input. When you choose ALL_TEXT, the service uses the specified font color for all output captions text. If you leave both settings at their default value, your output font color is the same as your input font color.", + "smithy.api#documentation": "Ignore this setting unless Style Passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text.", "smithy.api#jsonName": "applyFontColor" } }, "BackgroundColor": { "target": "com.amazonaws.mediaconvert#DvbSubtitleBackgroundColor", "traits": { - "smithy.api#documentation": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present.", "smithy.api#jsonName": "backgroundColor" } }, "BackgroundOpacity": { "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the opacity of the background rectangle. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough (StylePassthrough) is set to enabled, leave blank to pass through the background style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all backgrounds from your output captions. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "backgroundOpacity" } }, @@ -5378,42 +5378,42 @@ "FallbackFont": { "target": "com.amazonaws.mediaconvert#DvbSubSubtitleFallbackFont", "traits": { - "smithy.api#documentation": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you keep the default value, Best match (BEST_MATCH), MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.", + "smithy.api#documentation": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.", "smithy.api#jsonName": "fallbackFont" } }, "FontColor": { "target": "com.amazonaws.mediaconvert#DvbSubtitleFontColor", "traits": { - "smithy.api#documentation": "Specifies the color of the DVB-SUB captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the color of the captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "fontColor" } }, "FontOpacity": { "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nWithin your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "fontOpacity" } }, "FontResolution": { "target": "com.amazonaws.mediaconvert#__integerMin96Max600", "traits": { - "smithy.api#documentation": "Font resolution in DPI (dots per inch); default is 96 dpi.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the Font resolution (FontResolution) in DPI (dots per inch).\nWithin your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "fontResolution" } }, "FontScript": { "target": "com.amazonaws.mediaconvert#FontScript", "traits": { - "smithy.api#documentation": "Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use \"AUTOMATIC\" or leave unset. This is used to help determine the appropriate font for rendering DVB-Sub captions.", + "smithy.api#documentation": "Set Font script (FontScript) to Automatically determined (AUTOMATIC), or leave blank, to automatically determine the font script in your input captions. Otherwise, set to Simplified Chinese (HANS) or Traditional Chinese (HANT) if your input font script uses Simplified or Traditional Chinese. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "fontScript" } }, "FontSize": { "target": "com.amazonaws.mediaconvert#__integerMin0Max96", "traits": { - "smithy.api#documentation": "A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the Font size (FontSize) in pixels. Must be a positive integer. Set to 0, or leave blank, for automatic font size. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "fontSize" } }, @@ -5427,56 +5427,56 @@ "HexFontColor": { "target": "com.amazonaws.mediaconvert#__stringMin6Max8Pattern09aFAF609aFAF2", "traits": { - "smithy.api#documentation": "Ignore this setting unless your DvbSubtitleFontColor setting is HEX. Format is six or eight hexidecimal digits, representing the red, green, and blue components, with the two extra digits used for an optional alpha value. For example a value of 1122AABB is a red value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB.", + "smithy.api#documentation": "Ignore this setting unless your Font color is set to Hex. Enter either six or eight hexidecimal digits, representing red, green, and blue, with two optional extra digits for alpha. For example a value of 1122AABB is a red value of 0x11, a green value of 0x22, a blue value of 0xAA, and an alpha value of 0xBB.", "smithy.api#jsonName": "hexFontColor" } }, "OutlineColor": { "target": "com.amazonaws.mediaconvert#DvbSubtitleOutlineColor", "traits": { - "smithy.api#documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font outline color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "outlineColor" } }, "OutlineSize": { "target": "com.amazonaws.mediaconvert#__integerMin0Max10", "traits": { - "smithy.api#documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the Outline size (OutlineSize) of the caption text, in pixels. Leave Outline size blank and set Style passthrough (StylePassthrough) to enabled to use the outline size data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "outlineSize" } }, "ShadowColor": { "target": "com.amazonaws.mediaconvert#DvbSubtitleShadowColor", "traits": { - "smithy.api#documentation": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "shadowColor" } }, "ShadowOpacity": { "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the opacity of the shadow. Enter a value from 0 to 255, where 0 is transparent and 255 is opaque. If Style passthrough (StylePassthrough) is set to Enabled, leave Shadow opacity (ShadowOpacity) blank to pass through the shadow style information in your input captions to your output captions. If Style passthrough is set to disabled, leave blank to use a value of 0 and remove all shadows from your output captions. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "shadowOpacity" } }, "ShadowXOffset": { "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { - "smithy.api#documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the horizontal offset of the shadow, relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "shadowXOffset" } }, "ShadowYOffset": { "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { - "smithy.api#documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. Leave Shadow y-offset (ShadowYOffset) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow y-offset data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "shadowYOffset" } }, "StylePassthrough": { "target": "com.amazonaws.mediaconvert#DvbSubtitleStylePassthrough", "traits": { - "smithy.api#documentation": "Choose which set of style and position values the service applies to your output captions. When you choose ENABLED, the service uses the input style and position information from your input. When you choose DISABLED, the service uses any style values that you specify in your output settings. If you don't specify values, the service uses default style and position values. When you choose DISABLED, the service ignores all style and position values from your input.", + "smithy.api#documentation": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings.", "smithy.api#jsonName": "stylePassthrough" } }, @@ -5490,7 +5490,7 @@ "TeletextSpacing": { "target": "com.amazonaws.mediaconvert#DvbSubtitleTeletextSpacing", "traits": { - "smithy.api#documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", + "smithy.api#documentation": "Specify whether the Text spacing (TextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "teletextSpacing" } }, @@ -5504,14 +5504,14 @@ "XPosition": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the horizontal position (XPosition) of the captions, relative to the left side of the outputin pixels. A value of 10 would result in the captions starting 10 pixels from the left ofthe output. If no explicit x_position is provided, the horizontal caption position will bedetermined by the alignment parameter. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "xPosition" } }, "YPosition": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the vertical position (YPosition) of the captions, relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#jsonName": "yPosition" } } @@ -5538,7 +5538,7 @@ "com.amazonaws.mediaconvert#DvbSubSubtitleFallbackFont": { "type": "string", "traits": { - "smithy.api#documentation": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you keep the default value, Best match (BEST_MATCH), MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.", + "smithy.api#documentation": "Specify the font that you want the service to use for your burn in captions when your input captions specify a font that MediaConvert doesn't support. When you set Fallback font (FallbackFont) to best match (BEST_MATCH), or leave blank, MediaConvert uses a supported font that most closely matches the font that your input captions specify. When there are multiple unsupported fonts in your input captions, MediaConvert matches each font with the supported font that matches best. When you explicitly choose a replacement font, MediaConvert uses that font to replace all unsupported fonts from your input.", "smithy.api#enum": [ { "value": "BEST_MATCH", @@ -5566,7 +5566,7 @@ "com.amazonaws.mediaconvert#DvbSubtitleAlignment": { "type": "string", "traits": { - "smithy.api#documentation": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the alignment of your captions. If no explicit x_position is provided, setting alignment to centered will placethe captions at the bottom center of the output. Similarly, setting a left alignment willalign captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#enum": [ { "value": "CENTERED", @@ -5586,7 +5586,7 @@ "com.amazonaws.mediaconvert#DvbSubtitleApplyFontColor": { "type": "string", "traits": { - "smithy.api#documentation": "Ignore this setting unless your input captions are STL, any type of 608, teletext, or TTML, and your output captions are DVB-SUB. Specify how the service applies the color specified in the setting Font color (DvbSubtitleFontColor). By default, this color is white. When you choose WHITE_TEXT_ONLY, the service uses the specified font color only for text that is white in the input. When you choose ALL_TEXT, the service uses the specified font color for all output captions text. If you leave both settings at their default value, your output font color is the same as your input font color.", + "smithy.api#documentation": "Ignore this setting unless Style Passthrough (StylePassthrough) is set to Enabled and Font color (FontColor) set to Black, Yellow, Red, Green, Blue, or Hex. Use Apply font color (ApplyFontColor) for additional font color controls. When you choose White text only (WHITE_TEXT_ONLY), or leave blank, your font color setting only applies to white text in your input captions. For example, if your font color setting is Yellow, and your input captions have red and white text, your output captions will have red and yellow text. When you choose ALL_TEXT, your font color setting applies to all of your output captions text.", "smithy.api#enum": [ { "value": "WHITE_TEXT_ONLY", @@ -5602,7 +5602,7 @@ "com.amazonaws.mediaconvert#DvbSubtitleBackgroundColor": { "type": "string", "traits": { - "smithy.api#documentation": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the color of the rectangle behind the captions. Leave background color (BackgroundColor) blank and set Style passthrough (StylePassthrough) to enabled to use the background color data from your input captions, if present.", "smithy.api#enum": [ { "value": "NONE", @@ -5626,7 +5626,7 @@ "com.amazonaws.mediaconvert#DvbSubtitleFontColor": { "type": "string", "traits": { - "smithy.api#documentation": "Specifies the color of the DVB-SUB captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the color of the captions text. Leave Font color (FontColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#enum": [ { "value": "WHITE", @@ -5666,7 +5666,7 @@ "com.amazonaws.mediaconvert#DvbSubtitleOutlineColor": { "type": "string", "traits": { - "smithy.api#documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify font outline color. Leave Outline color (OutlineColor) blank and set Style passthrough (StylePassthrough) to enabled to use the font outline color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#enum": [ { "value": "BLACK", @@ -5702,7 +5702,7 @@ "com.amazonaws.mediaconvert#DvbSubtitleShadowColor": { "type": "string", "traits": { - "smithy.api#documentation": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#documentation": "Specify the color of the shadow cast by the captions. Leave Shadow color (ShadowColor) blank and set Style passthrough (StylePassthrough) to enabled to use the shadow color data from your input captions, if present. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#enum": [ { "value": "NONE", @@ -5726,7 +5726,7 @@ "com.amazonaws.mediaconvert#DvbSubtitleStylePassthrough": { "type": "string", "traits": { - "smithy.api#documentation": "Choose which set of style and position values the service applies to your output captions. When you choose ENABLED, the service uses the input style and position information from your input. When you choose DISABLED, the service uses any style values that you specify in your output settings. If you don't specify values, the service uses default style and position values. When you choose DISABLED, the service ignores all style and position values from your input.", + "smithy.api#documentation": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use default settings: white text with black outlining, bottom-center positioning, and automatic sizing. Whether you set Style passthrough to enabled or not, you can also choose to manually override any of the individual style and position settings.", "smithy.api#enum": [ { "value": "ENABLED", @@ -5742,7 +5742,7 @@ "com.amazonaws.mediaconvert#DvbSubtitleTeletextSpacing": { "type": "string", "traits": { - "smithy.api#documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", + "smithy.api#documentation": "Specify whether the Text spacing (TextSpacing) in your captions is set by the captions grid, or varies depending on letter width. Choose fixed grid (FIXED_GRID) to conform to the spacing specified in the captions file more accurately. Choose proportional (PROPORTIONAL) to make the text easier to read for closed captions. Within your job settings, all of your DVB-Sub settings must be identical.", "smithy.api#enum": [ { "value": "FIXED_GRID", @@ -6868,7 +6868,7 @@ "Framerate": { "target": "com.amazonaws.mediaconvert#CaptionSourceFramerate", "traits": { - "smithy.api#documentation": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction, using the settings Framerate numerator (framerateNumerator) and Framerate denominator (framerateDenominator). For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps.", + "smithy.api#documentation": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction. When you work directly in your JSON job specification, use the settings framerateNumerator and framerateDenominator. For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps.", "smithy.api#jsonName": "framerate" } }, @@ -6882,15 +6882,38 @@ "TimeDelta": { "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { - "smithy.api#documentation": "Specifies a time delta in seconds to offset the captions from the source file.", + "smithy.api#documentation": "Optional. Use this setting when you need to adjust the sync between your sidecar captions and your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/time-delta-use-cases.html. Enter a positive or negative number to modify the times in the captions file. For example, type 15 to add 15 seconds to all the times in the captions file. Type -5 to subtract 5 seconds from the times in the captions file. You can optionally specify your time delta in milliseconds instead of seconds. When you do so, set the related setting, Time delta units (TimeDeltaUnits) to Milliseconds (MILLISECONDS). Note that, when you specify a time delta for timecode-based caption sources, such as SCC and STL, and your time delta isn't a multiple of the input frame rate, MediaConvert snaps the captions to the nearest frame. For example, when your input video frame rate is 25 fps and you specify 1010ms for time delta, MediaConvert delays your captions by 1000 ms.", "smithy.api#jsonName": "timeDelta" } + }, + "TimeDeltaUnits": { + "target": "com.amazonaws.mediaconvert#FileSourceTimeDeltaUnits", + "traits": { + "smithy.api#documentation": "When you use the setting Time delta (TimeDelta) 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 (TimeDeltaUnits), MediaConvert uses seconds by default.", + "smithy.api#jsonName": "timeDeltaUnits" + } } }, "traits": { "smithy.api#documentation": "If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings." } }, + "com.amazonaws.mediaconvert#FileSourceTimeDeltaUnits": { + "type": "string", + "traits": { + "smithy.api#documentation": "When you use the setting Time delta (TimeDelta) 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 (TimeDeltaUnits), MediaConvert uses seconds by default.", + "smithy.api#enum": [ + { + "value": "SECONDS", + "name": "SECONDS" + }, + { + "value": "MILLISECONDS", + "name": "MILLISECONDS" + } + ] + } + }, "com.amazonaws.mediaconvert#FontScript": { "type": "string", "traits": { @@ -10362,7 +10385,7 @@ "com.amazonaws.mediaconvert#InputSampleRange": { "type": "string", "traits": { - "smithy.api#documentation": "Use this setting when your input video codec is AVC-Intra. Ignore this setting for all other inputs. If the sample range metadata in your input video is accurate, or if you don't know about sample range, keep the default value, Follow (FOLLOW), for this setting. When you do, the service automatically detects your input sample range. If your input video has metadata indicating the wrong sample range, specify the accurate sample range here. When you do, MediaConvert ignores any sample range information in the input metadata. Regardless of whether MediaConvert uses the input sample range or the sample range that you specify, MediaConvert uses the sample range for transcoding and also writes it to the output metadata.", + "smithy.api#documentation": "If the sample range metadata in your input video is accurate, or if you don't know about sample range, keep the default value, Follow (FOLLOW), for this setting. When you do, the service automatically detects your input sample range. If your input video has metadata indicating the wrong sample range, specify the accurate sample range here. When you do, MediaConvert ignores any sample range information in the input metadata. Regardless of whether MediaConvert uses the input sample range or the sample range that you specify, MediaConvert uses the sample range for transcoding and also writes it to the output metadata.", "smithy.api#enum": [ { "value": "FOLLOW", @@ -16678,19 +16701,19 @@ "StylePassthrough": { "target": "com.amazonaws.mediaconvert#SrtStylePassthrough", "traits": { - "smithy.api#documentation": "Choose Enabled (ENABLED) to have MediaConvert use the font style, color, and position information from the captions source in the input. Keep the default value, Disabled (DISABLED), for simplified output captions.", + "smithy.api#documentation": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use simplified output captions.", "smithy.api#jsonName": "stylePassthrough" } } }, "traits": { - "smithy.api#documentation": "SRT Destination Settings" + "smithy.api#documentation": "Settings related to SRT captions. SRT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to SRT." } }, "com.amazonaws.mediaconvert#SrtStylePassthrough": { "type": "string", "traits": { - "smithy.api#documentation": "Choose Enabled (ENABLED) to have MediaConvert use the font style, color, and position information from the captions source in the input. Keep the default value, Disabled (DISABLED), for simplified output captions.", + "smithy.api#documentation": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use simplified output captions.", "smithy.api#enum": [ { "value": "ENABLED", @@ -18150,7 +18173,7 @@ "SampleRange": { "target": "com.amazonaws.mediaconvert#InputSampleRange", "traits": { - "smithy.api#documentation": "Use this setting when your input video codec is AVC-Intra. Ignore this setting for all other inputs. If the sample range metadata in your input video is accurate, or if you don't know about sample range, keep the default value, Follow (FOLLOW), for this setting. When you do, the service automatically detects your input sample range. If your input video has metadata indicating the wrong sample range, specify the accurate sample range here. When you do, MediaConvert ignores any sample range information in the input metadata. Regardless of whether MediaConvert uses the input sample range or the sample range that you specify, MediaConvert uses the sample range for transcoding and also writes it to the output metadata.", + "smithy.api#documentation": "If the sample range metadata in your input video is accurate, or if you don't know about sample range, keep the default value, Follow (FOLLOW), for this setting. When you do, the service automatically detects your input sample range. If your input video has metadata indicating the wrong sample range, specify the accurate sample range here. When you do, MediaConvert ignores any sample range information in the input metadata. Regardless of whether MediaConvert uses the input sample range or the sample range that you specify, MediaConvert uses the sample range for transcoding and also writes it to the output metadata.", "smithy.api#jsonName": "sampleRange" } } @@ -18648,13 +18671,13 @@ "StylePassthrough": { "target": "com.amazonaws.mediaconvert#WebvttStylePassthrough", "traits": { - "smithy.api#documentation": "Choose Enabled (ENABLED) to have MediaConvert use the font style, color, and position information from the captions source in the input. Keep the default value, Disabled (DISABLED), for simplified output captions.", + "smithy.api#documentation": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use simplified output captions.", "smithy.api#jsonName": "stylePassthrough" } } }, "traits": { - "smithy.api#documentation": "WEBVTT Destination Settings" + "smithy.api#documentation": "Settings related to WebVTT captions. WebVTT is a sidecar format that holds captions in a file that is separate from the video container. Set up sidecar captions in the same output group, but different output from your video. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. When you work directly in your JSON job specification, include this object and any required children when you set destinationType to WebVTT." } }, "com.amazonaws.mediaconvert#WebvttHlsSourceSettings": { @@ -18689,7 +18712,7 @@ "com.amazonaws.mediaconvert#WebvttStylePassthrough": { "type": "string", "traits": { - "smithy.api#documentation": "Choose Enabled (ENABLED) to have MediaConvert use the font style, color, and position information from the captions source in the input. Keep the default value, Disabled (DISABLED), for simplified output captions.", + "smithy.api#documentation": "Set Style passthrough (StylePassthrough) to ENABLED to use the available style, color, and position information from your input captions. MediaConvert uses default settings for any missing style and position information in your input captions. Set Style passthrough to DISABLED, or leave blank, to ignore the style and position information from your input captions and use simplified output captions.", "smithy.api#enum": [ { "value": "ENABLED", diff --git a/codegen/sdk/aws-models/mediapackage.2017-10-12.json b/codegen/sdk/aws-models/mediapackage.2017-10-12.json index b2daafbeb02..aeba6134cc3 100644 --- a/codegen/sdk/aws-models/mediapackage.2017-10-12.json +++ b/codegen/sdk/aws-models/mediapackage.2017-10-12.json @@ -1883,6 +1883,13 @@ "smithy.api#jsonName": "encryption" } }, + "IncludeDvbSubtitles": { + "target": "com.amazonaws.mediapackage#__boolean", + "traits": { + "smithy.api#documentation": "When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.", + "smithy.api#jsonName": "includeDvbSubtitles" + } + }, "IncludeIframeOnlyStream": { "target": "com.amazonaws.mediapackage#__boolean", "traits": { diff --git a/codegen/sdk/aws-models/mediapackagevod.2018-11-07.json b/codegen/sdk/aws-models/mediapackagevod.2018-11-07.json index 96f5ea58a79..2a71cf74041 100644 --- a/codegen/sdk/aws-models/mediapackagevod.2018-11-07.json +++ b/codegen/sdk/aws-models/mediapackagevod.2018-11-07.json @@ -1471,6 +1471,13 @@ "smithy.api#required": {} } }, + "IncludeDvbSubtitles": { + "target": "com.amazonaws.mediapackagevod#__boolean", + "traits": { + "smithy.api#documentation": "When enabled, MediaPackage passes through digital video broadcasting (DVB) subtitles into the output.", + "smithy.api#jsonName": "includeDvbSubtitles" + } + }, "SegmentDurationSeconds": { "target": "com.amazonaws.mediapackagevod#__integer", "traits": { diff --git a/codegen/sdk/aws-models/mediatailor.2018-04-23.json b/codegen/sdk/aws-models/mediatailor.2018-04-23.json index 20adafc3665..6a92b0bef20 100644 --- a/codegen/sdk/aws-models/mediatailor.2018-04-23.json +++ b/codegen/sdk/aws-models/mediatailor.2018-04-23.json @@ -153,6 +153,28 @@ "smithy.api#documentation": "Alert configuration parameters.
" } }, + "com.amazonaws.mediatailor#AvailMatchingCriteria": { + "type": "structure", + "members": { + "DynamicVariable": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.
You can include up to 100 dynamic variables.
", + "smithy.api#required": {} + } + }, + "Operator": { + "target": "com.amazonaws.mediatailor#Operator", + "traits": { + "smithy.api#documentation": "For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.
As an example, let's say that you set DynamicVariable to scte.event_id and Operator to EQUALS, and your playback configuration has an ADS URL of https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]. And the prefetch request to the ADS contains these values https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of my-awesome-event, since it must match the event id that MediaTailor uses to query the ADS.
You can specify up to five AvailMatchingCriteria. If you specify multiple AvailMatchingCriteria, MediaTailor combines them to match using a logical AND. You can model logical OR combinations by creating multiple prefetch schedules.
" + } + }, "com.amazonaws.mediatailor#AvailSuppression": { "type": "structure", "members": { @@ -518,6 +540,105 @@ } } }, + "com.amazonaws.mediatailor#CreatePrefetchSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#CreatePrefetchScheduleRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#CreatePrefetchScheduleResponse" + }, + "traits": { + "smithy.api#documentation": "Creates a new prefetch schedule for the specified playback configuration.
", + "smithy.api#http": { + "method": "POST", + "uri": "/prefetchSchedule/{PlaybackConfigurationName}/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.mediatailor#CreatePrefetchScheduleRequest": { + "type": "structure", + "members": { + "Consumption": { + "target": "com.amazonaws.mediatailor#PrefetchConsumption", + "traits": { + "smithy.api#documentation": "The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The identifier for the playback configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PlaybackConfigurationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the playback configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Retrieval": { + "target": "com.amazonaws.mediatailor#PrefetchRetrieval", + "traits": { + "smithy.api#documentation": "The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
", + "smithy.api#required": {} + } + }, + "StreamId": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.
" + } + } + } + }, + "com.amazonaws.mediatailor#CreatePrefetchScheduleResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prefetch schedule.
" + } + }, + "Consumption": { + "target": "com.amazonaws.mediatailor#PrefetchConsumption", + "traits": { + "smithy.api#documentation": "Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
" + } + }, + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
" + } + }, + "PlaybackConfigurationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the playback configuration to create the prefetch schedule for.
" + } + }, + "Retrieval": { + "target": "com.amazonaws.mediatailor#PrefetchRetrieval", + "traits": { + "smithy.api#documentation": "A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
" + } + }, + "StreamId": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
" + } + } + } + }, "com.amazonaws.mediatailor#CreateProgram": { "type": "operation", "input": { @@ -1040,6 +1161,48 @@ "type": "structure", "members": {} }, + "com.amazonaws.mediatailor#DeletePrefetchSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#DeletePrefetchScheduleRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#DeletePrefetchScheduleResponse" + }, + "traits": { + "smithy.api#documentation": "Deletes a prefetch schedule for a specific playback configuration. If you call DeletePrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/prefetchSchedule/{PlaybackConfigurationName}/{Name}", + "code": 204 + } + } + }, + "com.amazonaws.mediatailor#DeletePrefetchScheduleRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The identifier for the playback configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PlaybackConfigurationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the playback configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#DeletePrefetchScheduleResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.mediatailor#DeleteProgram": { "type": "operation", "input": { @@ -1774,6 +1937,85 @@ } } }, + "com.amazonaws.mediatailor#GetPrefetchSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#GetPrefetchScheduleRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#GetPrefetchScheduleResponse" + }, + "traits": { + "smithy.api#documentation": "Returns information about the prefetch schedule for a specific playback configuration. If you call GetPrefetchSchedule on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.
", + "smithy.api#http": { + "method": "GET", + "uri": "/prefetchSchedule/{PlaybackConfigurationName}/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.mediatailor#GetPrefetchScheduleRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The identifier for the playback configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PlaybackConfigurationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the playback configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.mediatailor#GetPrefetchScheduleResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prefetch schedule.
" + } + }, + "Consumption": { + "target": "com.amazonaws.mediatailor#PrefetchConsumption", + "traits": { + "smithy.api#documentation": "Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
" + } + }, + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
" + } + }, + "PlaybackConfigurationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the playback configuration to create the prefetch schedule for.
" + } + }, + "Retrieval": { + "target": "com.amazonaws.mediatailor#PrefetchRetrieval", + "traits": { + "smithy.api#documentation": "A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
" + } + }, + "StreamId": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
" + } + } + } + }, "com.amazonaws.mediatailor#HlsConfiguration": { "type": "structure", "members": { @@ -2040,6 +2282,77 @@ } } }, + "com.amazonaws.mediatailor#ListPrefetchSchedules": { + "type": "operation", + "input": { + "target": "com.amazonaws.mediatailor#ListPrefetchSchedulesRequest" + }, + "output": { + "target": "com.amazonaws.mediatailor#ListPrefetchSchedulesResponse" + }, + "traits": { + "smithy.api#documentation": "Creates a new prefetch schedule.
", + "smithy.api#http": { + "method": "POST", + "uri": "/prefetchSchedule/{PlaybackConfigurationName}", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Items", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.mediatailor#ListPrefetchSchedulesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.mediatailor#__integerMin1Max100", + "traits": { + "smithy.api#documentation": "The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If the playback configuration has more than MaxResults prefetch schedules, use the value of NextToken in the response to get the next page of results.
" + } + }, + "NextToken": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "(Optional) If the playback configuration has more than MaxResults prefetch schedules, use NextToken to get the second and subsequent pages of results.
For the first ListPrefetchSchedulesRequest request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
If the previous response didn't include a NextToken element, there are no more prefetch schedules to get.
" + } + }, + "PlaybackConfigurationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the playback configuration.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StreamId": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.
" + } + } + } + }, + "com.amazonaws.mediatailor#ListPrefetchSchedulesResponse": { + "type": "structure", + "members": { + "Items": { + "target": "com.amazonaws.mediatailor#__listOfPrefetchSchedule", + "traits": { + "smithy.api#documentation": "Lists the prefetch schedules. An empty Items list doesn't mean there aren't more items to fetch, just that that page was empty.
" + } + }, + "NextToken": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The value that you will use forNextToken in the next ListPrefetchSchedulesRequest request.
" + } + } + } + }, "com.amazonaws.mediatailor#ListSourceLocations": { "type": "operation", "input": { @@ -2281,6 +2594,9 @@ { "target": "com.amazonaws.mediatailor#CreateChannel" }, + { + "target": "com.amazonaws.mediatailor#CreatePrefetchSchedule" + }, { "target": "com.amazonaws.mediatailor#CreateProgram" }, @@ -2299,6 +2615,9 @@ { "target": "com.amazonaws.mediatailor#DeletePlaybackConfiguration" }, + { + "target": "com.amazonaws.mediatailor#DeletePrefetchSchedule" + }, { "target": "com.amazonaws.mediatailor#DeleteProgram" }, @@ -2329,6 +2648,9 @@ { "target": "com.amazonaws.mediatailor#GetPlaybackConfiguration" }, + { + "target": "com.amazonaws.mediatailor#GetPrefetchSchedule" + }, { "target": "com.amazonaws.mediatailor#ListAlerts" }, @@ -2338,6 +2660,9 @@ { "target": "com.amazonaws.mediatailor#ListPlaybackConfigurations" }, + { + "target": "com.amazonaws.mediatailor#ListPrefetchSchedules" + }, { "target": "com.amazonaws.mediatailor#ListSourceLocations" }, @@ -2417,6 +2742,17 @@ ] } }, + "com.amazonaws.mediatailor#Operator": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "EQUALS", + "name": "EQUALS" + } + ] + } + }, "com.amazonaws.mediatailor#OriginManifestType": { "type": "string", "traits": { @@ -2570,6 +2906,109 @@ ] } }, + "com.amazonaws.mediatailor#PrefetchConsumption": { + "type": "structure", + "members": { + "AvailMatchingCriteria": { + "target": "com.amazonaws.mediatailor#__listOfAvailMatchingCriteria", + "traits": { + "smithy.api#documentation": "If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.
" + } + }, + "EndTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.
", + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.
" + } + }, + "com.amazonaws.mediatailor#PrefetchRetrieval": { + "type": "structure", + "members": { + "DynamicVariables": { + "target": "com.amazonaws.mediatailor#__mapOf__string", + "traits": { + "smithy.api#documentation": "The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
You intially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.
" + } + }, + "EndTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.
", + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.mediatailor#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.
" + } + }, + "com.amazonaws.mediatailor#PrefetchSchedule": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the prefetch schedule.
", + "smithy.api#required": {} + } + }, + "Consumption": { + "target": "com.amazonaws.mediatailor#PrefetchConsumption", + "traits": { + "smithy.api#documentation": "Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
", + "smithy.api#required": {} + } + }, + "PlaybackConfigurationName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the playback configuration to create the prefetch schedule for.
", + "smithy.api#required": {} + } + }, + "Retrieval": { + "target": "com.amazonaws.mediatailor#PrefetchRetrieval", + "traits": { + "smithy.api#documentation": "A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
", + "smithy.api#required": {} + } + }, + "StreamId": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A complex type that contains prefetch schedule information.
" + } + }, "com.amazonaws.mediatailor#PutChannelPolicy": { "type": "operation", "input": { @@ -3769,6 +4208,15 @@ } } }, + "com.amazonaws.mediatailor#__integerMin1Max100": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.mediatailor#__listOfAdBreak": { "type": "list", "member": { @@ -3781,6 +4229,12 @@ "target": "com.amazonaws.mediatailor#Alert" } }, + "com.amazonaws.mediatailor#__listOfAvailMatchingCriteria": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#AvailMatchingCriteria" + } + }, "com.amazonaws.mediatailor#__listOfChannel": { "type": "list", "member": { @@ -3793,6 +4247,12 @@ "target": "com.amazonaws.mediatailor#PlaybackConfiguration" } }, + "com.amazonaws.mediatailor#__listOfPrefetchSchedule": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#PrefetchSchedule" + } + }, "com.amazonaws.mediatailor#__listOfScheduleAdBreak": { "type": "list", "member": { diff --git a/codegen/sdk/aws-models/panorama.2019-07-24.json b/codegen/sdk/aws-models/panorama.2019-07-24.json new file mode 100644 index 00000000000..c924d997e9d --- /dev/null +++ b/codegen/sdk/aws-models/panorama.2019-07-24.json @@ -0,0 +1,5379 @@ +{ + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.panorama#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The requestor does not have permission to access the target action or resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.panorama#ApplicationInstance": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.panorama#ApplicationInstanceName", + "traits": { + "smithy.api#documentation": "The application instance's name.
" + } + }, + "ApplicationInstanceId": { + "target": "com.amazonaws.panorama#ApplicationInstanceId", + "traits": { + "smithy.api#documentation": "The application instance's ID.
" + } + }, + "DefaultRuntimeContextDevice": { + "target": "com.amazonaws.panorama#DefaultRuntimeContextDevice", + "traits": { + "smithy.api#documentation": "The device's ID.
" + } + }, + "DefaultRuntimeContextDeviceName": { + "target": "com.amazonaws.panorama#DeviceName", + "traits": { + "smithy.api#documentation": "The device's name.
" + } + }, + "Description": { + "target": "com.amazonaws.panorama#Description", + "traits": { + "smithy.api#documentation": "The application instance's description.
" + } + }, + "Status": { + "target": "com.amazonaws.panorama#ApplicationInstanceStatus", + "traits": { + "smithy.api#documentation": "The application instance's status.
" + } + }, + "HealthStatus": { + "target": "com.amazonaws.panorama#ApplicationInstanceHealthStatus", + "traits": { + "smithy.api#documentation": "The application instance's health status.
" + } + }, + "StatusDescription": { + "target": "com.amazonaws.panorama#ApplicationInstanceStatusDescription", + "traits": { + "smithy.api#documentation": "The application instance's status description.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.panorama#TimeStamp", + "traits": { + "smithy.api#documentation": "When the application instance was created.
" + } + }, + "Arn": { + "target": "com.amazonaws.panorama#ApplicationInstanceArn", + "traits": { + "smithy.api#documentation": "The application instance's ARN.
" + } + }, + "Tags": { + "target": "com.amazonaws.panorama#TagMap", + "traits": { + "smithy.api#documentation": "The application instance's tags.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An application instance on a device.
" + } + }, + "com.amazonaws.panorama#ApplicationInstanceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.panorama#ApplicationInstanceHealthStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "ERROR", + "name": "ERROR" + }, + { + "value": "NOT_AVAILABLE", + "name": "NOT_AVAILABLE" + } + ] + } + }, + "com.amazonaws.panorama#ApplicationInstanceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]+$" + } + }, + "com.amazonaws.panorama#ApplicationInstanceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]+$" + } + }, + "com.amazonaws.panorama#ApplicationInstanceStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DEPLOYMENT_PENDING", + "name": "DEPLOYMENT_PENDING" + }, + { + "value": "DEPLOYMENT_REQUESTED", + "name": "DEPLOYMENT_REQUESTED" + }, + { + "value": "DEPLOYMENT_IN_PROGRESS", + "name": "DEPLOYMENT_IN_PROGRESS" + }, + { + "value": "DEPLOYMENT_ERROR", + "name": "DEPLOYMENT_ERROR" + }, + { + "value": "DEPLOYMENT_SUCCEEDED", + "name": "DEPLOYMENT_SUCCEEDED" + }, + { + "value": "REMOVAL_PENDING", + "name": "REMOVAL_PENDING" + }, + { + "value": "REMOVAL_REQUESTED", + "name": "REMOVAL_REQUESTED" + }, + { + "value": "REMOVAL_IN_PROGRESS", + "name": "REMOVAL_IN_PROGRESS" + }, + { + "value": "REMOVAL_FAILED", + "name": "REMOVAL_FAILED" + }, + { + "value": "REMOVAL_SUCCEEDED", + "name": "REMOVAL_SUCCEEDED" + } + ] + } + }, + "com.amazonaws.panorama#ApplicationInstanceStatusDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.panorama#ApplicationInstances": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#ApplicationInstance" + } + }, + "com.amazonaws.panorama#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.panorama#Bucket": { + "type": "string" + }, + "com.amazonaws.panorama#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.panorama#Certificates": { + "type": "blob" + }, + "com.amazonaws.panorama#ClientToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]+$" + } + }, + "com.amazonaws.panorama#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "The resource's ID.
", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "The resource's type.
", + "smithy.api#required": {} + } + }, + "ErrorId": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "A unique ID for the error.
" + } + }, + "ErrorArguments": { + "target": "com.amazonaws.panorama#ConflictExceptionErrorArgumentList", + "traits": { + "smithy.api#documentation": "A list of attributes that led to the exception and their values.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The target resource is in use.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.panorama#ConflictExceptionErrorArgument": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "The error argument's name.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "The error argument's value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A conflict exception error argument.
" + } + }, + "com.amazonaws.panorama#ConflictExceptionErrorArgumentList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#ConflictExceptionErrorArgument" + } + }, + "com.amazonaws.panorama#ConnectionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STATIC_IP", + "name": "STATIC_IP" + }, + { + "value": "DHCP", + "name": "DHCP" + } + ] + } + }, + "com.amazonaws.panorama#CreateApplicationInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#CreateApplicationInstanceRequest" + }, + "output": { + "target": "com.amazonaws.panorama#CreateApplicationInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an application instance and deploys it to a device.
", + "smithy.api#http": { + "method": "POST", + "uri": "/application-instances", + "code": 200 + } + } + }, + "com.amazonaws.panorama#CreateApplicationInstanceRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.panorama#ApplicationInstanceName", + "traits": { + "smithy.api#documentation": "A name for the application instance.
" + } + }, + "Description": { + "target": "com.amazonaws.panorama#Description", + "traits": { + "smithy.api#documentation": "A description for the application instance.
" + } + }, + "ManifestPayload": { + "target": "com.amazonaws.panorama#ManifestPayload", + "traits": { + "smithy.api#documentation": "The application's manifest document.
", + "smithy.api#required": {} + } + }, + "ManifestOverridesPayload": { + "target": "com.amazonaws.panorama#ManifestOverridesPayload", + "traits": { + "smithy.api#documentation": "Setting overrides for the application manifest.
" + } + }, + "ApplicationInstanceIdToReplace": { + "target": "com.amazonaws.panorama#ApplicationInstanceId", + "traits": { + "smithy.api#documentation": "The ID of an application instance to replace with the new instance.
" + } + }, + "RuntimeRoleArn": { + "target": "com.amazonaws.panorama#RuntimeRoleArn", + "traits": { + "smithy.api#documentation": "The ARN of a runtime role for the application instance.
" + } + }, + "DefaultRuntimeContextDevice": { + "target": "com.amazonaws.panorama#DefaultRuntimeContextDevice", + "traits": { + "smithy.api#documentation": "A device's ID.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.panorama#TagMap", + "traits": { + "smithy.api#documentation": "Tags for the application instance.
" + } + } + } + }, + "com.amazonaws.panorama#CreateApplicationInstanceResponse": { + "type": "structure", + "members": { + "ApplicationInstanceId": { + "target": "com.amazonaws.panorama#ApplicationInstanceId", + "traits": { + "smithy.api#documentation": "The application instance's ID.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#CreateJobForDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#CreateJobForDevicesRequest" + }, + "output": { + "target": "com.amazonaws.panorama#CreateJobForDevicesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a job to run on one or more devices.
", + "smithy.api#http": { + "method": "POST", + "uri": "/jobs", + "code": 200 + } + } + }, + "com.amazonaws.panorama#CreateJobForDevicesRequest": { + "type": "structure", + "members": { + "DeviceIds": { + "target": "com.amazonaws.panorama#DeviceIdList", + "traits": { + "smithy.api#documentation": "IDs of target devices.
", + "smithy.api#required": {} + } + }, + "DeviceJobConfig": { + "target": "com.amazonaws.panorama#DeviceJobConfig", + "traits": { + "smithy.api#documentation": "Configuration settings for the job.
", + "smithy.api#required": {} + } + }, + "JobType": { + "target": "com.amazonaws.panorama#JobType", + "traits": { + "smithy.api#documentation": "The type of job to run.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#CreateJobForDevicesResponse": { + "type": "structure", + "members": { + "Jobs": { + "target": "com.amazonaws.panorama#JobList", + "traits": { + "smithy.api#documentation": "A list of jobs.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#CreateNodeFromTemplateJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#CreateNodeFromTemplateJobRequest" + }, + "output": { + "target": "com.amazonaws.panorama#CreateNodeFromTemplateJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a camera stream node.
", + "smithy.api#http": { + "method": "POST", + "uri": "/packages/template-job", + "code": 200 + } + } + }, + "com.amazonaws.panorama#CreateNodeFromTemplateJobRequest": { + "type": "structure", + "members": { + "TemplateType": { + "target": "com.amazonaws.panorama#TemplateType", + "traits": { + "smithy.api#documentation": "The type of node.
", + "smithy.api#required": {} + } + }, + "OutputPackageName": { + "target": "com.amazonaws.panorama#NodePackageName", + "traits": { + "smithy.api#documentation": "An output package name for the node.
", + "smithy.api#required": {} + } + }, + "OutputPackageVersion": { + "target": "com.amazonaws.panorama#NodePackageVersion", + "traits": { + "smithy.api#documentation": "An output package version for the node.
", + "smithy.api#required": {} + } + }, + "NodeName": { + "target": "com.amazonaws.panorama#NodeName", + "traits": { + "smithy.api#documentation": "A name for the node.
", + "smithy.api#required": {} + } + }, + "NodeDescription": { + "target": "com.amazonaws.panorama#Description", + "traits": { + "smithy.api#documentation": "A description for the node.
" + } + }, + "TemplateParameters": { + "target": "com.amazonaws.panorama#TemplateParametersMap", + "traits": { + "smithy.api#documentation": "Template parameters for the node.
", + "smithy.api#required": {} + } + }, + "JobTags": { + "target": "com.amazonaws.panorama#JobTagsList", + "traits": { + "smithy.api#documentation": "Tags for the job.
" + } + } + } + }, + "com.amazonaws.panorama#CreateNodeFromTemplateJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.panorama#JobId", + "traits": { + "smithy.api#documentation": "The job's ID.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#CreatePackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#CreatePackageRequest" + }, + "output": { + "target": "com.amazonaws.panorama#CreatePackageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a package and storage location in an Amazon S3 access point.
", + "smithy.api#http": { + "method": "POST", + "uri": "/packages", + "code": 200 + } + } + }, + "com.amazonaws.panorama#CreatePackageImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#CreatePackageImportJobRequest" + }, + "output": { + "target": "com.amazonaws.panorama#CreatePackageImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Imports a node package.
", + "smithy.api#http": { + "method": "POST", + "uri": "/packages/import-jobs", + "code": 200 + } + } + }, + "com.amazonaws.panorama#CreatePackageImportJobRequest": { + "type": "structure", + "members": { + "JobType": { + "target": "com.amazonaws.panorama#PackageImportJobType", + "traits": { + "smithy.api#documentation": "A job type for the package import job.
", + "smithy.api#required": {} + } + }, + "InputConfig": { + "target": "com.amazonaws.panorama#PackageImportJobInputConfig", + "traits": { + "smithy.api#documentation": "An input config for the package import job.
", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.panorama#PackageImportJobOutputConfig", + "traits": { + "smithy.api#documentation": "An output config for the package import job.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.panorama#ClientToken", + "traits": { + "smithy.api#documentation": "A client token for the package import job.
", + "smithy.api#required": {} + } + }, + "JobTags": { + "target": "com.amazonaws.panorama#JobTagsList", + "traits": { + "smithy.api#documentation": "Tags for the package import job.
" + } + } + } + }, + "com.amazonaws.panorama#CreatePackageImportJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.panorama#JobId", + "traits": { + "smithy.api#documentation": "The job's ID.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#CreatePackageRequest": { + "type": "structure", + "members": { + "PackageName": { + "target": "com.amazonaws.panorama#NodePackageName", + "traits": { + "smithy.api#documentation": "A name for the package.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.panorama#TagMap", + "traits": { + "smithy.api#documentation": "Tags for the package.
" + } + } + } + }, + "com.amazonaws.panorama#CreatePackageResponse": { + "type": "structure", + "members": { + "PackageId": { + "target": "com.amazonaws.panorama#NodePackageId", + "traits": { + "smithy.api#documentation": "The package's ID.
" + } + }, + "Arn": { + "target": "com.amazonaws.panorama#NodePackageArn", + "traits": { + "smithy.api#documentation": "The package's ARN.
" + } + }, + "StorageLocation": { + "target": "com.amazonaws.panorama#StorageLocation", + "traits": { + "smithy.api#documentation": "The package's storage location.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#CreatedTime": { + "type": "timestamp" + }, + "com.amazonaws.panorama#CurrentSoftware": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.panorama#DefaultGateway": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.panorama#DefaultRuntimeContextDevice": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]+$" + } + }, + "com.amazonaws.panorama#DeleteDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#DeleteDeviceRequest" + }, + "output": { + "target": "com.amazonaws.panorama#DeleteDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a device.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/devices/{DeviceId}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#DeleteDeviceRequest": { + "type": "structure", + "members": { + "DeviceId": { + "target": "com.amazonaws.panorama#DeviceId", + "traits": { + "smithy.api#documentation": "The device's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#DeleteDeviceResponse": { + "type": "structure", + "members": { + "DeviceId": { + "target": "com.amazonaws.panorama#DeviceId", + "traits": { + "smithy.api#documentation": "The device's ID.
" + } + } + } + }, + "com.amazonaws.panorama#DeletePackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#DeletePackageRequest" + }, + "output": { + "target": "com.amazonaws.panorama#DeletePackageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a package.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/packages/{PackageId}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#DeletePackageRequest": { + "type": "structure", + "members": { + "PackageId": { + "target": "com.amazonaws.panorama#NodePackageId", + "traits": { + "smithy.api#documentation": "The package's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ForceDelete": { + "target": "com.amazonaws.panorama#Boolean", + "traits": { + "smithy.api#documentation": "Delete the package even if it has artifacts stored in its access point.\n Deletes the package's artifacts from Amazon S3.
", + "smithy.api#httpQuery": "ForceDelete" + } + } + } + }, + "com.amazonaws.panorama#DeletePackageResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.panorama#DeregisterPackageVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#DeregisterPackageVersionRequest" + }, + "output": { + "target": "com.amazonaws.panorama#DeregisterPackageVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deregisters a package version.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/packages/{PackageId}/versions/{PackageVersion}/patch/{PatchVersion}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#DeregisterPackageVersionRequest": { + "type": "structure", + "members": { + "OwnerAccount": { + "target": "com.amazonaws.panorama#PackageOwnerAccount", + "traits": { + "smithy.api#documentation": "An owner account.
", + "smithy.api#httpQuery": "OwnerAccount" + } + }, + "PackageId": { + "target": "com.amazonaws.panorama#NodePackageId", + "traits": { + "smithy.api#documentation": "A package ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PackageVersion": { + "target": "com.amazonaws.panorama#NodePackageVersion", + "traits": { + "smithy.api#documentation": "A package version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PatchVersion": { + "target": "com.amazonaws.panorama#NodePackagePatchVersion", + "traits": { + "smithy.api#documentation": "A patch version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UpdatedLatestPatchVersion": { + "target": "com.amazonaws.panorama#NodePackagePatchVersion", + "traits": { + "smithy.api#documentation": "If the version was marked latest, the new version to maker as latest.
", + "smithy.api#httpQuery": "UpdatedLatestPatchVersion" + } + } + } + }, + "com.amazonaws.panorama#DeregisterPackageVersionResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.panorama#DescribeApplicationInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#DescribeApplicationInstanceRequest" + }, + "output": { + "target": "com.amazonaws.panorama#DescribeApplicationInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about an application instance on a device.
", + "smithy.api#http": { + "method": "GET", + "uri": "/application-instances/{ApplicationInstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#DescribeApplicationInstanceDetails": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#DescribeApplicationInstanceDetailsRequest" + }, + "output": { + "target": "com.amazonaws.panorama#DescribeApplicationInstanceDetailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about an application instance's configuration manifest.
", + "smithy.api#http": { + "method": "GET", + "uri": "/application-instances/{ApplicationInstanceId}/details", + "code": 200 + } + } + }, + "com.amazonaws.panorama#DescribeApplicationInstanceDetailsRequest": { + "type": "structure", + "members": { + "ApplicationInstanceId": { + "target": "com.amazonaws.panorama#ApplicationInstanceId", + "traits": { + "smithy.api#documentation": "The application instance's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#DescribeApplicationInstanceDetailsResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.panorama#ApplicationInstanceName", + "traits": { + "smithy.api#documentation": "The application instance's name.
" + } + }, + "Description": { + "target": "com.amazonaws.panorama#Description", + "traits": { + "smithy.api#documentation": "The application instance's description.
" + } + }, + "DefaultRuntimeContextDevice": { + "target": "com.amazonaws.panorama#DefaultRuntimeContextDevice", + "traits": { + "smithy.api#documentation": "The application instance's default runtime context device.
" + } + }, + "ManifestPayload": { + "target": "com.amazonaws.panorama#ManifestPayload", + "traits": { + "smithy.api#documentation": "The application instance's configuration manifest.
" + } + }, + "ManifestOverridesPayload": { + "target": "com.amazonaws.panorama#ManifestOverridesPayload", + "traits": { + "smithy.api#documentation": "Parameter overrides for the configuration manifest.
" + } + }, + "ApplicationInstanceIdToReplace": { + "target": "com.amazonaws.panorama#ApplicationInstanceId", + "traits": { + "smithy.api#documentation": "The ID of the application instance that this instance replaced.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.panorama#TimeStamp", + "traits": { + "smithy.api#documentation": "When the application instance was created.
" + } + }, + "ApplicationInstanceId": { + "target": "com.amazonaws.panorama#ApplicationInstanceId", + "traits": { + "smithy.api#documentation": "The application instance's ID.
" + } + } + } + }, + "com.amazonaws.panorama#DescribeApplicationInstanceRequest": { + "type": "structure", + "members": { + "ApplicationInstanceId": { + "target": "com.amazonaws.panorama#ApplicationInstanceId", + "traits": { + "smithy.api#documentation": "The application instance's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#DescribeApplicationInstanceResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.panorama#ApplicationInstanceName", + "traits": { + "smithy.api#documentation": "The application instance's name.
" + } + }, + "Description": { + "target": "com.amazonaws.panorama#Description", + "traits": { + "smithy.api#documentation": "The application instance's description.
" + } + }, + "DefaultRuntimeContextDevice": { + "target": "com.amazonaws.panorama#DefaultRuntimeContextDevice", + "traits": { + "smithy.api#documentation": "The device's ID.
" + } + }, + "DefaultRuntimeContextDeviceName": { + "target": "com.amazonaws.panorama#DeviceName", + "traits": { + "smithy.api#documentation": "The device's bane.
" + } + }, + "ApplicationInstanceIdToReplace": { + "target": "com.amazonaws.panorama#ApplicationInstanceId", + "traits": { + "smithy.api#documentation": "The ID of the application instance that this instance replaced.
" + } + }, + "RuntimeRoleArn": { + "target": "com.amazonaws.panorama#RuntimeRoleArn", + "traits": { + "smithy.api#documentation": "The application instance's runtime role ARN.
" + } + }, + "Status": { + "target": "com.amazonaws.panorama#ApplicationInstanceStatus", + "traits": { + "smithy.api#documentation": "The application instance's status.
" + } + }, + "HealthStatus": { + "target": "com.amazonaws.panorama#ApplicationInstanceHealthStatus", + "traits": { + "smithy.api#documentation": "The application instance's health status.
" + } + }, + "StatusDescription": { + "target": "com.amazonaws.panorama#ApplicationInstanceStatusDescription", + "traits": { + "smithy.api#documentation": "The application instance's status description.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.panorama#TimeStamp", + "traits": { + "smithy.api#documentation": "When the application instance was created.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.panorama#TimeStamp", + "traits": { + "smithy.api#documentation": "The application instance was updated.
" + } + }, + "ApplicationInstanceId": { + "target": "com.amazonaws.panorama#ApplicationInstanceId", + "traits": { + "smithy.api#documentation": "The application instance's ID.
" + } + }, + "Arn": { + "target": "com.amazonaws.panorama#ApplicationInstanceArn", + "traits": { + "smithy.api#documentation": "The application instance's ARN.
" + } + }, + "Tags": { + "target": "com.amazonaws.panorama#TagMap", + "traits": { + "smithy.api#documentation": "The application instance's tags.
" + } + } + } + }, + "com.amazonaws.panorama#DescribeDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#DescribeDeviceRequest" + }, + "output": { + "target": "com.amazonaws.panorama#DescribeDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a device.
", + "smithy.api#http": { + "method": "GET", + "uri": "/devices/{DeviceId}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#DescribeDeviceJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#DescribeDeviceJobRequest" + }, + "output": { + "target": "com.amazonaws.panorama#DescribeDeviceJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a device job.
", + "smithy.api#http": { + "method": "GET", + "uri": "/jobs/{JobId}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#DescribeDeviceJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.panorama#JobId", + "traits": { + "smithy.api#documentation": "The job's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#DescribeDeviceJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.panorama#JobId", + "traits": { + "smithy.api#documentation": "The job's ID.
" + } + }, + "DeviceId": { + "target": "com.amazonaws.panorama#DeviceId", + "traits": { + "smithy.api#documentation": "The device's ID.
" + } + }, + "DeviceArn": { + "target": "com.amazonaws.panorama#DeviceArn", + "traits": { + "smithy.api#documentation": "The device's ARN.
" + } + }, + "DeviceName": { + "target": "com.amazonaws.panorama#DeviceName", + "traits": { + "smithy.api#documentation": "The device's name.
" + } + }, + "DeviceType": { + "target": "com.amazonaws.panorama#DeviceType", + "traits": { + "smithy.api#documentation": "The device's type.
" + } + }, + "ImageVersion": { + "target": "com.amazonaws.panorama#ImageVersion", + "traits": { + "smithy.api#documentation": "For an OTA job, the target version of the device software.
" + } + }, + "Status": { + "target": "com.amazonaws.panorama#UpdateProgress", + "traits": { + "smithy.api#documentation": "The job's status.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.panorama#UpdateCreatedTime", + "traits": { + "smithy.api#documentation": "When the job was created.
" + } + } + } + }, + "com.amazonaws.panorama#DescribeDeviceRequest": { + "type": "structure", + "members": { + "DeviceId": { + "target": "com.amazonaws.panorama#DeviceId", + "traits": { + "smithy.api#documentation": "The device's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#DescribeDeviceResponse": { + "type": "structure", + "members": { + "DeviceId": { + "target": "com.amazonaws.panorama#DeviceId", + "traits": { + "smithy.api#documentation": "The device's ID.
" + } + }, + "Name": { + "target": "com.amazonaws.panorama#DeviceName", + "traits": { + "smithy.api#documentation": "The device's name.
" + } + }, + "Arn": { + "target": "com.amazonaws.panorama#DeviceArn", + "traits": { + "smithy.api#documentation": "The device's ARN.
" + } + }, + "Description": { + "target": "com.amazonaws.panorama#Description", + "traits": { + "smithy.api#documentation": "The device's description.
" + } + }, + "Type": { + "target": "com.amazonaws.panorama#DeviceType", + "traits": { + "smithy.api#documentation": "The device's type.
" + } + }, + "DeviceConnectionStatus": { + "target": "com.amazonaws.panorama#DeviceConnectionStatus", + "traits": { + "smithy.api#documentation": "The device's connection status.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.panorama#CreatedTime", + "traits": { + "smithy.api#documentation": "When the device was created.
" + } + }, + "ProvisioningStatus": { + "target": "com.amazonaws.panorama#DeviceStatus", + "traits": { + "smithy.api#documentation": "The device's provisioning status.
" + } + }, + "LatestSoftware": { + "target": "com.amazonaws.panorama#LatestSoftware", + "traits": { + "smithy.api#documentation": "The latest software version available for the device.
" + } + }, + "CurrentSoftware": { + "target": "com.amazonaws.panorama#CurrentSoftware", + "traits": { + "smithy.api#documentation": "The device's current software version.
" + } + }, + "SerialNumber": { + "target": "com.amazonaws.panorama#DeviceSerialNumber", + "traits": { + "smithy.api#documentation": "The device's serial number.
" + } + }, + "Tags": { + "target": "com.amazonaws.panorama#TagMap", + "traits": { + "smithy.api#documentation": "The device's tags.
" + } + }, + "NetworkingConfiguration": { + "target": "com.amazonaws.panorama#NetworkPayload", + "traits": { + "smithy.api#documentation": "The device's networking configuration.
" + } + }, + "CurrentNetworkingStatus": { + "target": "com.amazonaws.panorama#NetworkStatus", + "traits": { + "smithy.api#documentation": "The device's networking status.
" + } + }, + "LeaseExpirationTime": { + "target": "com.amazonaws.panorama#LeaseExpirationTime", + "traits": { + "smithy.api#documentation": "The device's lease expiration time.
" + } + } + } + }, + "com.amazonaws.panorama#DescribeNode": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#DescribeNodeRequest" + }, + "output": { + "target": "com.amazonaws.panorama#DescribeNodeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a node.
", + "smithy.api#http": { + "method": "GET", + "uri": "/nodes/{NodeId}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#DescribeNodeFromTemplateJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#DescribeNodeFromTemplateJobRequest" + }, + "output": { + "target": "com.amazonaws.panorama#DescribeNodeFromTemplateJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a job to create a camera stream node.
", + "smithy.api#http": { + "method": "GET", + "uri": "/packages/template-job/{JobId}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#DescribeNodeFromTemplateJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.panorama#JobId", + "traits": { + "smithy.api#documentation": "The job's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#DescribeNodeFromTemplateJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.panorama#JobId", + "traits": { + "smithy.api#documentation": "The job's ID.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.panorama#NodeFromTemplateJobStatus", + "traits": { + "smithy.api#documentation": "The job's status.
", + "smithy.api#required": {} + } + }, + "StatusMessage": { + "target": "com.amazonaws.panorama#NodeFromTemplateJobStatusMessage", + "traits": { + "smithy.api#documentation": "The job's status message.
", + "smithy.api#required": {} + } + }, + "CreatedTime": { + "target": "com.amazonaws.panorama#CreatedTime", + "traits": { + "smithy.api#documentation": "When the job was created.
", + "smithy.api#required": {} + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.panorama#LastUpdatedTime", + "traits": { + "smithy.api#documentation": "When the job was updated.
", + "smithy.api#required": {} + } + }, + "OutputPackageName": { + "target": "com.amazonaws.panorama#NodePackageName", + "traits": { + "smithy.api#documentation": "The job's output package name.
", + "smithy.api#required": {} + } + }, + "OutputPackageVersion": { + "target": "com.amazonaws.panorama#NodePackageVersion", + "traits": { + "smithy.api#documentation": "The job's output package version.
", + "smithy.api#required": {} + } + }, + "NodeName": { + "target": "com.amazonaws.panorama#NodeName", + "traits": { + "smithy.api#documentation": "The node's name.
", + "smithy.api#required": {} + } + }, + "NodeDescription": { + "target": "com.amazonaws.panorama#Description", + "traits": { + "smithy.api#documentation": "The node's description.
" + } + }, + "TemplateType": { + "target": "com.amazonaws.panorama#TemplateType", + "traits": { + "smithy.api#documentation": "The job's template type.
", + "smithy.api#required": {} + } + }, + "TemplateParameters": { + "target": "com.amazonaws.panorama#TemplateParametersMap", + "traits": { + "smithy.api#documentation": "The job's template parameters.
", + "smithy.api#required": {} + } + }, + "JobTags": { + "target": "com.amazonaws.panorama#JobTagsList", + "traits": { + "smithy.api#documentation": "The job's tags.
" + } + } + } + }, + "com.amazonaws.panorama#DescribeNodeRequest": { + "type": "structure", + "members": { + "NodeId": { + "target": "com.amazonaws.panorama#NodeId", + "traits": { + "smithy.api#documentation": "The node's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "OwnerAccount": { + "target": "com.amazonaws.panorama#PackageOwnerAccount", + "traits": { + "smithy.api#documentation": "The account ID of the node's owner.
", + "smithy.api#httpQuery": "OwnerAccount" + } + } + } + }, + "com.amazonaws.panorama#DescribeNodeResponse": { + "type": "structure", + "members": { + "NodeId": { + "target": "com.amazonaws.panorama#NodeId", + "traits": { + "smithy.api#documentation": "The node's ID.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.panorama#NodeName", + "traits": { + "smithy.api#documentation": "The node's name.
", + "smithy.api#required": {} + } + }, + "Category": { + "target": "com.amazonaws.panorama#NodeCategory", + "traits": { + "smithy.api#documentation": "The node's category.
", + "smithy.api#required": {} + } + }, + "OwnerAccount": { + "target": "com.amazonaws.panorama#PackageOwnerAccount", + "traits": { + "smithy.api#documentation": "The account ID of the node's owner.
", + "smithy.api#required": {} + } + }, + "PackageName": { + "target": "com.amazonaws.panorama#NodePackageName", + "traits": { + "smithy.api#documentation": "The node's package name.
", + "smithy.api#required": {} + } + }, + "PackageId": { + "target": "com.amazonaws.panorama#NodePackageId", + "traits": { + "smithy.api#documentation": "The node's package ID.
", + "smithy.api#required": {} + } + }, + "PackageArn": { + "target": "com.amazonaws.panorama#NodePackageArn", + "traits": { + "smithy.api#documentation": "The node's ARN.
" + } + }, + "PackageVersion": { + "target": "com.amazonaws.panorama#NodePackageVersion", + "traits": { + "smithy.api#documentation": "The node's package version.
", + "smithy.api#required": {} + } + }, + "PatchVersion": { + "target": "com.amazonaws.panorama#NodePackagePatchVersion", + "traits": { + "smithy.api#documentation": "The node's patch version.
", + "smithy.api#required": {} + } + }, + "NodeInterface": { + "target": "com.amazonaws.panorama#NodeInterface", + "traits": { + "smithy.api#documentation": "The node's interface.
", + "smithy.api#required": {} + } + }, + "AssetName": { + "target": "com.amazonaws.panorama#NodeAssetName", + "traits": { + "smithy.api#documentation": "The node's asset name.
" + } + }, + "Description": { + "target": "com.amazonaws.panorama#Description", + "traits": { + "smithy.api#documentation": "The node's description.
", + "smithy.api#required": {} + } + }, + "CreatedTime": { + "target": "com.amazonaws.panorama#TimeStamp", + "traits": { + "smithy.api#documentation": "When the node was created.
", + "smithy.api#required": {} + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.panorama#TimeStamp", + "traits": { + "smithy.api#documentation": "When the node was updated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#DescribePackage": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#DescribePackageRequest" + }, + "output": { + "target": "com.amazonaws.panorama#DescribePackageResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a package.
", + "smithy.api#http": { + "method": "GET", + "uri": "/packages/metadata/{PackageId}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#DescribePackageImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#DescribePackageImportJobRequest" + }, + "output": { + "target": "com.amazonaws.panorama#DescribePackageImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a package import job.
", + "smithy.api#http": { + "method": "GET", + "uri": "/packages/import-jobs/{JobId}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#DescribePackageImportJobRequest": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.panorama#JobId", + "traits": { + "smithy.api#documentation": "The job's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#DescribePackageImportJobResponse": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.panorama#JobId", + "traits": { + "smithy.api#documentation": "The job's ID.
", + "smithy.api#required": {} + } + }, + "ClientToken": { + "target": "com.amazonaws.panorama#ClientToken", + "traits": { + "smithy.api#documentation": "The job's client token.
" + } + }, + "JobType": { + "target": "com.amazonaws.panorama#PackageImportJobType", + "traits": { + "smithy.api#documentation": "The job's type.
", + "smithy.api#required": {} + } + }, + "InputConfig": { + "target": "com.amazonaws.panorama#PackageImportJobInputConfig", + "traits": { + "smithy.api#documentation": "The job's input config.
", + "smithy.api#required": {} + } + }, + "OutputConfig": { + "target": "com.amazonaws.panorama#PackageImportJobOutputConfig", + "traits": { + "smithy.api#documentation": "The job's output config.
", + "smithy.api#required": {} + } + }, + "Output": { + "target": "com.amazonaws.panorama#PackageImportJobOutput", + "traits": { + "smithy.api#documentation": "The job's output.
", + "smithy.api#required": {} + } + }, + "CreatedTime": { + "target": "com.amazonaws.panorama#CreatedTime", + "traits": { + "smithy.api#documentation": "When the job was created.
", + "smithy.api#required": {} + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.panorama#LastUpdatedTime", + "traits": { + "smithy.api#documentation": "When the job was updated.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.panorama#PackageImportJobStatus", + "traits": { + "smithy.api#documentation": "The job's status.
", + "smithy.api#required": {} + } + }, + "StatusMessage": { + "target": "com.amazonaws.panorama#PackageImportJobStatusMessage", + "traits": { + "smithy.api#documentation": "The job's status message.
", + "smithy.api#required": {} + } + }, + "JobTags": { + "target": "com.amazonaws.panorama#JobTagsList", + "traits": { + "smithy.api#documentation": "The job's tags.
" + } + } + } + }, + "com.amazonaws.panorama#DescribePackageRequest": { + "type": "structure", + "members": { + "PackageId": { + "target": "com.amazonaws.panorama#NodePackageId", + "traits": { + "smithy.api#documentation": "The package's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#DescribePackageResponse": { + "type": "structure", + "members": { + "PackageId": { + "target": "com.amazonaws.panorama#NodePackageId", + "traits": { + "smithy.api#documentation": "The package's ID.
", + "smithy.api#required": {} + } + }, + "PackageName": { + "target": "com.amazonaws.panorama#NodePackageName", + "traits": { + "smithy.api#documentation": "The package's name.
", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.panorama#NodePackageArn", + "traits": { + "smithy.api#documentation": "The package's ARN.
", + "smithy.api#required": {} + } + }, + "StorageLocation": { + "target": "com.amazonaws.panorama#StorageLocation", + "traits": { + "smithy.api#documentation": "The package's storage location.
", + "smithy.api#required": {} + } + }, + "ReadAccessPrincipalArns": { + "target": "com.amazonaws.panorama#PrincipalArnsList", + "traits": { + "smithy.api#documentation": "ARNs of accounts that have read access to the package.
" + } + }, + "WriteAccessPrincipalArns": { + "target": "com.amazonaws.panorama#PrincipalArnsList", + "traits": { + "smithy.api#documentation": "ARNs of accounts that have write access to the package.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.panorama#TimeStamp", + "traits": { + "smithy.api#documentation": "When the package was created.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.panorama#TagMap", + "traits": { + "smithy.api#documentation": "The package's tags.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#DescribePackageVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#DescribePackageVersionRequest" + }, + "output": { + "target": "com.amazonaws.panorama#DescribePackageVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a package version.
", + "smithy.api#http": { + "method": "GET", + "uri": "/packages/metadata/{PackageId}/versions/{PackageVersion}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#DescribePackageVersionRequest": { + "type": "structure", + "members": { + "OwnerAccount": { + "target": "com.amazonaws.panorama#PackageOwnerAccount", + "traits": { + "smithy.api#documentation": "The version's owner account.
", + "smithy.api#httpQuery": "OwnerAccount" + } + }, + "PackageId": { + "target": "com.amazonaws.panorama#NodePackageId", + "traits": { + "smithy.api#documentation": "The version's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PackageVersion": { + "target": "com.amazonaws.panorama#NodePackageVersion", + "traits": { + "smithy.api#documentation": "The version's version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PatchVersion": { + "target": "com.amazonaws.panorama#NodePackagePatchVersion", + "traits": { + "smithy.api#documentation": "The version's patch version.
", + "smithy.api#httpQuery": "PatchVersion" + } + } + } + }, + "com.amazonaws.panorama#DescribePackageVersionResponse": { + "type": "structure", + "members": { + "OwnerAccount": { + "target": "com.amazonaws.panorama#PackageOwnerAccount", + "traits": { + "smithy.api#documentation": "The account ID of the version's owner.
" + } + }, + "PackageId": { + "target": "com.amazonaws.panorama#NodePackageId", + "traits": { + "smithy.api#documentation": "The version's ID.
", + "smithy.api#required": {} + } + }, + "PackageArn": { + "target": "com.amazonaws.panorama#NodePackageArn", + "traits": { + "smithy.api#documentation": "The ARN of the package.
" + } + }, + "PackageName": { + "target": "com.amazonaws.panorama#NodePackageName", + "traits": { + "smithy.api#documentation": "The version's name.
", + "smithy.api#required": {} + } + }, + "PackageVersion": { + "target": "com.amazonaws.panorama#NodePackageVersion", + "traits": { + "smithy.api#documentation": "The version's version.
", + "smithy.api#required": {} + } + }, + "PatchVersion": { + "target": "com.amazonaws.panorama#NodePackagePatchVersion", + "traits": { + "smithy.api#documentation": "The version's patch version.
", + "smithy.api#required": {} + } + }, + "IsLatestPatch": { + "target": "com.amazonaws.panorama#Boolean", + "traits": { + "smithy.api#documentation": "Whether the version is the latest available.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.panorama#PackageVersionStatus", + "traits": { + "smithy.api#documentation": "The version's status.
", + "smithy.api#required": {} + } + }, + "StatusDescription": { + "target": "com.amazonaws.panorama#PackageVersionStatusDescription", + "traits": { + "smithy.api#documentation": "The version's status description.
" + } + }, + "RegisteredTime": { + "target": "com.amazonaws.panorama#TimeStamp", + "traits": { + "smithy.api#documentation": "The version's registered time.
" + } + } + } + }, + "com.amazonaws.panorama#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.panorama#Device": { + "type": "structure", + "members": { + "DeviceId": { + "target": "com.amazonaws.panorama#DeviceId", + "traits": { + "smithy.api#documentation": "The device's ID.
" + } + }, + "Name": { + "target": "com.amazonaws.panorama#DeviceName", + "traits": { + "smithy.api#documentation": "The device's name.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.panorama#CreatedTime", + "traits": { + "smithy.api#documentation": "When the device was created.
" + } + }, + "ProvisioningStatus": { + "target": "com.amazonaws.panorama#DeviceStatus", + "traits": { + "smithy.api#documentation": "The device's provisioning status.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.panorama#LastUpdatedTime", + "traits": { + "smithy.api#documentation": "When the device was updated.
" + } + }, + "LeaseExpirationTime": { + "target": "com.amazonaws.panorama#LeaseExpirationTime", + "traits": { + "smithy.api#documentation": "The device's lease expiration time.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A device.
" + } + }, + "com.amazonaws.panorama#DeviceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.panorama#DeviceConnectionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ONLINE", + "name": "ONLINE" + }, + { + "value": "OFFLINE", + "name": "OFFLINE" + }, + { + "value": "AWAITING_CREDENTIALS", + "name": "AWAITING_CREDENTIALS" + }, + { + "value": "NOT_AVAILABLE", + "name": "NOT_AVAILABLE" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.panorama#DeviceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]+$" + } + }, + "com.amazonaws.panorama#DeviceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#DeviceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.panorama#DeviceJob": { + "type": "structure", + "members": { + "DeviceName": { + "target": "com.amazonaws.panorama#DeviceName", + "traits": { + "smithy.api#documentation": "The name of the target device
" + } + }, + "DeviceId": { + "target": "com.amazonaws.panorama#DeviceId", + "traits": { + "smithy.api#documentation": "The ID of the target device.
" + } + }, + "JobId": { + "target": "com.amazonaws.panorama#JobId", + "traits": { + "smithy.api#documentation": "The job's ID.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.panorama#CreatedTime", + "traits": { + "smithy.api#documentation": "When the job was created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A job that runs on a device.
" + } + }, + "com.amazonaws.panorama#DeviceJobConfig": { + "type": "structure", + "members": { + "OTAJobConfig": { + "target": "com.amazonaws.panorama#OTAJobConfig", + "traits": { + "smithy.api#documentation": "A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A job's configuration.
" + } + }, + "com.amazonaws.panorama#DeviceJobList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#DeviceJob" + } + }, + "com.amazonaws.panorama#DeviceList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#Device" + } + }, + "com.amazonaws.panorama#DeviceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]+$" + } + }, + "com.amazonaws.panorama#DeviceSerialNumber": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[0-9]{1,20}$" + } + }, + "com.amazonaws.panorama#DeviceStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWAITING_PROVISIONING", + "name": "AWAITING_PROVISIONING" + }, + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "ERROR", + "name": "ERROR" + }, + { + "value": "DELETING", + "name": "DELETING" + } + ] + } + }, + "com.amazonaws.panorama#DeviceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PANORAMA_APPLIANCE_DEVELOPER_KIT", + "name": "PANORAMA_APPLIANCE_DEVELOPER_KIT" + }, + { + "value": "PANORAMA_APPLIANCE", + "name": "PANORAMA_APPLIANCE" + } + ] + } + }, + "com.amazonaws.panorama#Dns": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.panorama#DnsList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#Dns" + } + }, + "com.amazonaws.panorama#EthernetPayload": { + "type": "structure", + "members": { + "ConnectionType": { + "target": "com.amazonaws.panorama#ConnectionType", + "traits": { + "smithy.api#documentation": "How the device gets an IP address.
", + "smithy.api#required": {} + } + }, + "StaticIpConnectionInfo": { + "target": "com.amazonaws.panorama#StaticIpConnectionInfo", + "traits": { + "smithy.api#documentation": "Network configuration for a static IP connection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A device's network configuration.
" + } + }, + "com.amazonaws.panorama#EthernetStatus": { + "type": "structure", + "members": { + "IpAddress": { + "target": "com.amazonaws.panorama#IpAddress", + "traits": { + "smithy.api#documentation": "The device's IP address.
" + } + }, + "ConnectionStatus": { + "target": "com.amazonaws.panorama#NetworkConnectionStatus", + "traits": { + "smithy.api#documentation": "The device's connection status.
" + } + }, + "HwAddress": { + "target": "com.amazonaws.panorama#HwAddress", + "traits": { + "smithy.api#documentation": "The device's physical address.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A device's Ethernet status.
" + } + }, + "com.amazonaws.panorama#HwAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.panorama#ImageVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.panorama#InputPortList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#NodeInputPort" + } + }, + "com.amazonaws.panorama#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#required": {} + } + }, + "RetryAfterSeconds": { + "target": "com.amazonaws.panorama#RetryAfterSeconds", + "traits": { + "smithy.api#documentation": "The number of seconds a client should wait before retrying the call.
", + "smithy.api#httpHeader": "Retry-After" + } + } + }, + "traits": { + "smithy.api#documentation": "An internal error occurred.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.panorama#IotThingName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.panorama#IpAddress": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d))(:(6553[0-5]|655[0-2]\\d|65[0-4]\\d{2}|6[0-4]\\d{3}|[1-5]\\d{4}|[1-9]\\d{0,3}))?$" + } + }, + "com.amazonaws.panorama#Job": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.panorama#JobId", + "traits": { + "smithy.api#documentation": "The job's ID.
" + } + }, + "DeviceId": { + "target": "com.amazonaws.panorama#DeviceId", + "traits": { + "smithy.api#documentation": "The target device's ID.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A job for a device.
" + } + }, + "com.amazonaws.panorama#JobId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]+$" + } + }, + "com.amazonaws.panorama#JobList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#Job" + } + }, + "com.amazonaws.panorama#JobResourceTags": { + "type": "structure", + "members": { + "ResourceType": { + "target": "com.amazonaws.panorama#JobResourceType", + "traits": { + "smithy.api#documentation": "The job's type.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.panorama#TagMap", + "traits": { + "smithy.api#documentation": "The job's tags.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Tags for a job.
" + } + }, + "com.amazonaws.panorama#JobResourceType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PACKAGE", + "name": "PACKAGE" + } + ] + } + }, + "com.amazonaws.panorama#JobTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#JobResourceTags" + } + }, + "com.amazonaws.panorama#JobType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OTA", + "name": "OTA" + } + ] + } + }, + "com.amazonaws.panorama#LastUpdatedTime": { + "type": "timestamp" + }, + "com.amazonaws.panorama#LatestSoftware": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.panorama#LeaseExpirationTime": { + "type": "timestamp" + }, + "com.amazonaws.panorama#ListApplicationInstanceDependencies": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#ListApplicationInstanceDependenciesRequest" + }, + "output": { + "target": "com.amazonaws.panorama#ListApplicationInstanceDependenciesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of application instance dependencies.
", + "smithy.api#http": { + "method": "GET", + "uri": "/application-instances/{ApplicationInstanceId}/package-dependencies", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.panorama#ListApplicationInstanceDependenciesRequest": { + "type": "structure", + "members": { + "ApplicationInstanceId": { + "target": "com.amazonaws.panorama#ApplicationInstanceId", + "traits": { + "smithy.api#documentation": "The application instance's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.panorama#MaxSize25", + "traits": { + "smithy.api#documentation": "The maximum number of application instance dependencies to return in one page of results.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.panorama#NextToken", + "traits": { + "smithy.api#documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.panorama#ListApplicationInstanceDependenciesResponse": { + "type": "structure", + "members": { + "PackageObjects": { + "target": "com.amazonaws.panorama#PackageObjects", + "traits": { + "smithy.api#documentation": "A list of package objects.
" + } + }, + "NextToken": { + "target": "com.amazonaws.panorama#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that's included if more results are available.
" + } + } + } + }, + "com.amazonaws.panorama#ListApplicationInstanceNodeInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#ListApplicationInstanceNodeInstancesRequest" + }, + "output": { + "target": "com.amazonaws.panorama#ListApplicationInstanceNodeInstancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of application node instances.
", + "smithy.api#http": { + "method": "GET", + "uri": "/application-instances/{ApplicationInstanceId}/node-instances", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.panorama#ListApplicationInstanceNodeInstancesRequest": { + "type": "structure", + "members": { + "ApplicationInstanceId": { + "target": "com.amazonaws.panorama#ApplicationInstanceId", + "traits": { + "smithy.api#documentation": "The node instances' application instance ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.panorama#MaxSize25", + "traits": { + "smithy.api#documentation": "The maximum number of node instances to return in one page of results.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.panorama#NextToken", + "traits": { + "smithy.api#documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.panorama#ListApplicationInstanceNodeInstancesResponse": { + "type": "structure", + "members": { + "NodeInstances": { + "target": "com.amazonaws.panorama#NodeInstances", + "traits": { + "smithy.api#documentation": "A list of node instances.
" + } + }, + "NextToken": { + "target": "com.amazonaws.panorama#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that's included if more results are available.
" + } + } + } + }, + "com.amazonaws.panorama#ListApplicationInstances": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#ListApplicationInstancesRequest" + }, + "output": { + "target": "com.amazonaws.panorama#ListApplicationInstancesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of application instances.
", + "smithy.api#http": { + "method": "GET", + "uri": "/application-instances", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.panorama#ListApplicationInstancesRequest": { + "type": "structure", + "members": { + "DeviceId": { + "target": "com.amazonaws.panorama#DeviceId", + "traits": { + "smithy.api#documentation": "The application instances' device ID.
", + "smithy.api#httpQuery": "deviceId" + } + }, + "StatusFilter": { + "target": "com.amazonaws.panorama#StatusFilter", + "traits": { + "smithy.api#documentation": "Only include instances with a specific status.
", + "smithy.api#httpQuery": "statusFilter" + } + }, + "MaxResults": { + "target": "com.amazonaws.panorama#MaxSize25", + "traits": { + "smithy.api#documentation": "The maximum number of application instances to return in one page of results.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.panorama#NextToken", + "traits": { + "smithy.api#documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.panorama#ListApplicationInstancesResponse": { + "type": "structure", + "members": { + "ApplicationInstances": { + "target": "com.amazonaws.panorama#ApplicationInstances", + "traits": { + "smithy.api#documentation": "A list of application instances.
" + } + }, + "NextToken": { + "target": "com.amazonaws.panorama#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that's included if more results are available.
" + } + } + } + }, + "com.amazonaws.panorama#ListDevices": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#ListDevicesRequest" + }, + "output": { + "target": "com.amazonaws.panorama#ListDevicesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of devices.
", + "smithy.api#http": { + "method": "GET", + "uri": "/devices", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.panorama#ListDevicesJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#ListDevicesJobsRequest" + }, + "output": { + "target": "com.amazonaws.panorama#ListDevicesJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of jobs.
", + "smithy.api#http": { + "method": "GET", + "uri": "/jobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.panorama#ListDevicesJobsRequest": { + "type": "structure", + "members": { + "DeviceId": { + "target": "com.amazonaws.panorama#DeviceId", + "traits": { + "smithy.api#documentation": "Filter results by the job's target device ID.
", + "smithy.api#httpQuery": "DeviceId" + } + }, + "NextToken": { + "target": "com.amazonaws.panorama#NextToken", + "traits": { + "smithy.api#documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.panorama#MaxSize25", + "traits": { + "smithy.api#documentation": "The maximum number of device jobs to return in one page of results.
", + "smithy.api#httpQuery": "MaxResults" + } + } + } + }, + "com.amazonaws.panorama#ListDevicesJobsResponse": { + "type": "structure", + "members": { + "DeviceJobs": { + "target": "com.amazonaws.panorama#DeviceJobList", + "traits": { + "smithy.api#documentation": "A list of jobs.
" + } + }, + "NextToken": { + "target": "com.amazonaws.panorama#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that's included if more results are available.
" + } + } + } + }, + "com.amazonaws.panorama#ListDevicesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.panorama#NextToken", + "traits": { + "smithy.api#documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.panorama#MaxSize25", + "traits": { + "smithy.api#documentation": "The maximum number of devices to return in one page of results.
", + "smithy.api#httpQuery": "MaxResults" + } + } + } + }, + "com.amazonaws.panorama#ListDevicesResponse": { + "type": "structure", + "members": { + "Devices": { + "target": "com.amazonaws.panorama#DeviceList", + "traits": { + "smithy.api#documentation": "A list of devices.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.panorama#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that's included if more results are available.
" + } + } + } + }, + "com.amazonaws.panorama#ListNodeFromTemplateJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#ListNodeFromTemplateJobsRequest" + }, + "output": { + "target": "com.amazonaws.panorama#ListNodeFromTemplateJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of camera stream node jobs.
", + "smithy.api#http": { + "method": "GET", + "uri": "/packages/template-job", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.panorama#ListNodeFromTemplateJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.panorama#NextToken", + "traits": { + "smithy.api#documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.panorama#MaxSize25", + "traits": { + "smithy.api#documentation": "The maximum number of node from template jobs to return in one page of results.
", + "smithy.api#httpQuery": "MaxResults" + } + } + } + }, + "com.amazonaws.panorama#ListNodeFromTemplateJobsResponse": { + "type": "structure", + "members": { + "NodeFromTemplateJobs": { + "target": "com.amazonaws.panorama#NodeFromTemplateJobList", + "traits": { + "smithy.api#documentation": "A list of jobs.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.panorama#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that's included if more results are available.
" + } + } + } + }, + "com.amazonaws.panorama#ListNodes": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#ListNodesRequest" + }, + "output": { + "target": "com.amazonaws.panorama#ListNodesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of nodes.
", + "smithy.api#http": { + "method": "GET", + "uri": "/nodes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.panorama#ListNodesRequest": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.panorama#NodeCategory", + "traits": { + "smithy.api#documentation": "Search for nodes by category.
", + "smithy.api#httpQuery": "category" + } + }, + "OwnerAccount": { + "target": "com.amazonaws.panorama#PackageOwnerAccount", + "traits": { + "smithy.api#documentation": "Search for nodes by the account ID of the nodes' owner.
", + "smithy.api#httpQuery": "ownerAccount" + } + }, + "PackageName": { + "target": "com.amazonaws.panorama#NodePackageName", + "traits": { + "smithy.api#documentation": "Search for nodes by name.
", + "smithy.api#httpQuery": "packageName" + } + }, + "PackageVersion": { + "target": "com.amazonaws.panorama#NodePackageVersion", + "traits": { + "smithy.api#documentation": "Search for nodes by version.
", + "smithy.api#httpQuery": "packageVersion" + } + }, + "PatchVersion": { + "target": "com.amazonaws.panorama#NodePackagePatchVersion", + "traits": { + "smithy.api#documentation": "Search for nodes by patch version.
", + "smithy.api#httpQuery": "patchVersion" + } + }, + "NextToken": { + "target": "com.amazonaws.panorama#Token", + "traits": { + "smithy.api#documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.panorama#MaxSize25", + "traits": { + "smithy.api#documentation": "The maximum number of nodes to return in one page of results.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.panorama#ListNodesResponse": { + "type": "structure", + "members": { + "Nodes": { + "target": "com.amazonaws.panorama#NodesList", + "traits": { + "smithy.api#documentation": "A list of nodes.
" + } + }, + "NextToken": { + "target": "com.amazonaws.panorama#Token", + "traits": { + "smithy.api#documentation": "A pagination token that's included if more results are available.
" + } + } + } + }, + "com.amazonaws.panorama#ListPackageImportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#ListPackageImportJobsRequest" + }, + "output": { + "target": "com.amazonaws.panorama#ListPackageImportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of package import jobs.
", + "smithy.api#http": { + "method": "GET", + "uri": "/packages/import-jobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.panorama#ListPackageImportJobsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.panorama#NextToken", + "traits": { + "smithy.api#documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.panorama#MaxSize25", + "traits": { + "smithy.api#documentation": "The maximum number of package import jobs to return in one page of results.
", + "smithy.api#httpQuery": "MaxResults" + } + } + } + }, + "com.amazonaws.panorama#ListPackageImportJobsResponse": { + "type": "structure", + "members": { + "PackageImportJobs": { + "target": "com.amazonaws.panorama#PackageImportJobList", + "traits": { + "smithy.api#documentation": "A list of package import jobs.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.panorama#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that's included if more results are available.
" + } + } + } + }, + "com.amazonaws.panorama#ListPackages": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#ListPackagesRequest" + }, + "output": { + "target": "com.amazonaws.panorama#ListPackagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of packages.
", + "smithy.api#http": { + "method": "GET", + "uri": "/packages", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.panorama#ListPackagesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.panorama#MaxSize25", + "traits": { + "smithy.api#documentation": "The maximum number of packages to return in one page of results.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.panorama#Token", + "traits": { + "smithy.api#documentation": "Specify the pagination token from a previous request to retrieve the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.panorama#ListPackagesResponse": { + "type": "structure", + "members": { + "Packages": { + "target": "com.amazonaws.panorama#PackageList", + "traits": { + "smithy.api#documentation": "A list of packages.
" + } + }, + "NextToken": { + "target": "com.amazonaws.panorama#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that's included if more results are available.
" + } + } + } + }, + "com.amazonaws.panorama#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.panorama#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of tags for a resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.panorama#ResourceArn", + "traits": { + "smithy.api#documentation": "The resource's ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.panorama#TagMap", + "traits": { + "smithy.api#documentation": "A list of tags.
" + } + } + } + }, + "com.amazonaws.panorama#ManifestOverridesPayload": { + "type": "union", + "members": { + "PayloadData": { + "target": "com.amazonaws.panorama#ManifestOverridesPayloadData", + "traits": { + "smithy.api#documentation": "The overrides document.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Parameter overrides for an application instance. This is a JSON document that has a \n single key (PayloadData) where the value is an escaped string\n representation of the overrides document.
The application manifest.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A application verion's manifest file. This is a JSON document that has a \n single key (PayloadData) where the value is an escaped string\n representation of the application manifest (graph.json). This\n file is located in the graphs folder in your application source.
Settings for Ethernet port 0.
" + } + }, + "Ethernet1": { + "target": "com.amazonaws.panorama#EthernetPayload", + "traits": { + "smithy.api#documentation": "Settings for Ethernet port 1.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The network configuration for a device.
" + } + }, + "com.amazonaws.panorama#NetworkStatus": { + "type": "structure", + "members": { + "Ethernet0Status": { + "target": "com.amazonaws.panorama#EthernetStatus", + "traits": { + "smithy.api#documentation": "The status of Ethernet port 0.
" + } + }, + "Ethernet1Status": { + "target": "com.amazonaws.panorama#EthernetStatus", + "traits": { + "smithy.api#documentation": "The status of Ethernet port 1.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The network status of a device.
" + } + }, + "com.amazonaws.panorama#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.panorama#Node": { + "type": "structure", + "members": { + "NodeId": { + "target": "com.amazonaws.panorama#NodeId", + "traits": { + "smithy.api#documentation": "The node's ID.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.panorama#NodeName", + "traits": { + "smithy.api#documentation": "The node's name.
", + "smithy.api#required": {} + } + }, + "Category": { + "target": "com.amazonaws.panorama#NodeCategory", + "traits": { + "smithy.api#documentation": "The node's category.
", + "smithy.api#required": {} + } + }, + "OwnerAccount": { + "target": "com.amazonaws.panorama#PackageOwnerAccount", + "traits": { + "smithy.api#documentation": "The account ID of the node's owner.
" + } + }, + "PackageName": { + "target": "com.amazonaws.panorama#NodePackageName", + "traits": { + "smithy.api#documentation": "The node's package name.
", + "smithy.api#required": {} + } + }, + "PackageId": { + "target": "com.amazonaws.panorama#NodePackageId", + "traits": { + "smithy.api#documentation": "The node's package ID.
", + "smithy.api#required": {} + } + }, + "PackageArn": { + "target": "com.amazonaws.panorama#NodePackageArn", + "traits": { + "smithy.api#documentation": "The node's ARN.
" + } + }, + "PackageVersion": { + "target": "com.amazonaws.panorama#NodePackageVersion", + "traits": { + "smithy.api#documentation": "The node's package version.
", + "smithy.api#required": {} + } + }, + "PatchVersion": { + "target": "com.amazonaws.panorama#NodePackagePatchVersion", + "traits": { + "smithy.api#documentation": "The node's patch version.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.panorama#Description", + "traits": { + "smithy.api#documentation": "The node's description.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.panorama#TimeStamp", + "traits": { + "smithy.api#documentation": "When the node was created.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An application node that represents a camera stream, a model, code, or output.
" + } + }, + "com.amazonaws.panorama#NodeAssetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]+$" + } + }, + "com.amazonaws.panorama#NodeCategory": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BUSINESS_LOGIC", + "name": "BUSINESS_LOGIC" + }, + { + "value": "ML_MODEL", + "name": "ML_MODEL" + }, + { + "value": "MEDIA_SOURCE", + "name": "MEDIA_SOURCE" + }, + { + "value": "MEDIA_SINK", + "name": "MEDIA_SINK" + } + ] + } + }, + "com.amazonaws.panorama#NodeFromTemplateJob": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.panorama#JobId", + "traits": { + "smithy.api#documentation": "The job's ID.
" + } + }, + "TemplateType": { + "target": "com.amazonaws.panorama#TemplateType", + "traits": { + "smithy.api#documentation": "The job's template type.
" + } + }, + "Status": { + "target": "com.amazonaws.panorama#NodeFromTemplateJobStatus", + "traits": { + "smithy.api#documentation": "The job's status.
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.panorama#NodeFromTemplateJobStatusMessage", + "traits": { + "smithy.api#documentation": "The job's status message.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.panorama#CreatedTime", + "traits": { + "smithy.api#documentation": "When the job was created.
" + } + }, + "NodeName": { + "target": "com.amazonaws.panorama#NodeName", + "traits": { + "smithy.api#documentation": "The node's name.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A job to create a camera stream node.
" + } + }, + "com.amazonaws.panorama#NodeFromTemplateJobList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#NodeFromTemplateJob" + } + }, + "com.amazonaws.panorama#NodeFromTemplateJobStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.panorama#NodeFromTemplateJobStatusMessage": { + "type": "string" + }, + "com.amazonaws.panorama#NodeId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]+$" + } + }, + "com.amazonaws.panorama#NodeInputPort": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.panorama#PortName", + "traits": { + "smithy.api#documentation": "The input port's name.
" + } + }, + "Description": { + "target": "com.amazonaws.panorama#Description", + "traits": { + "smithy.api#documentation": "The input port's description.
" + } + }, + "Type": { + "target": "com.amazonaws.panorama#PortType", + "traits": { + "smithy.api#documentation": "The input port's type.
" + } + }, + "DefaultValue": { + "target": "com.amazonaws.panorama#PortDefaultValue", + "traits": { + "smithy.api#documentation": "The input port's default value.
" + } + }, + "MaxConnections": { + "target": "com.amazonaws.panorama#MaxConnections", + "traits": { + "smithy.api#documentation": "The input port's max connections.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A node input port.
" + } + }, + "com.amazonaws.panorama#NodeInstance": { + "type": "structure", + "members": { + "NodeInstanceId": { + "target": "com.amazonaws.panorama#NodeInstanceId", + "traits": { + "smithy.api#documentation": "The instance's ID.
", + "smithy.api#required": {} + } + }, + "NodeId": { + "target": "com.amazonaws.panorama#NodeId", + "traits": { + "smithy.api#documentation": "The node's ID.
" + } + }, + "PackageName": { + "target": "com.amazonaws.panorama#NodePackageName", + "traits": { + "smithy.api#documentation": "The instance's package name.
" + } + }, + "PackageVersion": { + "target": "com.amazonaws.panorama#NodePackageVersion", + "traits": { + "smithy.api#documentation": "The instance's package version.
" + } + }, + "PackagePatchVersion": { + "target": "com.amazonaws.panorama#NodePackagePatchVersion", + "traits": { + "smithy.api#documentation": "The instance's package patch version.
" + } + }, + "NodeName": { + "target": "com.amazonaws.panorama#NodeName", + "traits": { + "smithy.api#documentation": "The instance's name.
" + } + }, + "CurrentStatus": { + "target": "com.amazonaws.panorama#NodeInstanceStatus", + "traits": { + "smithy.api#documentation": "The instance's current status.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A node instance.
" + } + }, + "com.amazonaws.panorama#NodeInstanceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]+$" + } + }, + "com.amazonaws.panorama#NodeInstanceStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "ERROR", + "name": "ERROR" + }, + { + "value": "NOT_AVAILABLE", + "name": "NOT_AVAILABLE" + } + ] + } + }, + "com.amazonaws.panorama#NodeInstances": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#NodeInstance" + } + }, + "com.amazonaws.panorama#NodeInterface": { + "type": "structure", + "members": { + "Inputs": { + "target": "com.amazonaws.panorama#InputPortList", + "traits": { + "smithy.api#documentation": "The node interface's inputs.
", + "smithy.api#required": {} + } + }, + "Outputs": { + "target": "com.amazonaws.panorama#OutputPortList", + "traits": { + "smithy.api#documentation": "The node interface's outputs.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A node interface.
" + } + }, + "com.amazonaws.panorama#NodeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]+$" + } + }, + "com.amazonaws.panorama#NodeOutputPort": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.panorama#PortName", + "traits": { + "smithy.api#documentation": "The output port's name.
" + } + }, + "Description": { + "target": "com.amazonaws.panorama#Description", + "traits": { + "smithy.api#documentation": "The output port's description.
" + } + }, + "Type": { + "target": "com.amazonaws.panorama#PortType", + "traits": { + "smithy.api#documentation": "The output port's type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A node output port.
" + } + }, + "com.amazonaws.panorama#NodePackageArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.panorama#NodePackageId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\/]+$" + } + }, + "com.amazonaws.panorama#NodePackageName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]+$" + } + }, + "com.amazonaws.panorama#NodePackagePatchVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-z0-9]+$" + } + }, + "com.amazonaws.panorama#NodePackageVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^([0-9]+)\\.([0-9]+)$" + } + }, + "com.amazonaws.panorama#NodesList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#Node" + } + }, + "com.amazonaws.panorama#OTAJobConfig": { + "type": "structure", + "members": { + "ImageVersion": { + "target": "com.amazonaws.panorama#ImageVersion", + "traits": { + "smithy.api#documentation": "The target version of the device software.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An over-the-air update (OTA) job configuration.
" + } + }, + "com.amazonaws.panorama#Object": { + "type": "string" + }, + "com.amazonaws.panorama#ObjectKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.panorama#OmniCloudServiceLambda": { + "type": "service", + "version": "2019-07-24", + "operations": [ + { + "target": "com.amazonaws.panorama#CreateApplicationInstance" + }, + { + "target": "com.amazonaws.panorama#CreateJobForDevices" + }, + { + "target": "com.amazonaws.panorama#CreateNodeFromTemplateJob" + }, + { + "target": "com.amazonaws.panorama#CreatePackage" + }, + { + "target": "com.amazonaws.panorama#CreatePackageImportJob" + }, + { + "target": "com.amazonaws.panorama#DeleteDevice" + }, + { + "target": "com.amazonaws.panorama#DeletePackage" + }, + { + "target": "com.amazonaws.panorama#DeregisterPackageVersion" + }, + { + "target": "com.amazonaws.panorama#DescribeApplicationInstance" + }, + { + "target": "com.amazonaws.panorama#DescribeApplicationInstanceDetails" + }, + { + "target": "com.amazonaws.panorama#DescribeDevice" + }, + { + "target": "com.amazonaws.panorama#DescribeDeviceJob" + }, + { + "target": "com.amazonaws.panorama#DescribeNode" + }, + { + "target": "com.amazonaws.panorama#DescribeNodeFromTemplateJob" + }, + { + "target": "com.amazonaws.panorama#DescribePackage" + }, + { + "target": "com.amazonaws.panorama#DescribePackageImportJob" + }, + { + "target": "com.amazonaws.panorama#DescribePackageVersion" + }, + { + "target": "com.amazonaws.panorama#ListApplicationInstanceDependencies" + }, + { + "target": "com.amazonaws.panorama#ListApplicationInstanceNodeInstances" + }, + { + "target": "com.amazonaws.panorama#ListApplicationInstances" + }, + { + "target": "com.amazonaws.panorama#ListDevices" + }, + { + "target": "com.amazonaws.panorama#ListDevicesJobs" + }, + { + "target": "com.amazonaws.panorama#ListNodeFromTemplateJobs" + }, + { + "target": "com.amazonaws.panorama#ListNodes" + }, + { + "target": "com.amazonaws.panorama#ListPackageImportJobs" + }, + { + "target": "com.amazonaws.panorama#ListPackages" + }, + { + "target": "com.amazonaws.panorama#ListTagsForResource" + }, + { + "target": "com.amazonaws.panorama#ProvisionDevice" + }, + { + "target": "com.amazonaws.panorama#RegisterPackageVersion" + }, + { + "target": "com.amazonaws.panorama#RemoveApplicationInstance" + }, + { + "target": "com.amazonaws.panorama#TagResource" + }, + { + "target": "com.amazonaws.panorama#UntagResource" + }, + { + "target": "com.amazonaws.panorama#UpdateDeviceMetadata" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Panorama", + "arnNamespace": "panorama", + "cloudFormationName": "Panorama", + "cloudTrailEventSource": "panorama.amazonaws.com", + "endpointPrefix": "panorama" + }, + "aws.auth#sigv4": { + "name": "panorama" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "\n Overview\n
\nThis is the AWS Panorama API Reference. For an introduction to the service, see \n What is AWS Panorama? \n in the AWS Panorama Developer Guide.
", + "smithy.api#title": "AWS Panorama" + } + }, + "com.amazonaws.panorama#OutPutS3Location": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.panorama#BucketName", + "traits": { + "smithy.api#documentation": "The object's bucket.
", + "smithy.api#required": {} + } + }, + "ObjectKey": { + "target": "com.amazonaws.panorama#ObjectKey", + "traits": { + "smithy.api#documentation": "The object's key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The location of an output object in Amazon S3.
" + } + }, + "com.amazonaws.panorama#OutputPortList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#NodeOutputPort" + } + }, + "com.amazonaws.panorama#PackageImportJob": { + "type": "structure", + "members": { + "JobId": { + "target": "com.amazonaws.panorama#JobId", + "traits": { + "smithy.api#documentation": "The job's ID.
" + } + }, + "JobType": { + "target": "com.amazonaws.panorama#PackageImportJobType", + "traits": { + "smithy.api#documentation": "The job's type.
" + } + }, + "Status": { + "target": "com.amazonaws.panorama#PackageImportJobStatus", + "traits": { + "smithy.api#documentation": "The job's status.
" + } + }, + "StatusMessage": { + "target": "com.amazonaws.panorama#PackageImportJobStatusMessage", + "traits": { + "smithy.api#documentation": "The job's status message.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.panorama#CreatedTime", + "traits": { + "smithy.api#documentation": "When the job was created.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.panorama#LastUpdatedTime", + "traits": { + "smithy.api#documentation": "When the job was updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A job to import a package version.
" + } + }, + "com.amazonaws.panorama#PackageImportJobInputConfig": { + "type": "structure", + "members": { + "PackageVersionInputConfig": { + "target": "com.amazonaws.panorama#PackageVersionInputConfig", + "traits": { + "smithy.api#documentation": "The package version's input configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A configuration for a package import job.
" + } + }, + "com.amazonaws.panorama#PackageImportJobList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#PackageImportJob" + } + }, + "com.amazonaws.panorama#PackageImportJobOutput": { + "type": "structure", + "members": { + "PackageId": { + "target": "com.amazonaws.panorama#NodePackageId", + "traits": { + "smithy.api#documentation": "The package's ID.
", + "smithy.api#required": {} + } + }, + "PackageVersion": { + "target": "com.amazonaws.panorama#NodePackageVersion", + "traits": { + "smithy.api#documentation": "The package's version.
", + "smithy.api#required": {} + } + }, + "PatchVersion": { + "target": "com.amazonaws.panorama#NodePackagePatchVersion", + "traits": { + "smithy.api#documentation": "The package's patch version.
", + "smithy.api#required": {} + } + }, + "OutputS3Location": { + "target": "com.amazonaws.panorama#OutPutS3Location", + "traits": { + "smithy.api#documentation": "The package's output location.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Results of a package import job.
" + } + }, + "com.amazonaws.panorama#PackageImportJobOutputConfig": { + "type": "structure", + "members": { + "PackageVersionOutputConfig": { + "target": "com.amazonaws.panorama#PackageVersionOutputConfig", + "traits": { + "smithy.api#documentation": "The package version's output configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An output configuration for a package import job.
" + } + }, + "com.amazonaws.panorama#PackageImportJobStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.panorama#PackageImportJobStatusMessage": { + "type": "string" + }, + "com.amazonaws.panorama#PackageImportJobType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "NODE_PACKAGE_VERSION", + "name": "NODE_PACKAGE_VERSION" + } + ] + } + }, + "com.amazonaws.panorama#PackageList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#PackageListItem" + } + }, + "com.amazonaws.panorama#PackageListItem": { + "type": "structure", + "members": { + "PackageId": { + "target": "com.amazonaws.panorama#NodePackageId", + "traits": { + "smithy.api#documentation": "The package's ID.
" + } + }, + "PackageName": { + "target": "com.amazonaws.panorama#NodePackageName", + "traits": { + "smithy.api#documentation": "The package's name.
" + } + }, + "Arn": { + "target": "com.amazonaws.panorama#NodePackageArn", + "traits": { + "smithy.api#documentation": "The package's ARN.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.panorama#TimeStamp", + "traits": { + "smithy.api#documentation": "When the package was created.
" + } + }, + "Tags": { + "target": "com.amazonaws.panorama#TagMap", + "traits": { + "smithy.api#documentation": "The package's tags.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A package summary.
" + } + }, + "com.amazonaws.panorama#PackageObject": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.panorama#NodePackageName", + "traits": { + "smithy.api#documentation": "The object's name.
", + "smithy.api#required": {} + } + }, + "PackageVersion": { + "target": "com.amazonaws.panorama#NodePackageVersion", + "traits": { + "smithy.api#documentation": "The object's package version.
", + "smithy.api#required": {} + } + }, + "PatchVersion": { + "target": "com.amazonaws.panorama#NodePackagePatchVersion", + "traits": { + "smithy.api#documentation": "The object's patch version.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A package object.
" + } + }, + "com.amazonaws.panorama#PackageObjects": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#PackageObject" + } + }, + "com.amazonaws.panorama#PackageOwnerAccount": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 12 + }, + "smithy.api#pattern": "^[0-9a-z\\_]+$" + } + }, + "com.amazonaws.panorama#PackageVersionInputConfig": { + "type": "structure", + "members": { + "S3Location": { + "target": "com.amazonaws.panorama#S3Location", + "traits": { + "smithy.api#documentation": "A location in Amazon S3.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A package version input configuration.
" + } + }, + "com.amazonaws.panorama#PackageVersionOutputConfig": { + "type": "structure", + "members": { + "PackageName": { + "target": "com.amazonaws.panorama#NodePackageName", + "traits": { + "smithy.api#documentation": "The output's package name.
", + "smithy.api#required": {} + } + }, + "PackageVersion": { + "target": "com.amazonaws.panorama#NodePackageVersion", + "traits": { + "smithy.api#documentation": "The output's package version.
", + "smithy.api#required": {} + } + }, + "MarkLatest": { + "target": "com.amazonaws.panorama#MarkLatestPatch", + "traits": { + "smithy.api#documentation": "Indicates that the version is recommended for all users.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A package version output configuration.
" + } + }, + "com.amazonaws.panorama#PackageVersionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "REGISTER_PENDING", + "name": "REGISTER_PENDING" + }, + { + "value": "REGISTER_COMPLETED", + "name": "REGISTER_COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "DELETING", + "name": "DELETING" + } + ] + } + }, + "com.amazonaws.panorama#PackageVersionStatusDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.panorama#PortDefaultValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.panorama#PortName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^[a-zA-Z0-9\\_]+$" + } + }, + "com.amazonaws.panorama#PortType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "BOOLEAN", + "name": "BOOLEAN" + }, + { + "value": "STRING", + "name": "STRING" + }, + { + "value": "INT32", + "name": "INT32" + }, + { + "value": "FLOAT32", + "name": "FLOAT32" + }, + { + "value": "MEDIA", + "name": "MEDIA" + } + ] + } + }, + "com.amazonaws.panorama#PrincipalArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:[a-zA-Z0-9+=,.@\\-_/]+$" + } + }, + "com.amazonaws.panorama#PrincipalArnsList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#PrincipalArn" + } + }, + "com.amazonaws.panorama#ProvisionDevice": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#ProvisionDeviceRequest" + }, + "output": { + "target": "com.amazonaws.panorama#ProvisionDeviceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a device and returns a configuration archive. The configuration\n archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes.\n Transfer the configuration archive to the device with the included USB storage device within 5 minutes.
", + "smithy.api#http": { + "method": "POST", + "uri": "/devices", + "code": 200 + } + } + }, + "com.amazonaws.panorama#ProvisionDeviceRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.panorama#DeviceName", + "traits": { + "smithy.api#documentation": "A name for the device.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.panorama#Description", + "traits": { + "smithy.api#documentation": "A description for the device.
" + } + }, + "Tags": { + "target": "com.amazonaws.panorama#TagMap", + "traits": { + "smithy.api#documentation": "Tags for the device.
" + } + }, + "NetworkingConfiguration": { + "target": "com.amazonaws.panorama#NetworkPayload", + "traits": { + "smithy.api#documentation": "A networking configuration for the device.
" + } + } + } + }, + "com.amazonaws.panorama#ProvisionDeviceResponse": { + "type": "structure", + "members": { + "DeviceId": { + "target": "com.amazonaws.panorama#DeviceId", + "traits": { + "smithy.api#documentation": "The device's ID.
" + } + }, + "Arn": { + "target": "com.amazonaws.panorama#DeviceArn", + "traits": { + "smithy.api#documentation": "The device's ARN.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.panorama#DeviceStatus", + "traits": { + "smithy.api#documentation": "The device's status.
", + "smithy.api#required": {} + } + }, + "Certificates": { + "target": "com.amazonaws.panorama#Certificates", + "traits": { + "smithy.api#documentation": "The device's configuration bundle.
" + } + }, + "IotThingName": { + "target": "com.amazonaws.panorama#IotThingName", + "traits": { + "smithy.api#documentation": "The device's IoT thing name.
" + } + } + } + }, + "com.amazonaws.panorama#Region": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.panorama#RegisterPackageVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#RegisterPackageVersionRequest" + }, + "output": { + "target": "com.amazonaws.panorama#RegisterPackageVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Registers a package version.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/packages/{PackageId}/versions/{PackageVersion}/patch/{PatchVersion}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#RegisterPackageVersionRequest": { + "type": "structure", + "members": { + "OwnerAccount": { + "target": "com.amazonaws.panorama#PackageOwnerAccount", + "traits": { + "smithy.api#documentation": "An owner account.
" + } + }, + "PackageId": { + "target": "com.amazonaws.panorama#NodePackageId", + "traits": { + "smithy.api#documentation": "A package ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PackageVersion": { + "target": "com.amazonaws.panorama#NodePackageVersion", + "traits": { + "smithy.api#documentation": "A package version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PatchVersion": { + "target": "com.amazonaws.panorama#NodePackagePatchVersion", + "traits": { + "smithy.api#documentation": "A patch version.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MarkLatest": { + "target": "com.amazonaws.panorama#MarkLatestPatch", + "traits": { + "smithy.api#documentation": "Whether to mark the new version as the latest version.
" + } + } + } + }, + "com.amazonaws.panorama#RegisterPackageVersionResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.panorama#RemoveApplicationInstance": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#RemoveApplicationInstanceRequest" + }, + "output": { + "target": "com.amazonaws.panorama#RemoveApplicationInstanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes an application instance.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/application-instances/{ApplicationInstanceId}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#RemoveApplicationInstanceRequest": { + "type": "structure", + "members": { + "ApplicationInstanceId": { + "target": "com.amazonaws.panorama#ApplicationInstanceId", + "traits": { + "smithy.api#documentation": "An application instance ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#RemoveApplicationInstanceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.panorama#ResourceArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.panorama#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "The resource's ID.
", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "The resource's type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The target resource was not found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.panorama#RetryAfterSeconds": { + "type": "integer" + }, + "com.amazonaws.panorama#RuntimeRoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:role/.+$" + } + }, + "com.amazonaws.panorama#S3Location": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.panorama#Region", + "traits": { + "smithy.api#documentation": "The bucket's Region.
" + } + }, + "BucketName": { + "target": "com.amazonaws.panorama#BucketName", + "traits": { + "smithy.api#documentation": "A bucket name.
", + "smithy.api#required": {} + } + }, + "ObjectKey": { + "target": "com.amazonaws.panorama#ObjectKey", + "traits": { + "smithy.api#documentation": "An object key.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A location in Amazon S3.
" + } + }, + "com.amazonaws.panorama#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "The target resource's ID.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "The target resource's type.
" + } + }, + "QuotaCode": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "The name of the limit.
", + "smithy.api#required": {} + } + }, + "ServiceCode": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "The name of the service.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request would cause a limit to be exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.panorama#StaticIpConnectionInfo": { + "type": "structure", + "members": { + "IpAddress": { + "target": "com.amazonaws.panorama#IpAddress", + "traits": { + "smithy.api#documentation": "The connection's IP address.
", + "smithy.api#required": {} + } + }, + "Mask": { + "target": "com.amazonaws.panorama#Mask", + "traits": { + "smithy.api#documentation": "The connection's DNS mask.
", + "smithy.api#required": {} + } + }, + "Dns": { + "target": "com.amazonaws.panorama#DnsList", + "traits": { + "smithy.api#documentation": "The connection's DNS address.
", + "smithy.api#required": {} + } + }, + "DefaultGateway": { + "target": "com.amazonaws.panorama#DefaultGateway", + "traits": { + "smithy.api#documentation": "The connection's default gateway.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A static IP configuration.
" + } + }, + "com.amazonaws.panorama#StatusFilter": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DEPLOYMENT_SUCCEEDED", + "name": "DEPLOYMENT_SUCCEEDED" + }, + { + "value": "DEPLOYMENT_ERROR", + "name": "DEPLOYMENT_ERROR" + }, + { + "value": "REMOVAL_SUCCEEDED", + "name": "REMOVAL_SUCCEEDED" + }, + { + "value": "REMOVAL_FAILED", + "name": "REMOVAL_FAILED" + }, + { + "value": "PROCESSING_DEPLOYMENT", + "name": "PROCESSING_DEPLOYMENT" + }, + { + "value": "PROCESSING_REMOVAL", + "name": "PROCESSING_REMOVAL" + } + ] + } + }, + "com.amazonaws.panorama#StorageLocation": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.panorama#Bucket", + "traits": { + "smithy.api#documentation": "The location's bucket.
", + "smithy.api#required": {} + } + }, + "RepoPrefixLocation": { + "target": "com.amazonaws.panorama#Object", + "traits": { + "smithy.api#documentation": "The location's repo prefix.
", + "smithy.api#required": {} + } + }, + "GeneratedPrefixLocation": { + "target": "com.amazonaws.panorama#Object", + "traits": { + "smithy.api#documentation": "The location's generated prefix.
", + "smithy.api#required": {} + } + }, + "BinaryPrefixLocation": { + "target": "com.amazonaws.panorama#Object", + "traits": { + "smithy.api#documentation": "The location's binary prefix.
", + "smithy.api#required": {} + } + }, + "ManifestPrefixLocation": { + "target": "com.amazonaws.panorama#Object", + "traits": { + "smithy.api#documentation": "The location's manifest prefix.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A storage location.
" + } + }, + "com.amazonaws.panorama#String": { + "type": "string" + }, + "com.amazonaws.panorama#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.panorama#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.panorama#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.panorama#TagKey" + }, + "value": { + "target": "com.amazonaws.panorama#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.panorama#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.panorama#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Tags a resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.panorama#ResourceArn", + "traits": { + "smithy.api#documentation": "The resource's ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.panorama#TagMap", + "traits": { + "smithy.api#documentation": "Tags for the resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.panorama#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.panorama#TemplateKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.panorama#TemplateParametersMap": { + "type": "map", + "key": { + "target": "com.amazonaws.panorama#TemplateKey" + }, + "value": { + "target": "com.amazonaws.panorama#TemplateValue" + } + }, + "com.amazonaws.panorama#TemplateType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "RTSP_CAMERA_STREAM", + "name": "RTSP_CAMERA_STREAM" + } + ] + } + }, + "com.amazonaws.panorama#TemplateValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^.+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.panorama#TimeStamp": { + "type": "timestamp" + }, + "com.amazonaws.panorama#Token": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#pattern": "^.+$" + } + }, + "com.amazonaws.panorama#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.panorama#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes tags from a resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.panorama#ResourceArn", + "traits": { + "smithy.api#documentation": "The resource's ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.panorama#TagKeyList", + "traits": { + "smithy.api#documentation": "Tag keys to remove.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.panorama#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.panorama#UpdateCreatedTime": { + "type": "timestamp" + }, + "com.amazonaws.panorama#UpdateDeviceMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.panorama#UpdateDeviceMetadataRequest" + }, + "output": { + "target": "com.amazonaws.panorama#UpdateDeviceMetadataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.panorama#AccessDeniedException" + }, + { + "target": "com.amazonaws.panorama#ConflictException" + }, + { + "target": "com.amazonaws.panorama#InternalServerException" + }, + { + "target": "com.amazonaws.panorama#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.panorama#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a device's metadata.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/devices/{DeviceId}", + "code": 200 + } + } + }, + "com.amazonaws.panorama#UpdateDeviceMetadataRequest": { + "type": "structure", + "members": { + "DeviceId": { + "target": "com.amazonaws.panorama#DeviceId", + "traits": { + "smithy.api#documentation": "The device's ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.panorama#Description", + "traits": { + "smithy.api#documentation": "A description for the device.
" + } + } + } + }, + "com.amazonaws.panorama#UpdateDeviceMetadataResponse": { + "type": "structure", + "members": { + "DeviceId": { + "target": "com.amazonaws.panorama#DeviceId", + "traits": { + "smithy.api#documentation": "The device's ID.
" + } + } + } + }, + "com.amazonaws.panorama#UpdateProgress": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "VERIFYING", + "name": "VERIFYING" + }, + { + "value": "REBOOTING", + "name": "REBOOTING" + }, + { + "value": "DOWNLOADING", + "name": "DOWNLOADING" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.panorama#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#required": {} + } + }, + "Reason": { + "target": "com.amazonaws.panorama#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "The reason that validation failed.
" + } + }, + "ErrorId": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "A unique ID for the error.
" + } + }, + "ErrorArguments": { + "target": "com.amazonaws.panorama#ValidationExceptionErrorArgumentList", + "traits": { + "smithy.api#documentation": "A list of attributes that led to the exception and their values.
" + } + }, + "Fields": { + "target": "com.amazonaws.panorama#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "A list of request parameters that failed validation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request contains an invalid parameter value.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.panorama#ValidationExceptionErrorArgument": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "The argument's name.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "The argument's value.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A validation exception error argument.
" + } + }, + "com.amazonaws.panorama#ValidationExceptionErrorArgumentList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#ValidationExceptionErrorArgument" + } + }, + "com.amazonaws.panorama#ValidationExceptionField": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "The field's name.
", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.panorama#String", + "traits": { + "smithy.api#documentation": "The field's message.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A validation exception field.
" + } + }, + "com.amazonaws.panorama#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.panorama#ValidationExceptionField" + } + }, + "com.amazonaws.panorama#ValidationExceptionReason": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UNKNOWN_OPERATION", + "name": "UNKNOWN_OPERATION" + }, + { + "value": "CANNOT_PARSE", + "name": "CANNOT_PARSE" + }, + { + "value": "FIELD_VALIDATION_FAILED", + "name": "FIELD_VALIDATION_FAILED" + }, + { + "value": "OTHER", + "name": "OTHER" + } + ] + } + } + } +} diff --git a/codegen/sdk/aws-models/quicksight.2018-04-01.json b/codegen/sdk/aws-models/quicksight.2018-04-01.json index d3f90542ecb..f04e89bdae6 100644 --- a/codegen/sdk/aws-models/quicksight.2018-04-01.json +++ b/codegen/sdk/aws-models/quicksight.2018-04-01.json @@ -59,7 +59,7 @@ } }, "traits": { - "smithy.api#documentation": "The Amazon QuickSight customizations associated with your Amazon Web Services account or a Amazon QuickSight namespace in a specific Amazon Web Services Region;.
" + "smithy.api#documentation": "The Amazon QuickSight customizations associated with your Amazon Web Services account or a Amazon QuickSight namespace in a specific Amazon Web Services Region.
" } }, "com.amazonaws.quicksight#AccountSettings": { @@ -174,13 +174,13 @@ "Domain": { "target": "com.amazonaws.quicksight#Domain", "traits": { - "smithy.api#documentation": "The Elasticsearch domain.
", + "smithy.api#documentation": "The OpenSearch domain.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The parameters for Elasticsearch.
" + "smithy.api#documentation": "The parameters for OpenSearch.
" } }, "com.amazonaws.quicksight#AmazonOpenSearchParameters": { @@ -668,6 +668,12 @@ "smithy.api#documentation": "The display options for tile borders for visuals.
" } }, + "com.amazonaws.quicksight#CIDR": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[1-9]))$" + } + }, "com.amazonaws.quicksight#CalculatedColumn": { "type": "structure", "members": { @@ -1238,7 +1244,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, you can\n add a custom default theme by using the CreateAccountCustomization or\n UpdateAccountCustomization API operation. To further customize\n Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User\n Guide.\n
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for\n a Amazon QuickSight namespace instead. Customizations that apply to a namespace always override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.
Before you use the CreateAccountCustomization API operation to add a theme \n as the namespace default, make sure that you first share the theme with the namespace. \n If you don't share it with the namespace, the theme isn't visible to your users \n even if you make it the default theme. \n To check if the theme is shared, view the current permissions by using the \n \n DescribeThemePermissions\n API operation.\n To share the theme, grant permissions by using the \n \n UpdateThemePermissions\n API operation.
Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can\n add a custom default theme by using the CreateAccountCustomization or\n UpdateAccountCustomization API operation. To further customize\n Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User\n Guide.\n
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for\n a Amazon QuickSight namespace instead. Customizations that apply to a namespace always override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.
Before you use the CreateAccountCustomization API operation to add a theme\n as the namespace default, make sure that you first share the theme with the namespace.\n If you don't share it with the namespace, the theme isn't visible to your users\n even if you make it the default theme.\n To check if the theme is shared, view the current permissions by using the\n \n DescribeThemePermissions\n API operation.\n To share the theme, grant permissions by using the\n \n UpdateThemePermissions\n API operation.
The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region;. You can add\n these to an Amazon Web Services account and a Amazon QuickSight namespace.
\nFor example, you can add a default theme by setting AccountCustomization\n to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by\n specifying \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\"\n }.
The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add\n these to an Amazon Web Services account and a Amazon QuickSight namespace.
\nFor example, you can add a default theme by setting AccountCustomization\n to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by\n specifying \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\"\n }.
The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region;.
" + "smithy.api#documentation": "The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.
" } }, "RequestId": { @@ -1552,7 +1558,7 @@ "SourceEntity": { "target": "com.amazonaws.quicksight#DashboardSourceEntity", "traits": { - "smithy.api#documentation": "The entity that you are using as a source when you create the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only create a dashboard from a template, so you use a SourceTemplate\n entity. If you need to create a dashboard from an analysis, first convert the analysis\n to a template by using the CreateTemplate API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplateARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region;.
Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.
The entity that you are using as a source when you create the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only create a dashboard from a template, so you use a SourceTemplate\n entity. If you need to create a dashboard from an analysis, first convert the analysis\n to a template by using the CreateTemplate API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplateARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.
An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "smithy.api#documentation": "An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -1774,7 +1780,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, "IngestionArn": { @@ -1861,7 +1867,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "An ID for the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "smithy.api#documentation": "An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "smithy.api#required": {} } }, @@ -1875,7 +1881,7 @@ "Type": { "target": "com.amazonaws.quicksight#DataSourceType", "traits": { - "smithy.api#documentation": "The type of the data source. To return a\n\t\t\tlist of all data sources, use ListDataSources.
Use AMAZON_ELASTICSEARCH for Amazon Elasticsearch Service.
The type of the data source. To return a\n\t\t\tlist of all data sources, use ListDataSources.
Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, "CreationStatus": { @@ -2291,7 +2297,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2349,7 +2355,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2595,6 +2601,12 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "IngestionType": { + "target": "com.amazonaws.quicksight#IngestionType", + "traits": { + "smithy.api#documentation": "The type of ingestion that you want to create.
" + } } } }, @@ -2944,7 +2956,7 @@ "SourceEntity": { "target": "com.amazonaws.quicksight#TemplateSourceEntity", "traits": { - "smithy.api#documentation": "The entity that you are using as a source when you create the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.
Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.
The entity that you are using as a source when you create the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.
The ID of the data source. This ID is unique per Amazon Web Services Region; for each\n Amazon Web Services account.
" + "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region for each\n Amazon Web Services account.
" } }, "Name": { @@ -4300,7 +4312,7 @@ "AmazonElasticsearchParameters": { "target": "com.amazonaws.quicksight#AmazonElasticsearchParameters", "traits": { - "smithy.api#documentation": "The parameters for Elasticsearch.
" + "smithy.api#documentation": "The parameters for OpenSearch.
" } }, "AthenaParameters": { @@ -4646,7 +4658,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes all Amazon QuickSight customizations in this Amazon Web Services Region; for the specified \n Amazon Web Services account and Amazon QuickSight namespace.
", + "smithy.api#documentation": "Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified\n Amazon Web Services account and Amazon QuickSight namespace.
", "smithy.api#http": { "method": "DELETE", "uri": "/accounts/{AwsAccountId}/customizations", @@ -4660,7 +4672,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in\n this Amazon Web Services Region;.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in\n this Amazon Web Services Region.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4943,7 +4955,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4962,7 +4974,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, "RequestId": { @@ -5028,7 +5040,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5047,7 +5059,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, "RequestId": { @@ -5352,7 +5364,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5399,7 +5411,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5765,7 +5777,7 @@ "VersionNumber": { "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "Specifies the version of the template that you want to delete.\n\t\t\tIf you don't provide a version number, DeleteTemplate deletes all versions of the template. \n\t
Specifies the version of the template that you want to delete.\n\t\t\tIf you don't provide a version number, DeleteTemplate deletes all versions of the template.\n\t
Deletes the Amazon QuickSight user that is associated with the identity of the \n\t\t\tIdentity and Access Management (IAM) user or role that's making the call. The IAM user\n\t\t\tisn't deleted as a result of this call.
", + "smithy.api#documentation": "Deletes the Amazon QuickSight user that is associated with the identity of the\n\t\t\tIdentity and Access Management (IAM) user or role that's making the call. The IAM user\n\t\t\tisn't deleted as a result of this call.
", "smithy.api#http": { "method": "DELETE", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}", @@ -6095,7 +6107,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6145,7 +6157,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6216,7 +6228,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the customizations associated with the provided Amazon Web Services account and Amazon\n Amazon QuickSight namespace in an Amazon Web Services Region;. The Amazon QuickSight console evaluates which\n customizations to apply by running this API operation with the Resolved flag\n included.
To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved.
\n\n Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy.\n It has the potential to use all of the Amazon Web Services Regions; and AWS Services. When you\n subscribe to Amazon QuickSight, you choose one Amazon Web Services Region; to use as your home Region.\n That's where your free SPICE capacity is located. You can use Amazon QuickSight in any\n supported Amazon Web Services Region;.
\n Amazon Web Services Region; - In each Amazon Web Services Region; where you sign in to Amazon QuickSight\n at least once, Amazon QuickSight acts as a separate instance of the same service. If\n you have a user directory, it resides in us-east-1, which is the US East (N.\n Virginia). Generally speaking, these users have access to Amazon QuickSight in any \n Amazon Web Services Region;, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region;, you change your Region settings.\n If you're using the AWS CLI, you can use one of the following options:
\nUse command line options.
\nUse named profiles.
\nRun aws configure to change your default Amazon Web Services Region;. Use\n Enter to key the same settings for your keys. For more information, see\n Configuring the AWS CLI.
\n Namespace - A Amazon QuickSight namespace is a partition that contains\n users and assets (data sources, datasets, dashboards, and so on). To access\n assets that are in a specific namespace, users and groups must also be part of\n the same namespace. People who share a namespace are completely isolated from\n users and assets in other namespaces, even if they are in the same Amazon Web Services account\n and Amazon Web Services Region;.
\n Applied customizations - Within an Amazon Web Services Region;, a set of\n Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace.\n Settings that you apply to a namespace override settings that you apply to an\n Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region;. To apply them in\n other Amazon Web Services Regions;, run the CreateAccountCustomization command in\n each Amazon Web Services Region; where you want to apply the same customizations.
Describes the customizations associated with the provided Amazon Web Services account and Amazon\n Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which\n customizations to apply by running this API operation with the Resolved flag\n included.
To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved.
\n\n Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy.\n It has the potential to use all of the Amazon Web Services Regions and AWS Services. When you\n subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region.\n That's where your free SPICE capacity is located. You can use Amazon QuickSight in any\n supported Amazon Web Services Region.
\n Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight\n at least once, Amazon QuickSight acts as a separate instance of the same service. If\n you have a user directory, it resides in us-east-1, which is the US East (N.\n Virginia). Generally speaking, these users have access to Amazon QuickSight in any\n Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your Region settings.\n If you're using the AWS CLI, you can use one of the following options:
\nUse command line options.
\nUse named profiles.
\nRun aws configure to change your default Amazon Web Services Region. Use\n Enter to key the same settings for your keys. For more information, see\n Configuring the AWS CLI.
\n Namespace - A Amazon QuickSight namespace is a partition that contains\n users and assets (data sources, datasets, dashboards, and so on). To access\n assets that are in a specific namespace, users and groups must also be part of\n the same namespace. People who share a namespace are completely isolated from\n users and assets in other namespaces, even if they are in the same Amazon Web Services account\n and Amazon Web Services Region.
\n Applied customizations - Within an Amazon Web Services Region, a set of\n Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace.\n Settings that you apply to a namespace override settings that you apply to an\n Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in\n other Amazon Web Services Regions, run the CreateAccountCustomization command in\n each Amazon Web Services Region where you want to apply the same customizations.
The Amazon QuickSight customizations that exist in the current Amazon Web Services Region;.
" + "smithy.api#documentation": "The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.
" } }, "RequestId": { @@ -6349,7 +6361,7 @@ "AccountSettings": { "target": "com.amazonaws.quicksight#AccountSettings", "traits": { - "smithy.api#documentation": "The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon\n Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the\n Amazon QuickSight subscription. In the Amazon QuickSight console, the Amazon QuickSight subscription is sometimes\n referred to as a Amazon QuickSight \"account\" even though it's technically not an account\n by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon Web Services account. The\n edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region; where you use it.
" + "smithy.api#documentation": "The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon\n Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the\n Amazon QuickSight subscription. In the Amazon QuickSight console, the Amazon QuickSight subscription is sometimes\n referred to as a Amazon QuickSight \"account\" even though it's technically not an account\n by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon Web Services account. The\n edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.
" } }, "RequestId": { @@ -6809,7 +6821,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6828,7 +6840,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, "Permissions": { @@ -6866,7 +6878,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6979,7 +6991,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6998,7 +7010,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, "Permissions": { @@ -7036,7 +7048,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7391,7 +7403,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7610,6 +7622,89 @@ } } }, + "com.amazonaws.quicksight#DescribeIpRestriction": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeIpRestrictionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeIpRestrictionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Provides a summary and status of IP Rules.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/ip-restriction", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeIpRestrictionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "Your AWS account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.quicksight#DescribeIpRestrictionResponse": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "Your AWS account ID.
" + } + }, + "IpRestrictionRuleMap": { + "target": "com.amazonaws.quicksight#IpRestrictionRuleMap", + "traits": { + "smithy.api#documentation": "Describes the IP rules with CIDR range and description.
" + } + }, + "Enabled": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "Whether or not IP rules are enabled.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the describe request.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "The status of a set of IP restrictions. A successful request returns a 200 status code.
", + "smithy.api#httpResponseCode": {} + } + } + } + }, "com.amazonaws.quicksight#DescribeNamespace": { "type": "operation", "input": { @@ -7674,7 +7769,7 @@ "Namespace": { "target": "com.amazonaws.quicksight#NamespaceInfoV2", "traits": { - "smithy.api#documentation": "The information about the namespace that you're describing. The response includes \n the namespace ARN, name, Amazon Web Services Region;, creation status, and identity store. DescribeNamespace also\n works for namespaces that are in the process of being created. For incomplete namespaces,\n this API operation lists the namespace error types and messages associated with the creation process.
The information about the namespace that you're describing. The response includes \n the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also\n works for namespaces that are in the process of being created. For incomplete namespaces,\n this API operation lists the namespace error types and messages associated with the creation process.
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9041,7 +9136,7 @@ "ExperienceConfiguration": { "target": "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration", "traits": { - "smithy.api#documentation": "The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards or the entire Amazon QuickSight console.
", + "smithy.api#documentation": "The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, the entire Amazon QuickSight console, or the Amazon QuickSight Q search bar.
", "smithy.api#required": {} } } @@ -9053,7 +9148,7 @@ "EmbedUrl": { "target": "com.amazonaws.quicksight#EmbeddingUrl", "traits": { - "smithy.api#documentation": "The embed URL for the Amazon QuickSight dashboard or console.
", + "smithy.api#documentation": "The embed URL for the Amazon QuickSight dashboard, console, or Q search bar.
", "smithy.api#required": {} } }, @@ -9369,7 +9464,7 @@ "EntryPoint": { "target": "com.amazonaws.quicksight#EntryPoint", "traits": { - "smithy.api#documentation": "The URL you use to access the embedded session. The entry point URL is constrained to \n the following paths:
\n\n /start\n
\n /start/analyses\n
\n /start/dashboards\n
\n /start/favorites\n
\n /dashboards/DashboardId\n - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard
\n /analyses/AnalysisId\n - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis
The URL you use to access the embedded session. The entry point URL is constrained to\n the following paths:
\n\n /start\n
\n /start/analyses\n
\n /start/dashboards\n
\n /start/favorites\n
\n /dashboards/DashboardId\n - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard
\n /analyses/AnalysisId\n - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region;.
\n\t\tThe permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
\n\t\tThe permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
Lists data sources in current Amazon Web Services Region; that belong to this Amazon Web Services account.
", + "smithy.api#documentation": "Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/data-sources", @@ -11078,7 +11224,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11172,7 +11318,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11648,7 +11794,7 @@ "Namespaces": { "target": "com.amazonaws.quicksight#Namespaces", "traits": { - "smithy.api#documentation": "The information about the namespaces in this Amazon Web Services account. The response includes \n the namespace ARN, name, Amazon Web Services Region;, notification email address, creation status, and \n identity store.
" + "smithy.api#documentation": "The information about the namespaces in this Amazon Web Services account. The response includes \n the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and \n identity store.
" } }, "NextToken": { @@ -12546,7 +12692,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -12909,7 +13055,7 @@ "CapacityRegion": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The namespace Amazon Web Services Region;.
" + "smithy.api#documentation": "The namespace Amazon Web Services Region.
" } }, "CreationStatus": { @@ -12974,6 +13120,12 @@ "smithy.api#pattern": "\\S" } }, + "com.amazonaws.quicksight#NullableBoolean": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.quicksight#OnClause": { "type": "string", "traits": { @@ -13503,6 +13655,9 @@ { "target": "com.amazonaws.quicksight#DescribeIngestion" }, + { + "target": "com.amazonaws.quicksight#DescribeIpRestriction" + }, { "target": "com.amazonaws.quicksight#DescribeNamespace" }, @@ -13671,6 +13826,9 @@ { "target": "com.amazonaws.quicksight#UpdateIAMPolicyAssignment" }, + { + "target": "com.amazonaws.quicksight#UpdateIpRestriction" + }, { "target": "com.amazonaws.quicksight#UpdateTemplate" }, @@ -13859,7 +14017,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13963,12 +14121,32 @@ "traits": { "smithy.api#documentation": "The configuration details for providing an Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User\n Guide.
\nUse GenerateEmbedUrlForRegisteredUser where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console\n needs to belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use \n RegisterUser\n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:
\n Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users\n
\nFor more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
" } + }, + "QSearchBar": { + "target": "com.amazonaws.quicksight#RegisteredUserQSearchBarEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "The configuration details for embedding the Q search bar.
\nFor more information about embedding the Q search bar, see Embedding Overview.
" + } } }, "traits": { "smithy.api#documentation": "The type of experience you want to embed. For registered users, you can embed an Amazon QuickSight dashboard or the Amazon QuickSight console.
\nExactly one of the experience configurations is required. You can choose Dashboard or QuickSightConsole. You cannot choose more than one experience configuraton.
The ID of the Q topic that you want to make the starting topic in the Q search bar. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open.
\nIf you don't specify an initial topic, a list of all shared topics is shown in the Q bar for your readers. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the available ones in the list.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Q search bar embedding experience.
" + } + }, "com.amazonaws.quicksight#RegisteredUserQuickSightConsoleEmbeddingConfiguration": { "type": "structure", "members": { @@ -14363,6 +14541,13 @@ "smithy.api#box": {}, "smithy.api#documentation": "The number of rows that were not ingested.
" } + }, + "TotalRowsInDataset": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The total number of rows in the dataset.
" + } } }, "traits": { @@ -14388,7 +14573,7 @@ "PermissionPolicy": { "target": "com.amazonaws.quicksight#RowLevelPermissionPolicy", "traits": { - "smithy.api#documentation": "The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS \n is included for backward compatibility only.
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS\n is included for backward compatibility only.
The ID for the template. This is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "smithy.api#documentation": "The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, "LastUpdatedTime": { @@ -15600,7 +15785,7 @@ "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID of the template. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "smithy.api#documentation": "The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, "Name": { @@ -15980,7 +16165,7 @@ "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID of the theme. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "smithy.api#documentation": "The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, "LatestVersionNumber": { @@ -16561,7 +16746,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates Amazon QuickSight customizations the current Amazon Web Services Region;. Currently, the only\n customization you can use is a theme.
\nYou can use customizations for your Amazon Web Services account or, if you specify a namespace, for a\n Amazon QuickSight namespace instead. Customizations that apply to a namespace override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.
Updates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, the only\n customization you can use is a theme.
\nYou can use customizations for your Amazon Web Services account or, if you specify a namespace, for a\n Amazon QuickSight namespace instead. Customizations that apply to a namespace override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.
The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region;.
", + "smithy.api#documentation": "The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
", "smithy.api#required": {} } } @@ -16620,7 +16805,7 @@ "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { - "smithy.api#documentation": "The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region;.
" + "smithy.api#documentation": "The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
" } }, "RequestId": { @@ -16696,7 +16881,7 @@ "NotificationEmail": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The email address that you want Amazon QuickSight to send notifications to regarding your \n Amazon Web Services account or Amazon QuickSight subscription.
" + "smithy.api#documentation": "The email address that you want Amazon QuickSight to send notifications to regarding your\n Amazon Web Services account or Amazon QuickSight subscription.
" } } } @@ -17219,7 +17404,7 @@ "SourceEntity": { "target": "com.amazonaws.quicksight#DashboardSourceEntity", "traits": { - "smithy.api#documentation": "The entity that you are using as a source when you update the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only update a dashboard from a template, so you use a SourceTemplate\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the CreateTemplate API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate ARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region;.
Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.
The entity that you are using as a source when you update the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only update a dashboard from a template, so you use a SourceTemplate\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the CreateTemplate API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate ARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.
The ID for the dataset whose permissions you want to update. This ID is unique per \n\t\t\tAmazon Web Services Region; for each Amazon Web Services account.
", + "smithy.api#documentation": "The ID for the dataset whose permissions you want to update. This ID is unique per\n\t\t\tAmazon Web Services Region for each Amazon Web Services account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17415,7 +17600,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID for the dataset whose permissions you want to update. This ID is unique per \n\t\t\tAmazon Web Services Region; for each Amazon Web Services account.
" + "smithy.api#documentation": "The ID for the dataset whose permissions you want to update. This ID is unique per\n\t\t\tAmazon Web Services Region for each Amazon Web Services account.
" } }, "RequestId": { @@ -17447,7 +17632,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region; for each\n\t\t\tAmazon Web Services account.
", + "smithy.api#documentation": "The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each\n\t\t\tAmazon Web Services account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17526,7 +17711,7 @@ "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, "IngestionArn": { @@ -17644,7 +17829,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17675,7 +17860,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, "RequestId": { @@ -17707,7 +17892,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
", + "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -17757,7 +17942,7 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region; for each Amazon Web Services account.
" + "smithy.api#documentation": "The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, "UpdateStatus": { @@ -18050,7 +18235,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18224,6 +18409,92 @@ } } }, + "com.amazonaws.quicksight#UpdateIpRestriction": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateIpRestrictionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateIpRestrictionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Updates content and status of IP Rules.
", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/ip-restriction", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateIpRestrictionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "Your AWS account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IpRestrictionRuleMap": { + "target": "com.amazonaws.quicksight#IpRestrictionRuleMap", + "traits": { + "smithy.api#documentation": "Describes updated IP rules.
" + } + }, + "Enabled": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "Whether or not IP rules are enabled.
" + } + } + } + }, + "com.amazonaws.quicksight#UpdateIpRestrictionResponse": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "Your AWS account ID.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the update request.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "The status of the updated IP rules. A successful request returns a 200 code.
", + "smithy.api#httpResponseCode": {} + } + } + } + }, "com.amazonaws.quicksight#UpdateResourcePermissionList": { "type": "list", "member": { @@ -18952,7 +19223,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -18975,7 +19246,7 @@ "Role": { "target": "com.amazonaws.quicksight#UserRole", "traits": { - "smithy.api#documentation": "The Amazon QuickSight role of the user. The role can be one of the\n\t\t\tfollowing default security cohorts:
\n\t\t\n READER: A user who has read-only access to dashboards.
\n AUTHOR: A user who can create data sources, datasets, analyses, and\n\t\t\t\t\tdashboards.
\n ADMIN: A user who is an author, who can also manage Amazon QuickSight\n\t\t\t\t\tsettings.
The name of the Amazon QuickSight role is invisible to the user except for the console \n\t screens dealing with permissions.
", + "smithy.api#documentation": "The Amazon QuickSight role of the user. The role can be one of the\n\t\t\tfollowing default security cohorts:
\n\t\t\n READER: A user who has read-only access to dashboards.
\n AUTHOR: A user who can create data sources, datasets, analyses, and\n\t\t\t\t\tdashboards.
\n ADMIN: A user who is an author, who can also manage Amazon QuickSight\n\t\t\t\t\tsettings.
The name of the Amazon QuickSight role is invisible to the user except for the console\n\t screens dealing with permissions.
", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/rds.2014-10-31.json b/codegen/sdk/aws-models/rds.2014-10-31.json index 59700556a48..9f3fce7c2bc 100644 --- a/codegen/sdk/aws-models/rds.2014-10-31.json +++ b/codegen/sdk/aws-models/rds.2014-10-31.json @@ -165,7 +165,7 @@ "FeatureName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the feature for the DB cluster that the IAM role is to be associated with. \n For the list of supported feature names, see DBEngineVersion.
" + "smithy.api#documentation": "The name of the feature for the DB cluster that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.
" } } } @@ -190,7 +190,7 @@ } ], "traits": { - "smithy.api#documentation": "Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
\nTo add a role to a DB instance, the status of the DB instance must be available.
Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
\nTo add a role to a DB instance, the status of the DB instance must be available.
This command doesn't apply to RDS Custom.
" } }, "com.amazonaws.rds#AddRoleToDBInstanceMessage": { @@ -213,7 +213,7 @@ "FeatureName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the feature for the DB instance that the IAM role is to be associated with. \n For the list of supported feature names, see DBEngineVersion.\n
", + "smithy.api#documentation": "The name of the feature for the DB instance that the IAM role is to be associated with. \n For information about supported feature names, see DBEngineVersion.\n
", "smithy.api#required": {} } } @@ -363,6 +363,9 @@ { "target": "com.amazonaws.rds#CreateCustomAvailabilityZone" }, + { + "target": "com.amazonaws.rds#CreateCustomDBEngineVersion" + }, { "target": "com.amazonaws.rds#CreateDBCluster" }, @@ -411,6 +414,9 @@ { "target": "com.amazonaws.rds#DeleteCustomAvailabilityZone" }, + { + "target": "com.amazonaws.rds#DeleteCustomDBEngineVersion" + }, { "target": "com.amazonaws.rds#DeleteDBCluster" }, @@ -603,6 +609,9 @@ { "target": "com.amazonaws.rds#ModifyCurrentDBClusterCapacity" }, + { + "target": "com.amazonaws.rds#ModifyCustomDBEngineVersion" + }, { "target": "com.amazonaws.rds#ModifyDBCluster" }, @@ -971,6 +980,21 @@ } } }, + "com.amazonaws.rds#AutomationMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "full", + "name": "FULL" + }, + { + "value": "all-paused", + "name": "ALL_PAUSED" + } + ] + } + }, "com.amazonaws.rds#AvailabilityZone": { "type": "structure", "members": { @@ -1130,6 +1154,16 @@ "smithy.api#box": {} } }, + "com.amazonaws.rds#BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": ".*" + } + }, "com.amazonaws.rds#CancelExportTask": { "type": "operation", "input": { @@ -1504,7 +1538,7 @@ } ], "traits": { - "smithy.api#documentation": "Copies a snapshot of a DB cluster.
\nTo copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action \n is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, \n you must provide the following values:
\n KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n PreSignedUrl - A URL that contains a Signature Version 4 signed request for the \n CopyDBClusterSnapshot action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from. \n The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the \n source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
\n\n KmsKeyId - The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB \n cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see \n\n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
\n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. \n This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.
For more information on copying encrypted DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.\n
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nCopies a snapshot of a DB cluster.
\nTo copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier\n must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action \n is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, \n you must provide the following values:
\n KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to \n encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n PreSignedUrl - A URL that contains a Signature Version 4 signed request for the \n CopyDBClusterSnapshot action to be called in the source Amazon Web Services Region where the DB cluster snapshot is copied from. \n The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the \n source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
\n\n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB \n cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
\n TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. \n This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified\n by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.
For more information on copying encrypted DB cluster snapshots from one Amazon Web Services Region to another, see \n \n Copying a Snapshot in the Amazon Aurora User Guide.\n
\nFor more information on Amazon Aurora, see \n \n What Is Amazon Aurora? in the Amazon Aurora User Guide.\n
\nThis action only applies to Aurora DB clusters.
\nThe Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
\n \nIf you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new Amazon Web Services KMS CMK. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same Amazon Web Services KMS key as the source DB cluster snapshot. \n
If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.
To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot \n in the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region that they are created in, and you can't use CMKs from one Amazon Web Services Region \n in another Amazon Web Services Region.
If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.
The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.
\n \nIf you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. \n If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. \n
If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId.
To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier \n you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services \n Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region \n in another Amazon Web Services Region.
If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, \n an error is returned.
The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the \n source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. \n Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.
The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be\n executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. \n The pre-signed URL request must contain the following parameter values:
\n KmsKeyId - The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB \n cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see \n\n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\n \nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services Region that contains the \n source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. \n Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.
The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be\n executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. \n The pre-signed URL request must contain the following parameter values:
\n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB \n cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.
\n SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster \n snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, \n if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBClusterSnapshotIdentifier\n looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see \n\n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\n \nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
Copies the specified DB snapshot. The source DB snapshot must be in the available state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region\n where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for the\n DB snapshot copy.
For more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Copies the specified DB snapshot. The source DB snapshot must be in the available state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region\n where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for the\n DB snapshot copy.
This command doesn't apply to RDS Custom.
\n \nFor more information about copying snapshots, see \n Copying a DB Snapshot in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#CopyDBSnapshotMessage": { @@ -1673,7 +1707,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted DB snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). \n
\n \nIf you copy an encrypted DB snapshot from your Amazon Web Services account, \n you can specify a value for this parameter to encrypt the copy with a new Amazon Web Services KMS CMK. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot. \n
\n\nIf you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, \n then you must specify a value for this parameter.\n
\n \nIf you specify this parameter when you copy an unencrypted snapshot, \n the copy is encrypted.\n
\n \nIf you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify\n a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to the Amazon Web Services Region\n that they are created in, and you can't use CMKs from one Amazon Web Services Region in another\n Amazon Web Services Region.\n
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted DB snapshot. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n
\n \nIf you copy an encrypted DB snapshot from your Amazon Web Services account, \n you can specify a value for this parameter to encrypt the copy with a new KMS key. \n If you don't specify a value for this parameter, \n then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot. \n
\n\nIf you copy an encrypted DB snapshot that is shared from another Amazon Web Services account, \n then you must specify a value for this parameter.\n
\n \nIf you specify this parameter when you copy an unencrypted snapshot, \n the copy is encrypted.\n
\n \nIf you copy an encrypted snapshot to a different Amazon Web Services Region, then you must specify\n an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region\n that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another\n Amazon Web Services Region.\n
" } }, "Tags": { @@ -1688,7 +1722,7 @@ "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The URL that contains a Signature Version 4 signed request for the\n CopyDBSnapshot API action in the source Amazon Web Services Region that contains the\n source DB snapshot to copy.
You must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CopyDBSnapshot API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. \n The presigned URL request must contain the following parameter values:\n
\n DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. \n This Amazon Web Services Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.\n
For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region\n to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot action in\n the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the\n CopyDBSnapshot action in the us-west-2 Amazon Web Services Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 Amazon Web Services Region.
\n KmsKeyId - The Amazon Web Services KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. \n This is the same identifier for both the CopyDBSnapshot action that is called in the destination Amazon Web Services Region, \n and the action contained in the presigned URL.\n
\n SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. \n For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like\n the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.\n
To learn how to generate a Signature Version 4 signed request, see \n\t\tAuthenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n\t\tSignature Version 4 Signing Process.\n\t
\n \nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
The URL that contains a Signature Version 4 signed request for the\n CopyDBSnapshot API action in the source Amazon Web Services Region that contains the\n source DB snapshot to copy.
You must specify this parameter when you copy an encrypted DB snapshot from another\n Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are \n copying an encrypted DB snapshot in the same Amazon Web Services Region.
The presigned URL must be a valid request for the CopyDBSnapshot API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. \n The presigned URL request must contain the following parameter values:\n
\n DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. \n This Amazon Web Services Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.\n
For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region\n to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot action in\n the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the\n CopyDBSnapshot action in the us-west-2 Amazon Web Services Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 Amazon Web Services Region.
\n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. \n This is the same identifier for both the CopyDBSnapshot action that is called in the destination Amazon Web Services Region, \n and the action contained in the presigned URL.\n
\n SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. \n For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services Region, then your SourceDBSnapshotIdentifier looks like\n the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.\n
To learn how to generate a Signature Version 4 signed request, see \n\t\tAuthenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n\t\tSignature Version 4 Signing Process.\n\t
\n \nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and \n specific AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 \n or later RU/RUR. For \n more information, see \n Amazon RDS Custom requirements and limitations in the Amazon RDS User Guide.
\nAmazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software.\n The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create\n your database. With Amazon RDS Custom, you upload your database installation files in Amazon S3. For \n more information, see \n Preparing to create a CEV in the Amazon RDS User Guide.
\nWhen you create a custom engine version, you specify the files in a JSON document called a CEV manifest. \n This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from \n the installation files that you provided. This service model is called Bring Your Own Media (BYOM).
\nCreation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with \n the message Creation failed for custom engine version, and includes details about the failure. \n For example, the event prints missing files.
After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple \n RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or\n inactive.
\nThe MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the CreateCustomDbEngineVersion event.
For more information, see \n Creating a CEV in the Amazon RDS User Guide.
" + } + }, + "com.amazonaws.rds#CreateCustomDBEngineVersionMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#CustomEngineName", + "traits": { + "smithy.api#documentation": "The database engine to use for your custom engine version (CEV). The only supported value is \n custom-oracle-ee.
The name of your CEV. The name format is 19.customized_string\n . For example, \n a valid name is 19.my_cev1. This setting is required for RDS Custom, but optional for Amazon RDS. \n The combination of Engine and EngineVersion is unique per customer per Region.
The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid \n bucket name is my-custom-installation-files.
The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid \n bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.
The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric KMS key is required for \n RDS Custom, but optional for Amazon RDS.
\nIf you have an existing symmetric KMS key in your account, you can use it with RDS Custom. \n No further action is necessary. If you don't already have a symmetric KMS key in your account, \n follow the instructions in \n Creating symmetric KMS keys in the Amazon Web Services Key Management Service\n Developer Guide.
\nYou can choose the same symmetric key when you create a CEV and a DB instance, or choose different keys.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.rds#Description", + "traits": { + "smithy.api#documentation": "An optional description of your CEV.
" + } + }, + "Manifest": { + "target": "com.amazonaws.rds#CustomDBEngineVersionManifest", + "traits": { + "smithy.api#documentation": "The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. \n Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which \n they are listed.
\nThe following JSON fields are valid:
\nVersion of the CEV manifest. The date is in the format YYYY-MM-DD.
Ordered list of installation files for the CEV.
\nOrdered list of OPatch installers used for the Oracle DB engine.
\nThe PSU and RU patches for this CEV.
\nThe patches that are not in the list of PSU and RU patches. \n Amazon RDS applies these patches after applying the PSU and RU patches.
\nFor more information, see \n Creating the CEV manifest in the Amazon RDS User Guide.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.rds#TagList" + } + } + }, "com.amazonaws.rds#CreateDBCluster": { "type": "operation", "input": { @@ -2109,13 +2221,13 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted DB cluster.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).\n To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nWhen a CMK isn't specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS will use the CMK used to encrypt the\n source. Otherwise, Amazon RDS will use your default CMK.
If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n will use your default CMK.
There is a default CMK for your Amazon Web Services account. Your Amazon Web Services account\n has a different default CMK for each Amazon Web Services Region.
\nIf you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you\n must set KmsKeyId to a Amazon Web Services KMS key identifier that is valid in the destination Amazon Web Services\n Region. This CMK is used to encrypt the read replica in that Amazon Web Services Region.
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nWhen a KMS key isn't specified in KmsKeyId:
If ReplicationSourceIdentifier identifies an encrypted\n source, then Amazon RDS will use the KMS key used to encrypt the\n source. Otherwise, Amazon RDS will use your default KMS key.
If the StorageEncrypted parameter is enabled and\n ReplicationSourceIdentifier isn't specified, then Amazon RDS\n will use your default KMS key.
There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account\n has a different default KMS key for each Amazon Web Services Region.
\nIf you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you\n must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services\n Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
A URL that contains a Signature Version 4 signed request for \n the CreateDBCluster action to be called in the source Amazon Web Services Region where the DB cluster is replicated from. \n You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.
The pre-signed URL must be a valid request for the CreateDBCluster API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
\n\n KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to encrypt the copy of \n the DB cluster in the destination Amazon Web Services Region. This should refer to the same Amazon Web Services KMS CMK for both the CreateDBCluster \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.
\n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
A URL that contains a Signature Version 4 signed request for \n the CreateDBCluster action to be called in the source Amazon Web Services Region where the DB cluster is replicated from. \n You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.
The pre-signed URL must be a valid request for the CreateDBCluster API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster to be copied.
The pre-signed URL request must contain the following parameter values:
\n\n KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of \n the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster \n action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL.
\n DestinationRegion - The name of the Amazon Web Services Region that Aurora read replica will\n be created in.
\n ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. \n This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are copying an \n encrypted DB cluster from the us-west-2 Amazon Web Services Region, then your ReplicationSourceIdentifier would look like\n Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.
To learn how to generate a Signature Version 4 signed request, see \n \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n \n Signature Version 4 Signing Process.
\nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) \n instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid \n request for the operation that can be executed in the source Amazon Web Services Region.
The meaning of this parameter differs according to the database engine you use.
\n\n MySQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n MariaDB\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n PostgreSQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.
Constraints:
\nMust contain 1 to 63 letters, numbers, or underscores.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n Oracle\n
\nThe Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName. \n
Default: ORCL\n
Constraints:
\nCan't be longer than 8 characters
\n\n SQL Server\n
\nNot applicable. Must be null.
\n\n Amazon Aurora MySQL\n
\nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.
\nConstraints:
\nIt must contain 1 to 64 alphanumeric characters.
\nIt can't be a word reserved by the database engine.
\n\n Amazon Aurora PostgreSQL\n
\nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.
Constraints:
\nIt must contain 1 to 63 alphanumeric characters.
\nIt must begin with a letter or an underscore.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).
\nIt can't be a word reserved by the\n database engine.
\nThe meaning of this parameter differs according to the database engine you use.
\n\n MySQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n MariaDB\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n PostgreSQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.
Constraints:
\nMust contain 1 to 63 letters, numbers, or underscores.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n Oracle\n
\nThe Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName. \n
Default: ORCL\n
Constraints:
\nCan't be longer than 8 characters
\n\n Amazon RDS Custom\n
\nThe Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL.\n
Default: ORCL\n
Constraints:
\nIt must contain 1 to 8 alphanumeric characters.
\nIt must contain a letter.
\nIt can't be a word reserved by the database engine.
\n\n SQL Server\n
\nNot applicable. Must be null.
\n\n Amazon Aurora MySQL\n
\nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.
\nConstraints:
\nIt must contain 1 to 64 alphanumeric characters.
\nIt can't be a word reserved by the database engine.
\n\n Amazon Aurora PostgreSQL\n
\nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.
Constraints:
\nIt must contain 1 to 63 alphanumeric characters.
\nIt must begin with a letter or an underscore.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).
\nIt can't be a word reserved by the\n database engine.
\nThe amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nType: Integer
\n\n Amazon Aurora\n
\nNot applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.
\n\n\n MySQL\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n MariaDB\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n PostgreSQL\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n Oracle\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 10 to 3072.
\n\n SQL Server\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2):
\nEnterprise and Standard editions: Must be an integer from 200 to 16384.
\nWeb and Express editions: Must be an integer from 20 to 16384.
\nProvisioned IOPS storage (io1):
\nEnterprise and Standard editions: Must be an integer from 200 to 16384.
\nWeb and Express editions: Must be an integer from 100 to 16384.
\nMagnetic storage (standard):
\nEnterprise and Standard editions: Must be an integer from 200 to 1024.
\nWeb and Express editions: Must be an integer from 20 to 1024.
\nThe amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nType: Integer
\n\n Amazon Aurora\n
\nNot applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.
\n\n\n Amazon RDS Custom\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 40 to 65536.
\n\n MySQL\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n MariaDB\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n PostgreSQL\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n Oracle\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 10 to 3072.
\n\n SQL Server\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2):
\nEnterprise and Standard editions: Must be an integer from 200 to 16384.
\nWeb and Express editions: Must be an integer from 20 to 16384.
\nProvisioned IOPS storage (io1):
\nEnterprise and Standard editions: Must be an integer from 200 to 16384.
\nWeb and Express editions: Must be an integer from 100 to 16384.
\nMagnetic storage (standard):
\nEnterprise and Standard editions: Must be an integer from 200 to 1024.
\nWeb and Express editions: Must be an integer from 20 to 1024.
\nThe name of the database engine to be used for this instance.\n
\n \nNot every database engine is available for every Amazon Web Services Region.\n
\n\nValid Values:\n
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the database engine to be used for this instance.\n
\n \nNot every database engine is available for every Amazon Web Services Region.\n
\n\nValid Values:\n
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible Aurora)
\n aurora-postgresql\n
\n custom-oracle-ee (for RDS Custom instances)\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then \n the default DB parameter group for the specified DB engine and version is used.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe name of the DB parameter group to associate with this DB instance. If you do not specify a value, then \n the default DB parameter group for the specified DB engine and version is used.
\nThis setting doesn't apply to RDS Custom.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\n\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB\n cluster.
\nDefault: 1
\nConstraints:
\nMust be a value from 0 to 35
\nCan't be set to 0 if the DB instance is a source to read replicas
\nThe number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.
\n\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB cluster.
\nDefault: 1
\nConstraints:
\nMust be a value from 0 to 35
\nCan't be set to 0 if the DB instance is a source to read replicas
\nCan't be set to 0 or 35 for an RDS Custom DB instance
\nA value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set \n the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
This setting doesn't apply to RDS Custom.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The version number of the database engine to use.
\nFor a list of valid engine versions, use the DescribeDBEngineVersions action.
The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
\n \n\n Amazon Aurora\n
\nNot applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.
\n \n\n MariaDB\n
\n\nSee MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n \n\n Microsoft SQL Server\n
\n \nSee Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.\n
\n \n\n MySQL\n
\n\nSee MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n \n\n Oracle\n
\n \nSee Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.\n
\n\n\n PostgreSQL\n
\n\nSee Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n
" + "smithy.api#documentation": "The version number of the database engine to use.
\nFor a list of valid engine versions, use the DescribeDBEngineVersions action.
The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
\n \n\n Amazon Aurora\n
\nNot applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.
\n \n\n Amazon RDS Custom\n
\nA custom engine version (CEV) that you have previously created. This setting is required for RDS Custom. The CEV \n name has the following format: 19.customized_string\n . An example identifier is \n 19.my_cev1. For more information, see \n Creating an RDS Custom DB instance in the Amazon RDS User Guide..
\n MariaDB\n
\n\nSee MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n \n\n Microsoft SQL Server\n
\n \nSee Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.\n
\n \n\n MySQL\n
\n\nSee MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n \n\n Oracle\n
\n \nSee Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.\n
\n\n\n PostgreSQL\n
\n\nSee Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.
" + "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. \n By default, minor engine upgrades are applied automatically.
\nIf you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to \n false.
License model information for this DB instance.
\n\n Valid values: license-included | bring-your-own-license | general-public-license\n
License model information for this DB instance.
\n\n Valid values: license-included | bring-your-own-license | general-public-license\n
This setting doesn't apply to RDS Custom.
" } }, "Iops": { @@ -2537,19 +2649,19 @@ "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A value that indicates that the DB instance should be associated with the specified option group.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance
" + "smithy.api#documentation": "A value that indicates that the DB instance should be associated with the specified option group.
\nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group. Also, that option group can't be removed from a DB instance after it is \n associated with a DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "CharacterSetName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.
\n \n\n Amazon Aurora\n
\nNot applicable. The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.
For supported engines, this value indicates that the DB instance should be associated with the \n specified CharacterSet.
This setting doesn't apply to RDS Custom. However, if you need to change the character set, \n you can change it on the database itself.
\n\n Amazon Aurora\n
\nNot applicable. The character set is managed by\n the DB cluster. For more information, see CreateDBCluster.
The name of the NCHAR character set for the Oracle DB instance.
" + "smithy.api#documentation": "The name of the NCHAR character set for the Oracle DB instance.
\nThis parameter doesn't apply to RDS Custom.
" } }, "PubliclyAccessible": { @@ -2567,7 +2679,7 @@ "DBClusterIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier of the DB cluster that the instance will belong to.
" + "smithy.api#documentation": "The identifier of the DB cluster that the instance will belong to.
\nThis setting doesn't apply to RDS Custom.
" } }, "StorageType": { @@ -2579,31 +2691,31 @@ "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
" + "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to RDS Custom.
" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
" + "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom.
" } }, "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
\n \n\n Amazon Aurora\n
\nNot applicable. The encryption for DB instances is managed by\n the DB cluster.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
\nFor RDS Custom Oracle instances, either set this parameter to true or leave it unset. \n If you set this parameter to false, RDS reports an error.
\n Amazon Aurora\n
\nNot applicable. The encryption for DB instances is managed by the DB cluster.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted DB instance.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).\n To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.
\n\n Amazon Aurora\n
\nNot applicable. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.
If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default CMK. There is a \n default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different\n default CMK for each Amazon Web Services Region.
The Amazon Web Services KMS key identifier for an encrypted DB instance.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\n\n Amazon Aurora\n
\nNot applicable. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.
If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.
\n Amazon RDS Custom\n
\nA KMS key is required for RDS Custom Oracle instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom for Oracle \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.
The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "CopyTagsToSnapshot": { @@ -2615,25 +2727,25 @@ "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for \n the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must set MonitoringInterval\n to a value other than 0.
This setting doesn't apply to RDS Custom.
\nValid Values: 0, 1, 5, 10, 15, 30, 60\n
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see Setting Up and Enabling Enhanced Monitoring \n in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" } }, "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.\n
\nDefault: 1
\nValid Values: 0 - 15
" + "smithy.api#documentation": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. \n
\nThis setting doesn't apply to RDS Custom.
\nDefault: 1
\nValid Values: 0 - 15
" } }, "Timezone": { @@ -2645,37 +2757,37 @@ "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nThis setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.
\n \nFor more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\nThis setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora, mapping Amazon Web Services IAM accounts \n to database accounts is managed by the DB cluster.
\nFor more information, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance.\n
\nFor more information, see \n Using Amazon Performance Insights in the Amazon Relational Database Service\n User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance. For more information, see \n Using Amazon Performance Insights in the Amazon Relational Database Service\n User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your Amazon Web Services account. \n Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
" + "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database\n Service User Guide.
\n\n Amazon Aurora\n
\nNot applicable. CloudWatch Logs exports are managed by the DB cluster.\n
\n\n MariaDB\n
\nPossible values are audit, error, general, and slowquery. \n
\n Microsoft SQL Server\n
\nPossible values are agent and error.\n
\n MySQL\n
\nPossible values are audit, error, general, and slowquery. \n
\n Oracle\n
\nPossible values are alert, audit, listener, trace, and\n oemagent.\n
\n PostgreSQL\n
\nPossible values are postgresql and upgrade.\n
The list of log types that need to be enabled for exporting to CloudWatch Logs. The values\n in the list depend on the DB engine. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database\n Service User Guide.
\n\n Amazon Aurora\n
\nNot applicable. CloudWatch Logs exports are managed by the DB cluster.\n
\n\n RDS Custom\n
\nNot applicable.\n
\n\n MariaDB\n
\nPossible values are audit, error, general, and slowquery. \n
\n Microsoft SQL Server\n
\nPossible values are agent and error.\n
\n MySQL\n
\nPossible values are audit, error, general, and slowquery. \n
\n Oracle\n
\nPossible values are alert, audit, listener, trace, and\n oemagent.\n
\n PostgreSQL\n
\nPossible values are postgresql and upgrade.\n
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
" + "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "DeletionProtection": { @@ -2687,7 +2799,7 @@ "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableCustomerOwnedIp": { @@ -2695,6 +2807,12 @@ "traits": { "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS\n on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon Relational Database Service\n User Guide.
\nThis setting is required for RDS Custom.
" + } } }, "traits": { @@ -2785,7 +2903,7 @@ "SourceDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.
\nConstraints:
\nMust be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB\n instance.
\nCan specify a DB instance that is a MySQL read replica only if the source is running MySQL\n 5.6 or later.
\nFor the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the\n Amazon RDS User Guide.
\nFor the limitations of SQL Server read replicas, see Read Replica\n Limitations with Microsoft SQL Server in the Amazon RDS User Guide.
\nCan specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or\n later (9.4.7 and higher for cross-region replication).
\nThe specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.
\nIf the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB\n instance identifier.
\nIf the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. \n For more information, see Constructing an ARN for Amazon RDS \n in the Amazon RDS User Guide. This doesn't apply to SQL Server, which doesn't support cross-region replicas.
\nThe identifier of the DB instance that will act as the source for the read replica.\n Each DB instance can have up to five read replicas.
\nConstraints:
\nMust be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB\n instance.
\nCan specify a DB instance that is a MySQL read replica only if the source is running MySQL\n 5.6 or later.
\nFor the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the\n Amazon RDS User Guide.
\nFor the limitations of SQL Server read replicas, see Read Replica\n Limitations with Microsoft SQL Server in the Amazon RDS User Guide.
\nCan specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or\n later (9.4.7 and higher for cross-region replication).
\nThe specified DB instance must have automatic backups enabled, that is, its backup\n retention period must be greater than 0.
\nIf the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB\n instance identifier.
\nIf the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. \n For more information, see Constructing an ARN for Amazon RDS \n in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support \n cross-Region replicas.
\nA value that indicates whether the read replica is in a Multi-AZ deployment.
\n \nYou can create a read replica as a Multi-AZ DB instance. RDS creates a standby of\n your replica in another Availability Zone for failover support for the replica. Creating\n your read replica as a Multi-AZ DB instance is independent of whether the source\n database is a Multi-AZ DB instance.
" + "smithy.api#documentation": "A value that indicates whether the read replica is in a Multi-AZ deployment.
\n \nYou can create a read replica as a Multi-AZ DB instance. RDS creates a standby of\n your replica in another Availability Zone for failover support for the replica. Creating\n your read replica as a Multi-AZ DB instance is independent of whether the source\n database is a Multi-AZ DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window.
\nDefault: Inherits from the source DB instance
" + "smithy.api#documentation": "A value that indicates whether minor engine upgrades are applied automatically to the\n read replica during the maintenance window.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Inherits from the source DB instance
" } }, "Iops": { @@ -2828,13 +2946,13 @@ "OptionGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.
\nFor SQL Server, you must use the option group associated with the source\n instance.
\nThe option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.
\nFor SQL Server, you must use the option group associated with the source\n instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross region read replica.
Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then Amazon RDS\n uses the DBParameterGroup of source DB instance for a same region read\n replica, or the default DBParameterGroup for the specified DB engine for a\n cross region read replica.
Specifying a parameter group for this operation is only supported for Oracle DB instances. It \n isn't supported for RDS Custom.
\nConstraints:
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter
\nCan't end with a hyphen or contain two consecutive hyphens
\nA list of EC2 VPC security groups to associate with the read replica.
\n\n Default: The default EC2 VPC security group for the DB subnet group's VPC.\n
" + "smithy.api#documentation": "A list of Amazon EC2 VPC security groups to associate with the read replica.
\nThis setting doesn't apply to RDS Custom.
\n\n Default: The default EC2 VPC security group for the DB subnet group's VPC.\n
" } }, "StorageType": { @@ -2873,67 +2991,67 @@ "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
The interval, in seconds, between points when Enhanced Monitoring metrics are\n collected for the read replica. To disable collecting Enhanced Monitoring metrics,\n specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.
This setting doesn't apply to RDS Custom.
\nValid Values: 0, 1, 5, 10, 15, 30, 60\n
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must \n supply a MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted read replica.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS CMK.
\nIf you create an encrypted read replica in the same Amazon Web Services Region as the source DB\n instance, then do not specify a value for this parameter. A read replica in the same Region\n is always encrypted with the same Amazon Web Services KMS CMK as the source DB instance.
\nIf you create an encrypted read replica in a different Amazon Web Services Region, then you must\n specify a Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. Amazon Web Services KMS CMKs are specific to\n the Amazon Web Services Region that they are created in, and you can't use CMKs from one\n Amazon Web Services Region in another Amazon Web Services Region.
\nYou can't create an encrypted read replica from an unencrypted DB instance.
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted read replica.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you create an encrypted read replica in the same Amazon Web Services Region as the source DB\n instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region\n is always encrypted with the same KMS key as the source DB instance.
\nIf you create an encrypted read replica in a different Amazon Web Services Region, then you must\n specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to\n the Amazon Web Services Region that they are created in, and you can't use KMS keys from one\n Amazon Web Services Region in another Amazon Web Services Region.
\nYou can't create an encrypted read replica from an unencrypted DB instance.
\nThis setting doesn't apply to RDS Custom, which uses the same KMS key as the primary \n replica.
" } }, "PreSignedUrl": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action \n in the source Amazon Web Services Region that contains the source DB instance.\n
You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. \n The presigned URL request must contain the following parameter values:\n
\n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica action is called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region,\n from a source DB instance in the us-east-2 Amazon Web Services Region, \n then you call the CreateDBInstanceReadReplica action in\n the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 Amazon Web Services Region.\n
\n KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica action that is\n called in the destination Amazon Web Services Region, and the action contained in the presigned\n URL.
\n SourceDBInstanceIdentifier - The DB instance identifier for\n the encrypted DB instance to be replicated. This identifier must be in the\n Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you\n are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services\n Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.\n
\n \nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can be executed in the source Amazon Web Services Region.
\n SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS\n doesn't support cross-region read replicas.
The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action \n in the source Amazon Web Services Region that contains the source DB instance.\n
You must specify this parameter when you create an encrypted read replica from\n another Amazon Web Services Region by using the Amazon RDS API. Don't specify\n PreSignedUrl when you are creating an encrypted read replica in the\n same Amazon Web Services Region.
The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action \n that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. \n The presigned URL request must contain the following parameter values:\n
\n DestinationRegion - The Amazon Web Services Region that the encrypted read\n replica is created in. This Amazon Web Services Region is the same one where the\n CreateDBInstanceReadReplica action is called that contains this presigned URL.
For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region,\n from a source DB instance in the us-east-2 Amazon Web Services Region, \n then you call the CreateDBInstanceReadReplica action in\n the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the\n CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this\n example, the DestinationRegion in the presigned URL must be set to\n the us-east-1 Amazon Web Services Region.\n
\n KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to\n encrypt the read replica in the destination Amazon Web Services Region. This is the same\n identifier for both the CreateDBInstanceReadReplica action that is\n called in the destination Amazon Web Services Region, and the action contained in the presigned\n URL.
\n SourceDBInstanceIdentifier - The DB instance identifier for\n the encrypted DB instance to be replicated. This identifier must be in the\n Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you\n are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services\n Region, then your SourceDBInstanceIdentifier looks like the\n following example:\n arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.
To learn how to generate a Signature Version 4 signed request, see \n Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and\n Signature Version 4 Signing Process.\n
\n \nIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\n SourceRegion (or --source-region for the CLI)\n instead of specifying PreSignedUrl manually. Specifying\n SourceRegion autogenerates a presigned URL that is a valid request\n for the operation that can be executed in the source Amazon Web Services Region.
\n SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS\n doesn't support cross-region read replicas.
This setting doesn't apply to RDS Custom.
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the read replica.
\nFor more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the read replica.
\nFor more information, see Using\n Amazon Performance Insights in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your Amazon Web Services account. \n Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
" + "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The list of logs that the new DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing\n Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
" + "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
" + "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
\nThis setting doesn't apply to RDS Custom.
" } }, "DeletionProtection": { @@ -2945,19 +3063,19 @@ "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" } }, "ReplicaMode": { "target": "com.amazonaws.rds#ReplicaMode", "traits": { - "smithy.api#documentation": "The open mode of the replica database: mounted or read-only.
\nThis parameter is only supported for Oracle DB instances.
\nMounted DB replicas are included in Oracle Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.
\nYou can create a combination of mounted and read-only DB replicas for the same primary DB instance.\n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The open mode of the replica database: mounted or read-only.
\nThis parameter is only supported for Oracle DB instances.
\nMounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for\n mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active\n Data Guard to transmit information to the mounted replica. Because it doesn't accept\n user connections, a mounted replica can't serve a read-only workload.
\nYou can create a combination of mounted and read-only DB replicas for the same primary DB instance.\n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
\nFor RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. \n After replica creation, you can manage the open mode manually.
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
" } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon Relational Database Service\n User Guide.
\nThis setting is required for RDS Custom.
" + } } } }, @@ -3001,7 +3125,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new DB parameter group.
\n\n A DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBParameterGroup. Once you've created a DB parameter group, you need to\n associate it with your DB instance using ModifyDBInstance. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect. \n
\nAfter you create a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.
Creates a new DB parameter group.
\n\n A DB parameter group is initially created with the default parameters for the\n database engine used by the DB instance. To provide custom values for any of the\n parameters, you must modify the group after creating it using\n ModifyDBParameterGroup. Once you've created a DB parameter group, you need to\n associate it with your DB instance using ModifyDBInstance. When you associate\n a new DB parameter group with a running DB instance, you need to reboot the DB\n instance without failover for the new DB parameter group and associated settings to take effect. \n
This command doesn't apply to RDS Custom.
\nAfter you create a DB parameter group, you should wait at least 5 minutes\n before creating your first DB instance that uses that DB parameter group as the default parameter \n group. This allows Amazon RDS to fully complete the create action before the parameter \n group is used as the default for a new DB instance. This is especially important for parameters \n that are critical when creating the default database for a DB instance, such as the character set \n for the default database defined by the character_set_database parameter. You can use the \n Parameter Groups option of the Amazon RDS console or the \n DescribeDBParameters command to verify \n that your DB parameter group has been created or modified.
Creates a new option group. You can create up to 20 option groups.
" + "smithy.api#documentation": "Creates a new option group. You can create up to 20 option groups.
\nThis command doesn't apply to RDS Custom.
" } }, "com.amazonaws.rds#CreateOptionGroupMessage": { @@ -3774,6 +3898,106 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.rds#CustomDBEngineVersionAlreadyExistsFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomDBEngineVersionAlreadyExistsFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "A CEV with the specified name already exists.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#CustomDBEngineVersionManifest": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 51000 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, + "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomDBEngineVersionNotFoundFault", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "The specified CEV was not found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.rds#CustomDBEngineVersionQuotaExceededFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "CustomDBEngineVersionQuotaExceededFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "You have exceeded your CEV quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.rds#CustomEngineName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 35 + }, + "smithy.api#pattern": "^[A-Za-z0-9-]{1,35}$" + } + }, + "com.amazonaws.rds#CustomEngineVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 60 + }, + "smithy.api#pattern": "^(11\\.\\d{1}|12\\.\\d{1}|18|19)(\\.[a-zA-Z0-9_.-]{1,50})$" + } + }, + "com.amazonaws.rds#CustomEngineVersionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "available", + "name": "available" + }, + { + "value": "inactive", + "name": "inactive" + }, + { + "value": "inactive-except-restore", + "name": "inactive_except_restore" + } + ] + } + }, "com.amazonaws.rds#DBCluster": { "type": "structure", "members": { @@ -3960,13 +4184,13 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
" + "smithy.api#documentation": "If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "DbClusterResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever \n the Amazon Web Services KMS CMK for the DB cluster is accessed.
" + "smithy.api#documentation": "The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever \n the KMS key for the DB cluster is accessed.
" } }, "DBClusterArn": { @@ -4065,7 +4289,7 @@ "ActivityStreamKmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "ActivityStreamKinesisStreamName": { @@ -4678,7 +4902,7 @@ "FeatureName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For the list of supported feature names, see DBEngineVersion.\n
" + "smithy.api#documentation": "The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.\n
" } } }, @@ -4854,7 +5078,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
" + "smithy.api#documentation": "If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "DBClusterSnapshotArn": { @@ -5085,7 +5309,7 @@ "SupportedFeatureNames": { "target": "com.amazonaws.rds#FeatureNameList", "traits": { - "smithy.api#documentation": "\n A list of features supported by the DB engine. Supported feature names include the following.\n
\ns3Import
\n\n A list of features supported by the DB engine.\n
\nThe supported features vary by DB engine and DB engine version.
\nTo determine the supported features for a specific DB engine and DB engine version using the CLI, \n use the following command:
\n\n aws rds describe-db-engine-versions --engine \n
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, \n use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --engine-version 13.3\n
The supported features are listed under SupportedFeatureNames in the output.
A value that indicates whether you can use Aurora global databases with a specific DB engine version.
" } + }, + "MajorEngineVersion": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The major engine version of the CEV.
" + } + }, + "DatabaseInstallationFilesS3BucketName": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 bucket that contains your database installation files.
" + } + }, + "DatabaseInstallationFilesS3Prefix": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The Amazon S3 directory that contains the database installation files. \n If not specified, then no prefix is assumed.
" + } + }, + "DBEngineVersionArn": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The ARN of the custom engine version.
" + } + }, + "KMSKeyId": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for \n RDS Custom, but optional for Amazon RDS.
" + } + }, + "CreateTime": { + "target": "com.amazonaws.rds#TStamp", + "traits": { + "smithy.api#documentation": "The creation time of the DB engine version.
" + } + }, + "TagList": { + "target": "com.amazonaws.rds#TagList" } }, "traits": { @@ -5266,7 +5529,7 @@ "MultiAZ": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "Specifies if the DB instance is a Multi-AZ deployment.
" + "smithy.api#documentation": "Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
" } }, "EngineVersion": { @@ -5308,7 +5571,7 @@ "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "License model information for this DB instance.
" + "smithy.api#documentation": "License model information for this DB instance. This setting doesn't apply to RDS Custom.
" } }, "Iops": { @@ -5386,13 +5649,13 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "\n If StorageEncrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB instance.\n
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
" + "smithy.api#documentation": "\n If StorageEncrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB instance.\n
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "DbiResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log \n entries whenever the Amazon Web Services KMS customer master key (CMK) for the DB instance is accessed.
" + "smithy.api#documentation": "The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log \n entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
" } }, "CACertificateIdentifier": { @@ -5464,7 +5727,7 @@ "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "PerformanceInsightsRetentionPeriod": { @@ -5539,7 +5802,7 @@ "ActivityStreamKmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS \n customer master key (CMK).
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. \n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "ActivityStreamKinesisStreamName": { @@ -5559,6 +5822,24 @@ "traits": { "smithy.api#documentation": "Indicates whether engine-native audit fields are included in the database activity stream.
" } + }, + "AutomationMode": { + "target": "com.amazonaws.rds#AutomationMode", + "traits": { + "smithy.api#documentation": "The automation mode of the RDS Custom DB instance: full or all paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n --resume-full-automation-mode-minutes.
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.\n
" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon Relational Database Service\n User Guide.
" + } } }, "traits": { @@ -5708,7 +5989,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key ID for an automated backup.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
" + "smithy.api#documentation": "The Amazon Web Services KMS key ID for an automated backup.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "Timezone": { @@ -5890,7 +6171,7 @@ "FeatureName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For the list of supported feature names, see DBEngineVersion.\n
The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role.\n For information about supported feature names, see DBEngineVersion.\n
\n If Encrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB snapshot.\n
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
" + "smithy.api#documentation": "\n If Encrypted is true, the Amazon Web Services KMS key identifier \n for the encrypted DB snapshot.\n
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "DBSnapshotArn": { @@ -7469,6 +7750,45 @@ } } }, + "com.amazonaws.rds#DeleteCustomDBEngineVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#DeleteCustomDBEngineVersionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBEngineVersion" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:
\nThe CEV must not be the default for RDS Custom. If it is, change the default \n before running this command.
\nThe CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, \n or automated backup of your RDS Custom instance.
\nTypically, deletion takes a few minutes.
\nThe MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the DeleteCustomDbEngineVersion event.
For more information, see \n Deleting a CEV in the Amazon RDS User Guide.
" + } + }, + "com.amazonaws.rds#DeleteCustomDBEngineVersionMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#CustomEngineName", + "traits": { + "smithy.api#documentation": "The database engine. The only supported engine is custom-oracle-ee.
The custom engine version (CEV) for your DB instance. This option is required for \n RDS Custom, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.
The Amazon Resource Name (ARN) of the automated backups to delete, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
The Amazon Resource Name (ARN) of the automated backups to delete, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
" } } }, @@ -7736,13 +8056,13 @@ "SkipFinalSnapshot": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted.\n If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot \n is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.
\nWhen a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.
\nSpecify skip when deleting a read replica.
\nThe FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.
\nA value that indicates whether to skip the creation of a final DB snapshot before deleting the instance.\n If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, \n RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, \n and the DB snapshot is created.
\nIf you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.
When a DB instance is in a failure state and has a status of failed, incompatible-restore, \n or incompatible-network, RDS can delete the instance only if you enable this parameter.
If you delete a read replica or an RDS Custom instance, you must enable this setting.
\nThis setting is required for RDS Custom.
" } }, "FinalDBSnapshotIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "\n The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot\n parameter is disabled.\n
Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.
\nConstraints:
\nMust be 1 to 255 letters or numbers.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nCan't be specified when deleting a read replica.
\n\n The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot\n parameter is disabled.\n
If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.
\nThis setting doesn't apply to RDS Custom.
\nConstraints:
\nMust be 1 to 255 letters or numbers.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nCan't be specified when deleting a read replica.
\nA value that indicates whether to list the supported character sets for each engine version.
\nIf this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, \n the response includes a list of supported character sets for each engine version.\n
A value that indicates whether to list the supported character sets for each engine version.
\nIf this parameter is enabled and the requested engine supports the CharacterSetName parameter for\n CreateDBInstance, the response includes a list of supported character sets for each engine\n version.
For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets\n to true, RDS Custom returns no results.\n
A value that indicates whether to list the supported time zones for each engine version.
\nIf this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.\n
A value that indicates whether to list the supported time zones for each engine version.
\nIf this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, \n the response includes a list of supported time zones for each engine version.\n
For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones\n to true, RDS Custom returns no results.\n
The Amazon Resource Name (ARN) of the replicated automated backups, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
The Amazon Resource Name (ARN) of the replicated automated backups, for example,\n arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
" } } }, @@ -9220,7 +9540,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of DB log files for the DB instance.
", + "smithy.api#documentation": "Returns a list of DB log files for the DB instance.
\nThis command doesn't apply to RDS Custom.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -10054,13 +10374,13 @@ "IncludeShared": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.
\nYou can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
A value that indicates whether to include shared manual DB cluster snapshots \n from other Amazon Web Services accounts that this Amazon Web Services account has been given \n permission to copy or restore. By default, these snapshots are not included.
\nYou can give an Amazon Web Services account permission to restore a manual DB snapshot from\n another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
This setting doesn't apply to RDS Custom.
" } }, "IncludePublic": { "target": "com.amazonaws.rds#Boolean", "traits": { - "smithy.api#documentation": "A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.
\nYou can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
" + "smithy.api#documentation": "A value that indicates whether to include manual DB cluster snapshots that are public and can be copied \n or restored by any Amazon Web Services account. By default, the public snapshots are not included.
\nYou can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
\nThis setting doesn't apply to RDS Custom.
" } }, "DbiResourceId": { @@ -10449,7 +10769,7 @@ "Filters": { "target": "com.amazonaws.rds#FilterList", "traits": { - "smithy.api#documentation": "Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.
\nSupported filters include the following:
\n\n export-task-identifier - An identifier for the snapshot export task.
\n s3-bucket - The Amazon S3 bucket the snapshot is exported to.
\n source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
\n status - The status of the export task. Must be lowercase, for example, complete.
Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to\n include in the output. Filter names and values are case-sensitive.
\nSupported filters include the following:
\n\n export-task-identifier - An identifier for the snapshot export task.
\n s3-bucket - The Amazon S3 bucket the snapshot is exported to.
\n source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
\n status - The status of the export task. Must be lowercase. Valid statuses are the following:
\n canceled\n
\n canceling\n
\n complete\n
\n failed\n
\n starting\n
The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
" + "smithy.api#documentation": "The license model filter value. Specify this parameter to show only the available offerings \n matching the specified license model.
\nRDS Custom supports only the BYOL licensing model.
" } }, "AvailabilityZoneGroup": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
\nOmit this parameter to show the available offerings in the specified Amazon Web Services Region.
" + "smithy.api#documentation": "The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.
\nOmit this parameter to show the available offerings in the specified Amazon Web Services Region.
\nThis setting doesn't apply to RDS Custom.
" } }, "Vpc": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to show only VPC or non-VPC offerings.
" + "smithy.api#documentation": "A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports \n only VPC offerings.
\nRDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output \n shows VPC offerings.
" } }, "Filters": { @@ -11079,7 +11399,7 @@ } ], "traits": { - "smithy.api#documentation": "You can call DescribeValidDBInstanceModifications \n to learn what modifications you can make to your DB instance.\n You can use this information when you call \n ModifyDBInstance.\n
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to \n your DB instance. You can use this information when you call ModifyDBInstance.\n
This command doesn't apply to RDS Custom.
" } }, "com.amazonaws.rds#DescribeValidDBInstanceModificationsMessage": { @@ -11105,6 +11425,16 @@ } } }, + "com.amazonaws.rds#Description": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } + }, "com.amazonaws.rds#DomainMembership": { "type": "structure", "members": { @@ -11221,7 +11551,7 @@ } ], "traits": { - "smithy.api#documentation": "Downloads all or a portion of the specified log file, up to 1 MB in size.
", + "smithy.api#documentation": "Downloads all or a portion of the specified log file, up to 1 MB in size.
\nThis command doesn't apply to RDS Custom.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -11705,7 +12035,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The key identifier of the Amazon Web Services KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to\n Amazon S3. The Amazon Web Services KMS CMK identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export\n must have encryption and decryption permissions to use this Amazon Web Services KMS CMK.
" + "smithy.api#documentation": "The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to\n Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export\n must have encryption and decryption permissions to use this KMS key.
" } }, "Status": { @@ -12011,7 +12341,7 @@ "GlobalClusterResourceId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "\n The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in\n Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS customer master key (CMK) for the DB cluster is accessed.\n
" + "smithy.api#documentation": "\n The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in\n Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.\n
" } }, "GlobalClusterArn": { @@ -12563,6 +12893,23 @@ "smithy.api#box": {} } }, + "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.rds#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidCustomDBEngineVersionStateFault", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "You can't delete the CEV.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.rds#InvalidDBClusterCapacityFault": { "type": "structure", "members": { @@ -12994,6 +13341,16 @@ "target": "com.amazonaws.rds#String" } }, + "com.amazonaws.rds#KmsKeyIdOrArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_:\\-\\/]+$" + } + }, "com.amazonaws.rds#ListTagsForResource": { "type": "operation", "input": { @@ -13193,6 +13550,57 @@ } } }, + "com.amazonaws.rds#ModifyCustomDBEngineVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.rds#ModifyCustomDBEngineVersionMessage" + }, + "output": { + "target": "com.amazonaws.rds#DBEngineVersion" + }, + "errors": [ + { + "target": "com.amazonaws.rds#CustomDBEngineVersionNotFoundFault" + }, + { + "target": "com.amazonaws.rds#InvalidCustomDBEngineVersionStateFault" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling \n DescribeDBEngineVersions.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the ModifyCustomDbEngineVersion event.
For more information, see Modifying CEV status \n in the Amazon RDS User Guide.
" + } + }, + "com.amazonaws.rds#ModifyCustomDBEngineVersionMessage": { + "type": "structure", + "members": { + "Engine": { + "target": "com.amazonaws.rds#CustomEngineName", + "traits": { + "smithy.api#documentation": "The DB engine. The only supported value is custom-oracle-ee.
The custom engine version (CEV) that you want to modify. This option is required for \n RDS Custom, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.
An optional description of your CEV.
" + } + }, + "Status": { + "target": "com.amazonaws.rds#CustomEngineVersionStatus", + "traits": { + "smithy.api#documentation": "The availability status to be assigned to the CEV. Valid values are as follows:
\nYou can use this CEV to create a new RDS Custom DB instance.
\nYou can create a new RDS Custom instance by restoring a DB snapshot with this CEV. \n You can't patch or create new instances with this CEV.
\nYou can change any status to any status. A typical reason to change status is to prevent the accidental \n use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status \n of your CEV from available to inactive, and from inactive back to \n available. To change the availability status of the CEV, it must not currently be in use by an \n RDS Custom instance, snapshot, or automated backup.\n
The new compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
If you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.\n
Default: Uses existing setting
" + "smithy.api#documentation": "The new compute and memory capacity of the DB instance, for example, db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
If you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.\n
This setting doesn't apply to RDS Custom.
\nDefault: Uses existing setting
" } }, "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide. \n
\nChanging the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.\n
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mySubnetGroup\n
The new DB subnet group for the DB instance.\n You can use this parameter to move your DB instance to a different VPC.\n \n If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC.\n For more information, see \n Working with a DB instance in a VPC \n in the Amazon RDS User Guide.\n
\nChanging the subnet group causes an outage during the change. \n The change is applied during the next maintenance window,\n unless you enable ApplyImmediately.
This parameter doesn't apply to RDS Custom.
\nConstraints: If supplied, must match the name of an existing DBSubnetGroup.
\nExample: mySubnetGroup\n
A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.
\nConstraints:
\nIf supplied, must match existing DBSecurityGroups.
\nA list of DB security groups to authorize on this DB instance. Changing this setting doesn't \n result in an outage and the change is asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match existing DBSecurityGroups.
\nA list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.
\n\n Amazon Aurora\n
\nNot applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.
Constraints:
\nIf supplied, must match existing VpcSecurityGroupIds.
\nA list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is \n asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.
Constraints:
\nIf supplied, must match existing VpcSecurityGroupIds.
\nThe new password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".
\n\n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.\n
\n Amazon Aurora\n
\nNot applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.\n
Default: Uses existing setting
\n\n\n MariaDB\n
\nConstraints: Must contain from 8 to 41 characters.
\n \n\n Microsoft SQL Server\n
\nConstraints: Must contain from 8 to 128 characters.
\n \n\n MySQL\n
\nConstraints: Must contain from 8 to 41 characters.
\n \n\n Oracle\n
\nConstraints: Must contain from 8 to 30 characters.
\n \n\n PostgreSQL\n
\nConstraints: Must contain from 8 to 128 characters.
\n\nAmazon RDS API actions never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.\n
\nThe new password for the master user. The password can include any printable ASCII \n character except \"/\", \"\"\", or \"@\".
\n\n Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. \n Between the time of the request and the completion of the request,\n the MasterUserPassword element exists in the\n PendingModifiedValues element of the operation response.\n
This setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The password for the master user is managed by the DB cluster. For\n more information, see ModifyDBCluster.\n
Default: Uses existing setting
\n\n\n MariaDB\n
\nConstraints: Must contain from 8 to 41 characters.
\n \n\n Microsoft SQL Server\n
\nConstraints: Must contain from 8 to 128 characters.
\n \n\n MySQL\n
\nConstraints: Must contain from 8 to 41 characters.
\n \n\n Oracle\n
\nConstraints: Must contain from 8 to 30 characters.
\n \n\n PostgreSQL\n
\nConstraints: Must contain from 8 to 128 characters.
\n\nAmazon RDS API actions never return the password, \n so this action provides a way to regain access to a primary instance user if the password is lost. \n This includes restoring privileges that might have been accidentally revoked.\n
\nThe name of the DB parameter group to apply to the DB instance. Changing this\n setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically and the\n parameter changes isn't applied during the next maintenance window.
\nDefault: Uses existing setting
\nConstraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
" + "smithy.api#documentation": "The name of the DB parameter group to apply to the DB instance.
\nChanging this setting doesn't result in an outage. The parameter group name itself is changed\n immediately, but the actual parameter changes are not applied until you reboot the\n instance without failover. In this case, the DB instance isn't rebooted automatically, and the\n parameter changes aren't applied during the next maintenance window. However, if you modify \n dynamic parameters in the newly associated DB parameter group, these changes are applied \n immediately without a reboot.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Uses existing setting
\nConstraints: The DB parameter group must be in the same DB parameter group family as the DB instance.
" } }, "BackupRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\nEnabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
\nThese changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.
\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
\nConstraints:
\nMust be a value from 0 to 35
\nCan be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later
\nCan be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5
\nCan't be set to 0 if the DB instance is a source to read replicas
\nThe number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\nEnabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
\nThese changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.
\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
\nConstraints:
\nIt must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to \n read replicas. It can't be set to 0 or 35 for an RDS Custom DB instance.
\nIt can be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later.
\nIt can be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5.
\nA value that indicates whether the DB instance is a Multi-AZ deployment. \n Changing this parameter doesn't result in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is \n enabled for this request.\n
A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result \n in an outage. The change is applied during the next maintenance window unless the ApplyImmediately \n parameter is enabled for this request.\n
This setting doesn't apply to RDS Custom.
" } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "\n The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n
For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.
\nIf you specify only a major version, Amazon RDS will update the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.
\n The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n
For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.
\nIf you specify only a major version, Amazon RDS will update the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.
In RDS Custom, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.\n
A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.
\nConstraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
" + "smithy.api#documentation": "A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't \n result in an outage and the change is asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom.
\nConstraints: Major version upgrades must be allowed when specifying a value \n for the EngineVersion parameter that is a different major version than the DB instance's current version.
" } }, "AutoMinorVersionUpgrade": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "\n A value that indicates whether minor version upgrades are applied automatically\n to the DB instance during the maintenance window. \n Changing this parameter doesn't result in an outage except in the following case \n and the change is asynchronously applied as soon as possible.\n An outage results if this parameter is enabled during the maintenance window, \n and a newer minor version is available, and RDS has enabled auto patching for that engine version.\n
" + "smithy.api#documentation": "A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window. An outage occurs when all the following conditions are met:
\nThe automatic upgrade is enabled for the maintenance window.
\nA newer minor version is available.
\nRDS has enabled automatic patching for the engine version.
\nIf any of the preceding conditions isn't met, RDS applies the change as soon as possible and\n doesn't cause an outage.
\nFor an RDS Custom DB instance, set AutoMinorVersionUpgrade \n to false. Otherwise, the operation returns an error.
The license model for the DB instance.
\nValid values: license-included | bring-your-own-license | \n general-public-license\n
The license model for the DB instance.
\nThis setting doesn't apply to RDS Custom.
\nValid values: license-included | bring-your-own-license | \n general-public-license\n
\n A value that indicates the DB instance should be associated with the specified option group. \n Changing this parameter doesn't result in an outage except in the following case and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled \n for this request. If the parameter change results in an option group that \n enables OEM, this change can cause a brief (sub-second) period during which new connections \n are rejected but existing connections are not interrupted.\n
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
" + "smithy.api#documentation": "A value that indicates the DB instance should be associated with the specified option group.
\nChanging this parameter doesn't result in an outage, with one exception. If the parameter change results \n in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which \n new connections are rejected but existing connections aren't interrupted.
\nThe change is applied during the next maintenance window unless the ApplyImmediately parameter \n is enabled for this request.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed \n from an option group, and that option group can't be removed from a DB instance after \n it is associated with a DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "NewDBInstanceIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "\n The new DB instance identifier for the DB instance when renaming a DB\n instance. When you change the DB instance identifier, an instance \n reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable Apply Immediately. This value is stored \n as a lowercase string. \n
Constraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance \n identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur \n during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string. \n
This setting doesn't apply to RDS Custom.
\nConstraints:
\nMust contain from 1 to 63 letters, numbers, or hyphens.
\nThe first character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nExample: mydbinstance\n
The ARN from the key store with which to associate the instance for TDE encryption.
" + "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to RDS Custom.
" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
" + "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom.
" } }, "CACertificateIdentifier": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Indicates the certificate that needs to be associated with the instance.
" + "smithy.api#documentation": "Specifies the certificate to associate with the DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The Active Directory directory ID to move the DB instance to. \n Specify none to remove the instance from its current domain.\n You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
For more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "CopyTagsToSnapshot": { @@ -13804,79 +14212,79 @@ "MonitoringInterval": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
\nIf MonitoringRoleArn is specified, then you must also set MonitoringInterval\n to a value other than 0.
Valid Values: 0, 1, 5, 10, 15, 30, 60\n
The interval, in seconds, between points when Enhanced Monitoring metrics are collected \n for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default.
\nIf MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0.
This setting doesn't apply to RDS Custom.
\nValid Values: 0, 1, 5, 10, 15, 30, 60\n
The port number on which the database accepts connections.
\nThe value of the DBPortNumber parameter must not match any of the port values specified for options in the option\n group for the DB instance.
Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately\n parameter.
\n MySQL\n
\n\n Default: 3306\n
Valid values: 1150-65535\n
\n MariaDB\n
\n\n Default: 3306\n
Valid values: 1150-65535\n
\n PostgreSQL\n
\n\n Default: 5432\n
Valid values: 1150-65535\n
Type: Integer
\n\n Oracle\n
\n\n Default: 1521\n
Valid values: 1150-65535\n
\n SQL Server\n
\n\n Default: 1433\n
Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.
\n Amazon Aurora\n
\n\n Default: 3306\n
Valid values: 1150-65535\n
The port number on which the database accepts connections.
\nThe value of the DBPortNumber parameter must not match any of the port values \n specified for options in the option group for the DB instance.
If you change the DBPortNumber value, your database restarts regardless of \n the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom.
\n\n MySQL\n
\n\n Default: 3306\n
Valid values: 1150-65535\n
\n MariaDB\n
\n\n Default: 3306\n
Valid values: 1150-65535\n
\n PostgreSQL\n
\n\n Default: 5432\n
Valid values: 1150-65535\n
Type: Integer
\n\n Oracle\n
\n\n Default: 1521\n
Valid values: 1150-65535\n
\n SQL Server\n
\n\n Default: 1433\n
Valid values: 1150-65535 except 1234, 1434,\n 3260, 3343, 3389, 47001, and\n 49152-49156.
\n Amazon Aurora\n
\n\n Default: 3306\n
Valid values: 1150-65535\n
A value that indicates whether the DB instance is publicly accessible.\n
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\n\n PubliclyAccessible only applies to DB instances in a VPC. \n The DB instance must be part of a public subnet and \n PubliclyAccessible must be enabled for it to be publicly accessible.\n
Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.
A value that indicates whether the DB instance is publicly accessible.\n
\nWhen the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, \n and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, \n and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\n\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.\n
Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom.
" } }, "MonitoringRoleArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n go to To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n
If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For\n example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,\n see To \n create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.\n
If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn \n value.
This setting doesn't apply to RDS Custom.
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the IAM role to use when making API calls to the Directory Service.
" + "smithy.api#documentation": "The name of the IAM role to use when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" } }, "PromotionTier": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.\n
\nDefault: 1
\nValid Values: 0 - 15
" + "smithy.api#documentation": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance \n after a failure of the existing primary instance. For more information, \n see \n Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
\nThis setting doesn't apply to RDS Custom.\n
\nDefault: 1
\nValid Values: 0 - 15
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nThis setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\nThis setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB\n cluster.
\nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" } }, "EnablePerformanceInsights": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon Relational Database Service\n User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable Performance Insights for the DB instance.
\nFor more information, see \n Using Amazon Performance Insights in the Amazon Relational Database Service\n User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" } }, "PerformanceInsightsKMSKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your Amazon Web Services account. \n Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
This setting doesn't apply to RDS Custom.
" } }, "PerformanceInsightsRetentionPeriod": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
" + "smithy.api#documentation": "The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
\nThis setting doesn't apply to RDS Custom.
" } }, "CloudwatchLogsExportConfiguration": { "target": "com.amazonaws.rds#CloudwatchLogsExportConfiguration", "traits": { - "smithy.api#documentation": "The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.
\nA change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.
The configuration setting for the log types to be enabled for export to CloudWatch Logs for a \n specific DB instance.
\nA change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance \n immediately. Therefore, the ApplyImmediately parameter has no effect.
This setting doesn't apply to RDS Custom.
" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
" + "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
" + "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
\nThis setting doesn't apply to RDS Custom.
" } }, "DeletionProtection": { @@ -13888,19 +14296,19 @@ "MaxAllocatedStorage": { "target": "com.amazonaws.rds#IntegerOptional", "traits": { - "smithy.api#documentation": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "CertificateRotationRestart": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.
\nBy default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.
\nSet this parameter only if you are not using SSL/TLS to connect to the DB instance.
\nIf you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:
\nFor more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.\n
\nFor more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.\n
\nA value that indicates whether the DB instance is restarted when you rotate your \n SSL/TLS certificate.
\nBy default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate \n is not updated until the DB instance is restarted.
\nSet this parameter only if you are not using SSL/TLS to connect to the DB instance.
\nIf you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your \n DB engine to rotate your SSL/TLS certificate:
\nFor more information about rotating your SSL/TLS certificate for RDS DB engines, see \n \n Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide.\n
\nFor more information about rotating your SSL/TLS certificate for Aurora DB engines, see \n \n Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" } }, "ReplicaMode": { "target": "com.amazonaws.rds#ReplicaMode", "traits": { - "smithy.api#documentation": "A value that sets the open mode of a replica database to either mounted or read-only.
\nCurrently, this parameter is only supported for Oracle DB instances.
\nMounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
" + "smithy.api#documentation": "A value that sets the open mode of a replica database to either mounted or read-only.
\nCurrently, this parameter is only supported for Oracle DB instances.
\nMounted DB replicas are included in Oracle Enterprise Edition. The main use case for \n mounted replicas is cross-Region disaster recovery. The primary database doesn't use \n Active Data Guard to transmit information to the mounted replica. Because it doesn't \n accept user connections, a mounted replica can't serve a read-only workload. \n For more information, see Working with Oracle Read Replicas for Amazon RDS \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableCustomerOwnedIp": { @@ -13912,7 +14320,19 @@ "AwsBackupRecoveryPointArn": { "target": "com.amazonaws.rds#AwsBackupRecoveryPointArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
\nThis setting doesn't apply to RDS Custom.
" + } + }, + "AutomationMode": { + "target": "com.amazonaws.rds#AutomationMode", + "traits": { + "smithy.api#documentation": "The automation mode of the RDS Custom DB instance: full or all paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all paused, the instance pauses automation for the duration set by \n ResumeFullAutomationModeMinutes.
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes \n full automation. The minimum value is 60 (default). The maximum value is 1,440. \n
Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n
\n \nAmazon RDS supports upgrading DB snapshots for MySQL, Oracle, and PostgreSQL.\n
" + "smithy.api#documentation": "Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted\n or unencrypted, but not shared or public.\n \n
\n \nAmazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command\n doesn't apply to RDS Custom.\n
" } }, "com.amazonaws.rds#ModifyDBSnapshotAttribute": { @@ -15692,6 +16112,18 @@ "traits": { "smithy.api#documentation": "Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
" } + }, + "AutomationMode": { + "target": "com.amazonaws.rds#AutomationMode", + "traits": { + "smithy.api#documentation": "The automation mode of the RDS Custom DB instance: full or all-paused. \n If full, the DB instance automates monitoring and instance recovery. If \n all-paused, the instance pauses automation for the duration set by \n --resume-full-automation-mode-minutes.
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. \n The minimum value is 60 (default). The maximum value is 1,440.\n
" + } } }, "traits": { @@ -15761,7 +16193,7 @@ } ], "traits": { - "smithy.api#documentation": "Promotes a read replica DB instance to a standalone DB instance.
\nBackup duration is a function of the amount of changes to the database since the previous\n backup. If you plan to promote a read replica to a standalone instance, we\n recommend that you enable backups and complete at least one backup prior to\n promotion. In addition, a read replica cannot be promoted to a standalone\n instance when it is in the backing-up status. If you have\n enabled backups on your read replica, configure the automated backup window\n so that daily backups do not interfere with read replica\n promotion.
This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.
\nPromotes a read replica DB instance to a standalone DB instance.
\nBackup duration is a function of the amount of changes to the database since the previous\n backup. If you plan to promote a read replica to a standalone instance, we\n recommend that you enable backups and complete at least one backup prior to\n promotion. In addition, a read replica cannot be promoted to a standalone\n instance when it is in the backing-up status. If you have\n enabled backups on your read replica, configure the automated backup window\n so that daily backups do not interfere with read replica\n promotion.
This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
\nYou might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.\n
\n\nRebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.\n
\n \nFor more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "You might need to reboot your DB instance, usually for maintenance reasons. \n For example, if you make certain modifications, \n or if you change the DB parameter group associated with the DB instance, \n you must reboot the instance for the changes to take effect.\n
\n\nRebooting a DB instance restarts the database engine service. \n Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.\n
\n \nFor more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.\n
\n \nThis command doesn't apply to RDS Custom.
" } }, "com.amazonaws.rds#RebootDBInstanceMessage": { @@ -16236,7 +16668,7 @@ "FeatureName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the feature for the DB cluster that the IAM role is to be disassociated from.\n For the list of supported feature names, see DBEngineVersion.
" + "smithy.api#documentation": "The name of the feature for the DB cluster that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.
" } } } @@ -16281,7 +16713,7 @@ "FeatureName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the feature for the DB instance that the IAM role is to be disassociated from.\n For the list of supported feature names, see DBEngineVersion.\n
The name of the feature for the DB instance that the IAM role is to be disassociated from.\n For information about supported feature names, see DBEngineVersion.\n
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).\n To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nIf the StorageEncrypted parameter is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use your default CMK. There is a \n default CMK for your Amazon Web Services account. Your Amazon Web Services account has a different\n default CMK for each Amazon Web Services Region.
The Amazon Web Services KMS key identifier for an encrypted DB cluster.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nIf the StorageEncrypted parameter is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS will use your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).\n To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nWhen you don't specify a value for the KmsKeyId parameter, then the\n following occurs:
If the DB snapshot or DB cluster snapshot in\n SnapshotIdentifier is encrypted, then the restored DB cluster\n is encrypted using the Amazon Web Services KMS CMK that was used to encrypt the DB snapshot or DB\n cluster snapshot.
If the DB snapshot or DB cluster snapshot in \n SnapshotIdentifier isn't encrypted, then the restored DB cluster\n isn't encrypted.
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB\n snapshot or DB cluster snapshot.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nWhen you don't specify a value for the KmsKeyId parameter, then the\n following occurs:
If the DB snapshot or DB cluster snapshot in\n SnapshotIdentifier is encrypted, then the restored DB cluster\n is encrypted using the KMS key that was used to encrypt the DB snapshot or DB\n cluster snapshot.
If the DB snapshot or DB cluster snapshot in \n SnapshotIdentifier isn't encrypted, then the restored DB cluster\n isn't encrypted.
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).\n To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nYou can restore to a new DB cluster and encrypt the new DB cluster with a Amazon Web Services KMS CMK that is different than the\n Amazon Web Services KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the Amazon Web Services KMS CMK\n identified by the KmsKeyId parameter.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the Amazon Web Services KMS CMK that was used to encrypt the source DB cluster.
\nIf the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
\nIf DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.
The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nYou can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the\n KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key\n identified by the KmsKeyId parameter.
If you don't specify a value for the KmsKeyId parameter, then the following occurs:
If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.
\nIf the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.
\nIf DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request\n is rejected.
A value that indicates whether the DB instance is a Multi-AZ deployment.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
A value that indicates whether the DB instance is a Multi-AZ deployment.
\nThis setting doesn't apply to RDS Custom.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
" + "smithy.api#documentation": "A value that indicates whether minor version upgrades are applied automatically to the DB instance \n during the maintenance window.
\nIf you restore an RDS Custom DB instance, you must disable this parameter.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "License model information for the restored DB instance.
\nDefault: Same as source.
\n\n Valid values: license-included | bring-your-own-license | general-public-license\n
License model information for the restored DB instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Same as source.
\n\n Valid values: license-included | bring-your-own-license | general-public-license\n
The database name for the restored DB instance.
\nThis parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.
\nThe database name for the restored DB instance.
\nThis parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS\n Custom DB instances.
" } }, "Engine": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The database engine to use for the new instance.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
\n\nValid Values:
\n \n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine to use for the new instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.
\n\nValid Values:
\n \n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the option group to be used for the restored DB instance.
\n \nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
" + "smithy.api#documentation": "The name of the option group to be used for the restored DB instance.
\n \nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option \n group, and that option group can't be removed from a DB instance after it is associated with a DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "Tags": { @@ -17689,13 +18121,13 @@ "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
" + "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to RDS Custom.
" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
" + "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom.
" } }, "VpcSecurityGroupIds": { @@ -17707,7 +18139,7 @@ "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB instance in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB instance in.\n The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "CopyTagsToSnapshot": { @@ -17719,37 +18151,37 @@ "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
" + "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
" + "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default\n processor features.
\nThis setting doesn't apply to RDS Custom.
" } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.
Constraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup \n for the specified DB engine.
This setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nA value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon Relational Database Service\n User Guide.
\nThis setting is required for RDS Custom.
" } } }, @@ -17839,7 +18277,7 @@ } ], "traits": { - "smithy.api#documentation": "Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide. \n
" + "smithy.api#documentation": "Amazon Relational Database Service (Amazon RDS) \n supports importing MySQL databases by using backup files. \n You can create a backup of your on-premises database, \n store it on Amazon Simple Storage Service (Amazon S3), \n and then restore the backup file onto a new Amazon RDS DB instance running MySQL.\n For more information, see Importing Data into an Amazon RDS MySQL DB Instance \n in the Amazon RDS User Guide. \n
\nThis command doesn't apply to RDS Custom.
" } }, "com.amazonaws.rds#RestoreDBInstanceFromS3Message": { @@ -18007,7 +18445,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted DB instance.\n
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).\n To use a CMK in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nIf the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default CMK. \n There is a default CMK for your Amazon Web Services account. \n Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.\n
The Amazon Web Services KMS key identifier for an encrypted DB instance.\n
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\nIf the StorageEncrypted parameter is enabled, \n and you do not specify a value for the KmsKeyId parameter, \n then Amazon RDS will use your default KMS key. \n There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.\n
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default CMK. There is a default CMK for your Amazon Web Services account. \n Your Amazon Web Services account has a different default CMK for each Amazon Web Services Region.
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
\nIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS \n uses your default KMS key. There is a default KMS key for your Amazon Web Services account. \n Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
A value that indicates whether the DB instance is a Multi-AZ deployment.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
A value that indicates whether the DB instance is a Multi-AZ deployment.
\nThis setting doesn't apply to RDS Custom.
\nConstraint: You can't specify the AvailabilityZone parameter if the DB instance is a \n Multi-AZ deployment.
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
" + "smithy.api#documentation": "A value that indicates whether minor version upgrades are applied automatically to the \n DB instance during the maintenance window.
\nThis setting doesn't apply to RDS Custom.
" } }, "LicenseModel": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "License model information for the restored DB instance.
\nDefault: Same as source.
\n\n Valid values: license-included | bring-your-own-license | general-public-license\n
License model information for the restored DB instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: Same as source.
\n\n Valid values: license-included | bring-your-own-license | general-public-license\n
The database name for the restored DB instance.
\nThis parameter isn't used for the MySQL or MariaDB engines.
\nThe database name for the restored DB instance.
\nThis parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
\nThe database engine to use for the new instance.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source
\n\nValid Values:
\n \n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine to use for the new instance.
\nThis setting doesn't apply to RDS Custom.
\nDefault: The same as source
\nConstraint: Must be compatible with the engine of the source
\n\nValid Values:
\n \n\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the option group to be used for the restored DB instance.
\n \nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
" + "smithy.api#documentation": "The name of the option group to be used for the restored DB instance.
\n \nPermanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an \n option group, and that option group can't be removed from a DB instance after it is associated with a DB instance
\nThis setting doesn't apply to RDS Custom.
" } }, "CopyTagsToSnapshot": { @@ -18324,13 +18762,13 @@ "TdeCredentialArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
" + "smithy.api#documentation": "The ARN from the key store with which to associate the instance for TDE encryption.
\nThis setting doesn't apply to RDS Custom.
" } }, "TdeCredentialPassword": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
" + "smithy.api#documentation": "The password for the given ARN from the key store in order to access the device.
\nThis setting doesn't apply to RDS Custom.
" } }, "VpcSecurityGroupIds": { @@ -18342,43 +18780,43 @@ "Domain": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB instance in.\n The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Specify the Active Directory directory ID to restore the DB instance in.\n Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL \n Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.
\nThis setting doesn't apply to RDS Custom.
\nFor more information, see \n Kerberos Authentication in the Amazon RDS User Guide.
" } }, "DomainIAMRoleName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
" + "smithy.api#documentation": "Specify the name of the IAM role to be used when making API calls to the Directory Service.
\nThis setting doesn't apply to RDS Custom.
" } }, "EnableIAMDatabaseAuthentication": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "A value that indicates whether to enable mapping of Amazon Web Services Identity and Access\n Management (IAM) accounts to database accounts. By default, mapping is disabled.
\n \nThis setting doesn't apply to RDS Custom.
\n \nFor more information about IAM database authentication, see \n \n IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.\n
" } }, "EnableCloudwatchLogsExports": { "target": "com.amazonaws.rds#LogTypeList", "traits": { - "smithy.api#documentation": "The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The list of logs that the restored DB instance is to export to CloudWatch Logs. The values\n in the list depend on the DB engine being used. For more information, see \n Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "ProcessorFeatures": { "target": "com.amazonaws.rds#ProcessorFeatureList", "traits": { - "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
" + "smithy.api#documentation": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
\nThis setting doesn't apply to RDS Custom.
" } }, "UseDefaultProcessorFeatures": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default processor features.
" + "smithy.api#documentation": "A value that indicates whether the DB instance class of the DB instance uses its default processor features.
\nThis setting doesn't apply to RDS Custom.
" } }, "DBParameterGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.
Constraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nThe name of the DB parameter group to associate with this DB instance.
\nIf you do not specify a value for DBParameterGroupName, then the default DBParameterGroup \n for the specified DB engine is used.
This setting doesn't apply to RDS Custom.
\nConstraints:
\nIf supplied, must match the name of an existing DBParameterGroup.
\nMust be 1 to 255 letters, numbers, or hyphens.
\nFirst character must be a letter.
\nCan't end with a hyphen or contain two consecutive hyphens.
\nThe upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
" + "smithy.api#documentation": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
\nFor more information about this setting, including limitations that apply to it, see \n \n Managing capacity automatically with Amazon RDS storage autoscaling \n in the Amazon RDS User Guide.
\nThis setting doesn't apply to RDS Custom.
" } }, "SourceDBInstanceAutomatedBackupsArn": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, \n arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
This setting doesn't apply to RDS Custom.
" } }, "EnableCustomerOwnedIp": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + "smithy.api#documentation": "A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
\nA CoIP provides local or external connectivity to resources in\n your Outpost subnets through your on-premises network. For some use cases, a CoIP can\n provide lower latency for connections to the DB instance from outside of its virtual\n private cloud (VPC) on your local network.
\nThis setting doesn't apply to RDS Custom.
\nFor more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts \n in the Amazon RDS User Guide.
\nFor more information about CoIPs, see Customer-owned IP addresses \n in the Amazon Web Services Outposts User Guide.
" + } + }, + "CustomIamInstanceProfile": { + "target": "com.amazonaws.rds#String", + "traits": { + "smithy.api#documentation": "The instance profile associated with the underlying Amazon EC2 instance of an \n RDS Custom DB instance. The instance profile must meet the following requirements:
\nThe profile must exist in your account.
\nThe profile must have an IAM role that Amazon EC2 has permissions to assume.
\nThe instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see \n \n Configure IAM and your VPC in the Amazon Relational Database Service\n User Guide.
\nThis setting is required for RDS Custom.
" } } }, @@ -18801,6 +19245,10 @@ { "value": "db-cluster-snapshot", "name": "db_cluster_snapshot" + }, + { + "value": "custom-engine-version", + "name": "custom_engine_version" } ] } @@ -18857,7 +19305,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream.\n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
", + "smithy.api#documentation": "The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream.\n The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
", "smithy.api#required": {} } }, @@ -19003,7 +19451,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.\n
\n \nFor more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n
\n \n\n This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.\n
\n Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.\n
\n \nFor more information, see \n \n Starting an Amazon RDS DB instance That Was Previously Stopped in the \n Amazon RDS User Guide.\n
\n \n\n This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora DB clusters, use StartDBCluster instead.\n
Enables replication of automated backups to a different Amazon Web Services Region.
\nFor more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Enables replication of automated backups to a different Amazon Web Services Region.
\nThis command doesn't apply to RDS Custom.
\nFor more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#StartDBInstanceAutomatedBackupsReplicationMessage": { @@ -19131,7 +19579,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts an export of a snapshot to Amazon S3. \n The provided IAM role must have access to the S3 bucket. \n
" + "smithy.api#documentation": "Starts an export of a snapshot to Amazon S3. \n The provided IAM role must have access to the S3 bucket. \n
\nThis command doesn't apply to RDS Custom.
" } }, "com.amazonaws.rds#StartExportTaskMessage": { @@ -19168,7 +19616,7 @@ "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services KMS customer master key (CMK) to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK). \n The caller of this operation must be authorized to \n execute the following operations. These can be set in the Amazon Web Services KMS key policy:
\nGrantOperation.Encrypt
\nGrantOperation.Decrypt
\nGrantOperation.GenerateDataKey
\nGrantOperation.GenerateDataKeyWithoutPlaintext
\nGrantOperation.ReEncryptFrom
\nGrantOperation.ReEncryptTo
\nGrantOperation.CreateGrant
\nGrantOperation.DescribeKey
\nGrantOperation.RetireGrant
\nThe ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS \n key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. \n The caller of this operation must be authorized to execute the following operations. \n These can be set in the Amazon Web Services KMS key policy:
\nGrantOperation.Encrypt
\nGrantOperation.Decrypt
\nGrantOperation.GenerateDataKey
\nGrantOperation.GenerateDataKeyWithoutPlaintext
\nGrantOperation.ReEncryptFrom
\nGrantOperation.ReEncryptTo
\nGrantOperation.CreateGrant
\nGrantOperation.DescribeKey
\nGrantOperation.RetireGrant
\nThe Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).
" + "smithy.api#documentation": "The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
" } }, "KinesisStreamName": { @@ -19325,7 +19773,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, \n DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if \n necessary.\n
\n \nFor more information, see \n \n Stopping an Amazon RDS DB Instance Temporarily in the \n Amazon RDS User Guide.\n
\n \n\n This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.\n For Aurora clusters, use StopDBCluster instead.\n
\n Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, \n DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if \n necessary.\n
\n \nFor more information, see \n \n Stopping an Amazon RDS DB Instance Temporarily in the \n Amazon RDS User Guide.\n
\n \n\n This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL.\n For Aurora clusters, use StopDBCluster instead.\n
Stops automated backup replication for a DB instance.
\nFor more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n
" + "smithy.api#documentation": "Stops automated backup replication for a DB instance.
\nThis command doesn't apply to RDS Custom.
\nFor more information, see \n Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.\n
" } }, "com.amazonaws.rds#StopDBInstanceAutomatedBackupsReplicationMessage": { @@ -19431,6 +19879,16 @@ "com.amazonaws.rds#String": { "type": "string" }, + "com.amazonaws.rds#String255": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": ".*" + } + }, "com.amazonaws.rds#StringList": { "type": "list", "member": { diff --git a/codegen/sdk/aws-models/robomaker.2018-06-29.json b/codegen/sdk/aws-models/robomaker.2018-06-29.json index 06d0fc64705..a97b5db7a9d 100644 --- a/codegen/sdk/aws-models/robomaker.2018-06-29.json +++ b/codegen/sdk/aws-models/robomaker.2018-06-29.json @@ -471,13 +471,31 @@ "smithy.api#pattern": "^[a-zA-Z0-9_.\\-]*$" } }, + "com.amazonaws.robomaker#CommandList": { + "type": "list", + "member": { + "target": "com.amazonaws.robomaker#NonEmptyString" + } + }, "com.amazonaws.robomaker#Compute": { "type": "structure", "members": { "simulationUnitLimit": { "target": "com.amazonaws.robomaker#SimulationUnit", "traits": { - "smithy.api#documentation": "The simulation unit limit. Your simulation is allocated CPU and memory proportional to\n the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are\n only billed for the SU utilization you consume up to the maximim value provided. The\n default is 15.
" + "smithy.api#documentation": "The simulation unit limit. Your simulation is allocated CPU and memory proportional to\n the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are\n only billed for the SU utilization you consume up to the maximum value provided. The\n default is 15.
" + } + }, + "computeType": { + "target": "com.amazonaws.robomaker#ComputeType", + "traits": { + "smithy.api#documentation": "Compute type information for the simulation job.
" + } + }, + "gpuUnitLimit": { + "target": "com.amazonaws.robomaker#GPUUnit", + "traits": { + "smithy.api#documentation": "Compute GPU unit limit for the simulation job. It is the same as the number of GPUs\n allocated to the SimulationJob.
" } } }, @@ -491,7 +509,19 @@ "simulationUnitLimit": { "target": "com.amazonaws.robomaker#SimulationUnit", "traits": { - "smithy.api#documentation": "The simulation unit limit. Your simulation is allocated CPU and memory proportional to\n the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are\n only billed for the SU utilization you consume up to the maximim value provided. The\n default is 15.
" + "smithy.api#documentation": "The simulation unit limit. Your simulation is allocated CPU and memory proportional to\n the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are\n only billed for the SU utilization you consume up to the maximum value provided. The\n default is 15.
" + } + }, + "computeType": { + "target": "com.amazonaws.robomaker#ComputeType", + "traits": { + "smithy.api#documentation": "Compute type response information for the simulation job.
" + } + }, + "gpuUnitLimit": { + "target": "com.amazonaws.robomaker#GPUUnit", + "traits": { + "smithy.api#documentation": "Compute GPU unit limit for the simulation job. It is the same as the number of GPUs\n allocated to the SimulationJob.
" } } }, @@ -499,6 +529,21 @@ "smithy.api#documentation": "Compute information for the simulation job
" } }, + "com.amazonaws.robomaker#ComputeType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CPU", + "name": "CPU" + }, + { + "value": "GPU_AND_CPU", + "name": "GPU_AND_CPU" + } + ] + } + }, "com.amazonaws.robomaker#ConcurrentDeploymentException": { "type": "structure", "members": { @@ -831,7 +876,7 @@ "environment": { "target": "com.amazonaws.robomaker#Environment", "traits": { - "smithy.api#documentation": "The object that contains that URI of the Docker image that you use for your robot application.
" + "smithy.api#documentation": "The object that contains that URI of the Docker image that you use for your robot\n application.
" } } } @@ -890,7 +935,7 @@ "environment": { "target": "com.amazonaws.robomaker#Environment", "traits": { - "smithy.api#documentation": "An object that contains the Docker image URI used to a create your robot application.
" + "smithy.api#documentation": "An object that contains the Docker image URI used to a create your robot\n application.
" } } } @@ -948,7 +993,7 @@ "s3Etags": { "target": "com.amazonaws.robomaker#S3Etags", "traits": { - "smithy.api#documentation": "The Amazon S3 identifier for the zip file bundle that you use for your robot application.
" + "smithy.api#documentation": "The Amazon S3 identifier for the zip file bundle that you use for your robot\n application.
" } }, "imageDigest": { @@ -1007,7 +1052,7 @@ "environment": { "target": "com.amazonaws.robomaker#Environment", "traits": { - "smithy.api#documentation": "The object that contains the Docker image URI used to create your robot application.
" + "smithy.api#documentation": "The object that contains the Docker image URI used to create your robot\n application.
" } } } @@ -1167,7 +1212,7 @@ "environment": { "target": "com.amazonaws.robomaker#Environment", "traits": { - "smithy.api#documentation": "The object that contains the Docker image URI used to create your simulation application.
" + "smithy.api#documentation": "The object that contains the Docker image URI used to create your simulation\n application.
" } } } @@ -1238,7 +1283,7 @@ "environment": { "target": "com.amazonaws.robomaker#Environment", "traits": { - "smithy.api#documentation": "The object that contains the Docker image URI that you used to create your simulation application.
" + "smithy.api#documentation": "The object that contains the Docker image URI that you used to create your simulation\n application.
" } } } @@ -1296,13 +1341,13 @@ "s3Etags": { "target": "com.amazonaws.robomaker#S3Etags", "traits": { - "smithy.api#documentation": "The Amazon S3 eTag identifier for the zip file bundle that you use to create the simulation application.
" + "smithy.api#documentation": "The Amazon S3 eTag identifier for the zip file bundle that you use to create the\n simulation application.
" } }, "imageDigest": { "target": "com.amazonaws.robomaker#ImageDigest", "traits": { - "smithy.api#documentation": "The SHA256 digest used to identify the Docker image URI used to created the simulation application.
" + "smithy.api#documentation": "The SHA256 digest used to identify the Docker image URI used to created the simulation\n application.
" } } } @@ -1367,7 +1412,7 @@ "environment": { "target": "com.amazonaws.robomaker#Environment", "traits": { - "smithy.api#documentation": "The object that contains the Docker image URI used to create the simulation application.
" + "smithy.api#documentation": "The object that contains the Docker image URI used to create the simulation\n application.
" } } } @@ -1451,7 +1496,7 @@ "failureBehavior": { "target": "com.amazonaws.robomaker#FailureBehavior", "traits": { - "smithy.api#documentation": "The failure behavior the simulation job.
\nLeaves the instance running for its maximum timeout duration after a 4XX error code.
Stop the simulation job and terminate the instance.
\nThe failure behavior the simulation job.
\nLeaves the instance running for its maximum timeout duration after a\n 4XX error code.
Stop the simulation job and terminate the instance.
\nThe list of S3 keys identifying the data source files.
" } + }, + "type": { + "target": "com.amazonaws.robomaker#DataSourceType", + "traits": { + "smithy.api#documentation": "The data type for the data source that you're using for your container image or\n simulation job. You can use this field to specify whether your data source is an Archive,\n an Amazon S3 prefix, or a file.
\nIf you don't specify a field, the default value is File.
The location where your files are mounted in the container image.
\nIf you've specified the type of the data source as an Archive,\n you must provide an Amazon S3 object key to your archive. The object key must point to\n either a .zip or .tar.gz file.
If you've specified the type of the data source as a Prefix,\n you provide the Amazon S3 prefix that points to the files that you are using for your data\n source.
If you've specified the type of the data source as a File, you\n provide the Amazon S3 path to the file that you're using as your data source.
The list of S3 keys identifying the data source files.
", "smithy.api#required": {} } + }, + "type": { + "target": "com.amazonaws.robomaker#DataSourceType", + "traits": { + "smithy.api#documentation": "The data type for the data source that you're using for your container image or\n simulation job. You can use this field to specify whether your data source is an Archive,\n an Amazon S3 prefix, or a file.
\nIf you don't specify a field, the default value is File.
The location where your files are mounted in the container image.
\nIf you've specified the type of the data source as an Archive,\n you must provide an Amazon S3 object key to your archive. The object key must point to\n either a .zip or .tar.gz file.
If you've specified the type of the data source as a Prefix,\n you provide the Amazon S3 prefix that points to the files that you are using for your data\n source.
If you've specified the type of the data source as a File, you\n provide the Amazon S3 path to the file that you're using as your data source.
The object that contains the Docker image URI used to create the robot application.
" + "smithy.api#documentation": "The object that contains the Docker image URI used to create the robot\n application.
" } }, "imageDigest": { @@ -3242,13 +3330,13 @@ "environment": { "target": "com.amazonaws.robomaker#Environment", "traits": { - "smithy.api#documentation": "The object that contains the Docker image URI used to create the simulation application.
" + "smithy.api#documentation": "The object that contains the Docker image URI used to create the simulation\n application.
" } }, "imageDigest": { "target": "com.amazonaws.robomaker#ImageDigest", "traits": { - "smithy.api#documentation": "A SHA256 identifier for the Docker image that you use for your simulation application.
" + "smithy.api#documentation": "A SHA256 identifier for the Docker image that you use for your simulation\n application.
" } } } @@ -3948,7 +4036,7 @@ } }, "traits": { - "smithy.api#documentation": "The object that contains the Docker image URI for either your robot or simulation applications.
" + "smithy.api#documentation": "The object that contains the Docker image URI for either your robot or simulation\n applications.
" } }, "com.amazonaws.robomaker#EnvironmentVariableKey": { @@ -4209,6 +4297,16 @@ "smithy.api#box": {} } }, + "com.amazonaws.robomaker#GPUUnit": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 1 + } + } + }, "com.amazonaws.robomaker#GenericInteger": { "type": "integer", "traits": { @@ -4387,15 +4485,13 @@ "packageName": { "target": "com.amazonaws.robomaker#Command", "traits": { - "smithy.api#documentation": "The package name.
", - "smithy.api#required": {} + "smithy.api#documentation": "The package name.
" } }, "launchFile": { "target": "com.amazonaws.robomaker#Command", "traits": { - "smithy.api#documentation": "The launch file name.
", - "smithy.api#required": {} + "smithy.api#documentation": "The launch file name.
" } }, "environmentVariables": { @@ -4415,6 +4511,12 @@ "traits": { "smithy.api#documentation": "Boolean indicating whether a streaming session will be configured for the application.\n If True, AWS RoboMaker will configure a connection so you can interact with\n your application as it is running in the simulation. You must configure and launch the\n component. It must have a graphical user interface.
If you've specified General as the value for your RobotSoftwareSuite, you can use this field to specify a list of commands for your container image.
If you've specified SimulationRuntime as the value for your SimulationSoftwareSuite, you can use this field to specify a list of commands for your container image.
A Boolean indicating whether to use default robot application tools. \n The default tools are rviz, rqt, terminal and rosbag record. \n The default is False.\n
A Boolean indicating whether to use default robot application tools. The default tools\n are rviz, rqt, terminal and rosbag record. The default is False.
The S3 key.
" } @@ -6184,10 +6300,10 @@ "target": "com.amazonaws.robomaker#S3KeyOutput" } }, - "com.amazonaws.robomaker#S3Keys": { + "com.amazonaws.robomaker#S3KeysOrPrefixes": { "type": "list", "member": { - "target": "com.amazonaws.robomaker#S3Key" + "target": "com.amazonaws.robomaker#S3KeyOrPrefix" }, "traits": { "smithy.api#length": { @@ -6299,7 +6415,7 @@ "useDefaultTools": { "target": "com.amazonaws.robomaker#BoxedBoolean", "traits": { - "smithy.api#documentation": "A Boolean indicating whether to use default simulation application tools. \n The default tools are rviz, rqt, terminal and rosbag record.\n The default is False.\n
A Boolean indicating whether to use default simulation application tools. The default\n tools are rviz, rqt, terminal and rosbag record. The default is False.
The failure behavior the simulation job.
\nLeaves the host running for its maximum timeout duration after a 4XX error code.
Stop the simulation job and terminate the instance.
\nThe failure behavior the simulation job.
\nLeaves the host running for its maximum timeout duration after a\n 4XX error code.
Stop the simulation job and terminate the instance.
\nThe failure behavior the simulation job.
\nLeaves the host running for its maximum timeout duration after a 4XX error code.
Stop the simulation job and terminate the instance.
\nThe failure behavior the simulation job.
\nLeaves the host running for its maximum timeout duration after a\n 4XX error code.
Stop the simulation job and terminate the instance.
\nThe names of the data sources.
" } + }, + "computeType": { + "target": "com.amazonaws.robomaker#ComputeType", + "traits": { + "smithy.api#documentation": "The compute type for the simulation job summary.
" + } } }, "traits": { @@ -6974,6 +7096,10 @@ { "value": "RosbagPlay", "name": "RosbagPlay" + }, + { + "value": "SimulationRuntime", + "name": "SimulationRuntime" } ] } @@ -7523,7 +7649,7 @@ "streamUI": { "target": "com.amazonaws.robomaker#BoxedBoolean", "traits": { - "smithy.api#documentation": "Boolean indicating whether a streaming session will be configured for the tool.\n If True, AWS RoboMaker will configure a connection so you can interact with\n the tool as it is running in the simulation. It must have a graphical user interface. \n The default is False.\n
Boolean indicating whether a streaming session will be configured for the tool. If\n True, AWS RoboMaker will configure a connection so you can interact with\n the tool as it is running in the simulation. It must have a graphical user interface. The\n default is False.
Boolean indicating whether logs will be recorded in CloudWatch for the tool.\n The default is False.\n
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default\n is False.
Exit behavior determines what happens when your tool quits running. \n RESTART will cause your tool to be restarted. FAIL\n will cause your job to exit. The default is RESTART.\n
Exit behavior determines what happens when your tool quits running. RESTART\n will cause your tool to be restarted. FAIL will cause your job to exit. The\n default is RESTART.
The object that contains the Docker image URI used for your simulation application.
" + "smithy.api#documentation": "The object that contains the Docker image URI used for your simulation\n application.
" } } } @@ -8019,7 +8145,7 @@ "name": { "target": "com.amazonaws.robomaker#Name", "traits": { - "smithy.api#documentation": "A prefix that specifies where files will be uploaded in Amazon S3. \n It is appended to the simulation output location to determine the final path.\n
\n\n For example, if your simulation output location is s3://my-bucket and your upload \n configuration name is robot-test, your files will be uploaded to \n s3://my-bucket/.\n
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the\n simulation output location to determine the final path.
\n For example, if your simulation output location is s3://my-bucket and your\n upload configuration name is robot-test, your files will be uploaded to\n s3://my-bucket/.
Retrieves the behavior configuration of Route 53 Resolver behavior for a single VPC from\n\t\t\t\tAmazon Virtual Private Cloud.
" + } + }, + "com.amazonaws.route53resolver#GetResolverConfigRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.route53resolver#ResourceId", + "traits": { + "smithy.api#documentation": "Resource ID of the Amazon VPC that you want to get information about.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53resolver#GetResolverConfigResponse": { + "type": "structure", + "members": { + "ResolverConfig": { + "target": "com.amazonaws.route53resolver#ResolverConfig", + "traits": { + "smithy.api#documentation": "Information about the behavior configuration of Route 53 Resolver behavior for the VPC you\n\t\t\tspecified in the GetResolverConfig request.
Retrieves the Resolver configurations that you have defined. \n\t\t\tRoute 53 Resolver uses the configurations to manage DNS resolution behavior for your VPCs.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.route53resolver#ListResolverConfigsMaxResult": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 5, + "max": 100 + } + } + }, + "com.amazonaws.route53resolver#ListResolverConfigsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.route53resolver#ListResolverConfigsMaxResult", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of Resolver configurations that you want to return in the response to \n\t\t\ta ListResolverConfigs request. If you don't specify a value for MaxResults, \n\t\t\tup to 100 Resolver configurations are returned.
(Optional) If the current Amazon Web Services account has more than MaxResults Resolver configurations, use \n\t\t\tNextToken to get the second and subsequent pages of results.
For the first ListResolverConfigs request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and \n\t\t\tspecify that value for NextToken in the request.
If a response includes the last of the Resolver configurations that are associated with the current Amazon Web Services account, \n\t\t\tNextToken doesn't appear in the response.
If a response doesn't include the last of the configurations, you can get more configurations by submitting another \n\t\t\tListResolverConfigs request. \n\t\t\tGet the value of NextToken that Amazon Route 53\n returned in the previous response and include it in \n\t\t\tNextToken in the next request.
An array that contains one ResolverConfigs element for each Resolver configuration that is associated \n\t\t\twith the current Amazon Web Services account.
The response to a PutResolverRulePolicy request.
ID for the Resolver configuration.
" + } + }, + "ResourceId": { + "target": "com.amazonaws.route53resolver#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Virtual Private Cloud VPC that you're configuring Resolver for.
" + } + }, + "OwnerId": { + "target": "com.amazonaws.route53resolver#AccountId", + "traits": { + "smithy.api#documentation": "The owner account ID of the Amazon Virtual Private Cloud VPC.
" + } + }, + "AutodefinedReverse": { + "target": "com.amazonaws.route53resolver#ResolverAutodefinedReverseStatus", + "traits": { + "smithy.api#documentation": "The status of whether or not the Resolver will create autodefined rules for reverse DNS\n\t\t\tlookups. This is enabled by default. The status can be one of following:
\n\t\tStatus of the rules generated by VPCs based on CIDR/Region for reverse DNS resolution. The\n\t\t\tstatus can be one of following:
\n\n\t\t\n ENABLING: Autodefined rules for reverse DNS lookups are being\n\t\t\t\t\tenabled but are not complete.
\n\n ENABLED: Autodefined rules for reverse DNS lookups are\n\t\t\t\t\tenabled.
\n\n DISABLING: Autodefined rules for reverse DNS lookups are\n\t\t\t\t\tbeing disabled but are not complete.
\n\n DISABLED: Autodefined rules for reverse DNS lookups are\n\t\t\t\t\tdisabled.
\nA complex type that contains information about a Resolver configuration for a VPC.
" + } + }, + "com.amazonaws.route53resolver#ResolverConfigList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53resolver#ResolverConfig" + } + }, "com.amazonaws.route53resolver#ResolverDNSSECValidationStatus": { "type": "string", "traits": { @@ -5017,7 +5227,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 5000 + "max": 30000 } } }, @@ -5446,6 +5656,9 @@ { "target": "com.amazonaws.route53resolver#GetFirewallRuleGroupPolicy" }, + { + "target": "com.amazonaws.route53resolver#GetResolverConfig" + }, { "target": "com.amazonaws.route53resolver#GetResolverDnssecConfig" }, @@ -5491,6 +5704,9 @@ { "target": "com.amazonaws.route53resolver#ListFirewallRules" }, + { + "target": "com.amazonaws.route53resolver#ListResolverConfigs" + }, { "target": "com.amazonaws.route53resolver#ListResolverDnssecConfigs" }, @@ -5542,6 +5758,9 @@ { "target": "com.amazonaws.route53resolver#UpdateFirewallRuleGroupAssociation" }, + { + "target": "com.amazonaws.route53resolver#UpdateResolverConfig" + }, { "target": "com.amazonaws.route53resolver#UpdateResolverDnssecConfig" }, @@ -6232,6 +6451,74 @@ } } }, + "com.amazonaws.route53resolver#UpdateResolverConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53resolver#UpdateResolverConfigRequest" + }, + "output": { + "target": "com.amazonaws.route53resolver#UpdateResolverConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53resolver#AccessDeniedException" + }, + { + "target": "com.amazonaws.route53resolver#InternalServiceErrorException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidParameterException" + }, + { + "target": "com.amazonaws.route53resolver#InvalidRequestException" + }, + { + "target": "com.amazonaws.route53resolver#LimitExceededException" + }, + { + "target": "com.amazonaws.route53resolver#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53resolver#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.route53resolver#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the behavior configuration of Route 53 Resolver behavior for a single VPC from\n\t\t\t\tAmazon Virtual Private Cloud.
" + } + }, + "com.amazonaws.route53resolver#UpdateResolverConfigRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.route53resolver#ResourceId", + "traits": { + "smithy.api#documentation": "Resource ID of the Amazon VPC that you want to update the Resolver configuration for.
", + "smithy.api#required": {} + } + }, + "AutodefinedReverseFlag": { + "target": "com.amazonaws.route53resolver#AutodefinedReverseFlag", + "traits": { + "smithy.api#documentation": "Indicates whether or not the Resolver will create autodefined rules for reverse DNS\n\t\t\tlookups. This is enabled by default. Disabling this option will also affect EC2-Classic\n\t\t\tinstances using ClassicLink. For more information, see ClassicLink in the\n\t\t\t\t\tAmazon EC2 guide.
\n\t\tIt can take some time for the status change to be completed.
\nAn array that contains settings for the specified Resolver configuration.
" + } + } + } + }, "com.amazonaws.route53resolver#UpdateResolverDnssecConfig": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/sagemaker.2017-07-24.json b/codegen/sdk/aws-models/sagemaker.2017-07-24.json index ea61caa6a86..dae8bcbed86 100644 --- a/codegen/sdk/aws-models/sagemaker.2017-07-24.json +++ b/codegen/sdk/aws-models/sagemaker.2017-07-24.json @@ -6709,7 +6709,7 @@ "ServiceCatalogProvisioningDetails": { "target": "com.amazonaws.sagemaker#ServiceCatalogProvisioningDetails", "traits": { - "smithy.api#documentation": "The product ID and provisioning artifact ID to provision a service catalog. For\n information, see What is Amazon Web Services Service\n Catalog.
", + "smithy.api#documentation": "The product ID and provisioning artifact ID to provision a service catalog. The provisioning \n artifact ID will default to the latest provisioning artifact ID of the product, if you don't \n provide the provisioning artifact ID. For more information, see What is Amazon Web Services Service\n Catalog.
", "smithy.api#required": {} } }, @@ -25183,7 +25183,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides information about the location that is configured for storing model\n artifacts.
\nModel artifacts are the output that results from training a model, and typically\n consist of trained parameters, a model defintion that describes how to compute\n inferences, and other metadata.
" + "smithy.api#documentation": "Provides information about the location that is configured for storing model\n artifacts.
\nModel artifacts are the output that results from training a model, and typically\n consist of trained parameters, a model definition that describes how to compute\n inferences, and other metadata.
" } }, "com.amazonaws.sagemaker#ModelBiasAppSpecification": { @@ -33000,8 +33000,7 @@ "ProvisioningArtifactId": { "target": "com.amazonaws.sagemaker#ServiceCatalogEntityId", "traits": { - "smithy.api#documentation": "The ID of the provisioning artifact.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ID of the provisioning artifact.
" } }, "PathId": { diff --git a/codegen/sdk/aws-models/securityhub.2018-10-26.json b/codegen/sdk/aws-models/securityhub.2018-10-26.json index 9dcecc75d1d..8b8a344b644 100644 --- a/codegen/sdk/aws-models/securityhub.2018-10-26.json +++ b/codegen/sdk/aws-models/securityhub.2018-10-26.json @@ -13735,6 +13735,87 @@ } } }, + "com.amazonaws.securityhub#CreateFindingAggregator": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#CreateFindingAggregatorRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#CreateFindingAggregatorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Used to enable finding aggregation. Must be called from the aggregation Region.
\nFor more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/findingAggregator/create", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#CreateFindingAggregatorRequest": { + "type": "structure", + "members": { + "RegionLinkingMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.
\nThe selected option also determines how to use the Regions provided in the Regions list.
\nThe options are as follows:
\n\n ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.\n
\n ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.\n
\n SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.\n
If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a comma-separated list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a comma-separated list of Regions that do aggregate findings to the aggregation Region.\n
The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop finding aggregation.
" + } + }, + "FindingAggregationRegion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The aggregation Region.
" + } + }, + "RegionLinkingMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
" + } + }, + "Regions": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "The list of excluded Regions or included Regions.
" + } + } + } + }, "com.amazonaws.securityhub#CreateInsight": { "type": "operation", "input": { @@ -14168,6 +14249,60 @@ } } }, + "com.amazonaws.securityhub#DeleteFindingAggregator": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#DeleteFindingAggregatorRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#DeleteFindingAggregatorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.
\nWhen you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.\n
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/findingAggregator/delete/{FindingAggregatorArn+}", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#DeleteFindingAggregatorRequest": { + "type": "structure", + "members": { + "FindingAggregatorArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ARN of the finding aggregator to delete. To obtain the ARN, use ListFindingAggregators.
The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and delete the finding aggregator.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A finding aggregator. A finding aggregator contains the configuration for finding aggregation.
" + } + }, + "com.amazonaws.securityhub#FindingAggregatorList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FindingAggregator" + } + }, "com.amazonaws.securityhub#FindingProviderFields": { "type": "structure", "members": { @@ -15439,6 +15594,85 @@ } } }, + "com.amazonaws.securityhub#GetFindingAggregator": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#GetFindingAggregatorRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#GetFindingAggregatorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the current finding aggregation configuration.
", + "smithy.api#http": { + "method": "GET", + "uri": "/findingAggregator/get/{FindingAggregatorArn+}", + "code": 200 + } + } + }, + "com.amazonaws.securityhub#GetFindingAggregatorRequest": { + "type": "structure", + "members": { + "FindingAggregatorArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ARN of the finding aggregator to return details for. To obtain the ARN, use ListFindingAggregators.
The ARN of the finding aggregator.
" + } + }, + "FindingAggregationRegion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The aggregation Region.
" + } + }, + "RegionLinkingMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
" + } + }, + "Regions": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "The list of excluded Regions or included Regions.
" + } + } + } + }, "com.amazonaws.securityhub#GetFindings": { "type": "operation", "input": { @@ -15462,7 +15696,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of findings that match the specified criteria.
", + "smithy.api#documentation": "Returns a list of findings that match the specified criteria.
\nIf finding aggregation is enabled, then when you call GetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.
If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator. You can run this operation from any Region.
The token returned with the previous set of results. Identifies the next set of results to return.
", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.securityhub#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return. This operation currently only returns a single result.
", + "smithy.api#httpQuery": "MaxResults" + } + } + } + }, + "com.amazonaws.securityhub#ListFindingAggregatorsResponse": { + "type": "structure", + "members": { + "FindingAggregators": { + "target": "com.amazonaws.securityhub#FindingAggregatorList", + "traits": { + "smithy.api#documentation": "The list of finding aggregators. This operation currently only returns a single result.
" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "If there are more results, this is the token to provide in the next call to ListFindingAggregators.
This operation currently only returns a single result.\n
" + } + } + } + }, "com.amazonaws.securityhub#ListInvitations": { "type": "operation", "input": { @@ -18253,6 +18562,9 @@ { "target": "com.amazonaws.securityhub#CreateActionTarget" }, + { + "target": "com.amazonaws.securityhub#CreateFindingAggregator" + }, { "target": "com.amazonaws.securityhub#CreateInsight" }, @@ -18265,6 +18577,9 @@ { "target": "com.amazonaws.securityhub#DeleteActionTarget" }, + { + "target": "com.amazonaws.securityhub#DeleteFindingAggregator" + }, { "target": "com.amazonaws.securityhub#DeleteInsight" }, @@ -18325,6 +18640,9 @@ { "target": "com.amazonaws.securityhub#GetEnabledStandards" }, + { + "target": "com.amazonaws.securityhub#GetFindingAggregator" + }, { "target": "com.amazonaws.securityhub#GetFindings" }, @@ -18349,6 +18667,9 @@ { "target": "com.amazonaws.securityhub#ListEnabledProductsForImport" }, + { + "target": "com.amazonaws.securityhub#ListFindingAggregators" + }, { "target": "com.amazonaws.securityhub#ListInvitations" }, @@ -18370,6 +18691,9 @@ { "target": "com.amazonaws.securityhub#UpdateActionTarget" }, + { + "target": "com.amazonaws.securityhub#UpdateFindingAggregator" + }, { "target": "com.amazonaws.securityhub#UpdateFindings" }, @@ -19346,6 +19670,97 @@ "type": "structure", "members": {} }, + "com.amazonaws.securityhub#UpdateFindingAggregator": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#UpdateFindingAggregatorRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#UpdateFindingAggregatorResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#AccessDeniedException" + }, + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + }, + { + "target": "com.amazonaws.securityhub#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use UpdateFindingAggregator to change the aggregation Region.
You must run UpdateFindingAggregator from the current aggregation Region.\n
The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators.
Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.
\nThe selected option also determines how to use the Regions provided in the Regions list.
\nThe options are as follows:
\n\n ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.\n
\n ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.\n
\n SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.\n
If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a comma-separated list of Regions that do not aggregate findings to the aggregation Region.
If RegionLinkingMode is SPECIFIED_REGIONS, then this is a comma-separated list of Regions that do aggregate findings to the aggregation Region.
The ARN of the finding aggregator.
" + } + }, + "FindingAggregationRegion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The aggregation Region.
" + } + }, + "RegionLinkingMode": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
" + } + }, + "Regions": { + "target": "com.amazonaws.securityhub#StringList", + "traits": { + "smithy.api#documentation": "The list of excluded Regions or included Regions.
" + } + } + } + }, "com.amazonaws.securityhub#UpdateFindings": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/storagegateway.2013-06-30.json b/codegen/sdk/aws-models/storagegateway.2013-06-30.json index 5848815bde2..5905d401d18 100644 --- a/codegen/sdk/aws-models/storagegateway.2013-06-30.json +++ b/codegen/sdk/aws-models/storagegateway.2013-06-30.json @@ -46,7 +46,7 @@ } ], "traits": { - "smithy.api#documentation": "Activates the gateway you previously deployed on your host. In the activation process,\n you specify information such as the Region that you want to use for storing snapshots\n or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an\n activation key, and a name for your gateway. The activation process also associates your\n gateway with your account. For more information, see UpdateGatewayInformation.
\nYou must turn on the gateway VM before you can activate your gateway.
\nActivates the gateway you previously deployed on your host. In the activation process,\n you specify information such as the Amazon Web Services Region that you want to use for\n storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot\n schedule window, an activation key, and a name for your gateway. The activation process\n also associates your gateway with your account. For more information, see UpdateGatewayInformation.
\nYou must turn on the gateway VM before you can activate your gateway.
\nYour gateway activation key. You can obtain the activation key by sending an HTTP GET\n request with redirects enabled to the gateway IP address (port 80). The redirect URL\n returned in the response provides you the activation key for your gateway in the query\n string parameter activationKey. It may also include other activation-related\n parameters, however, these are merely defaults -- the arguments you pass to the\n ActivateGateway API call determine the actual configuration of your\n gateway.
For more information, see Getting activation\n key in the Storage Gateway User Guide.
", + "smithy.api#documentation": "Your gateway activation key. You can obtain the activation key by sending an HTTP GET\n request with redirects enabled to the gateway IP address (port 80). The redirect URL\n returned in the response provides you the activation key for your gateway in the query\n string parameter activationKey. It may also include other activation-related\n parameters, however, these are merely defaults -- the arguments you pass to the\n ActivateGateway API call determine the actual configuration of your\n gateway.
For more information, see Getting activation\n key in the Storage Gateway User Guide.
", "smithy.api#required": {} } }, @@ -76,14 +76,14 @@ "GatewayRegion": { "target": "com.amazonaws.storagegateway#RegionId", "traits": { - "smithy.api#documentation": "A value that indicates the Region where you want to store your data. \n The gateway Region specified must be the same Region \n as the Region in your Host\n header in the request. For more information about available Regions and endpoints for\n Storage Gateway, see \n Storage Gateway endpoints and quotas in the Amazon Web Services General\n Reference.
Valid Values: See \n Storage Gateway endpoints and quotas in the Amazon Web Services General\n Reference.\n \n
", + "smithy.api#documentation": "A value that indicates the Amazon Web Services Region where you want to store your data.\n The gateway Amazon Web Services Region specified must be the same Amazon Web Services Region\n as the Amazon Web Services Region in your Host header in the request. For more\n information about available Amazon Web Services Regions and endpoints for Storage Gateway, see \n Storage Gateway endpoints and quotas in the Amazon Web Services\n General Reference.
Valid Values: See \n Storage Gateway endpoints and quotas in the Amazon Web Services\n General Reference.\n \n
", "smithy.api#required": {} } }, "GatewayType": { "target": "com.amazonaws.storagegateway#GatewayType", "traits": { - "smithy.api#documentation": "A value that defines the type of gateway to activate. The type specified is critical to\n all later functions of the gateway and cannot be changed after activation. The default\n value is CACHED.
Valid Values: STORED | CACHED | VTL |\n FILE_S3 | FILE_FSX_SMB|\n
A value that defines the type of gateway to activate. The type specified is critical to\n all later functions of the gateway and cannot be changed after activation. The default\n value is CACHED.
Valid Values: STORED | CACHED | VTL |\n FILE_S3 | FILE_FSX_SMB|\n
Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It\n is a string made of information such as your account, gateway name, and Region. This\n ARN is used to reference the gateway in other API operations as well as resource-based\n authorization.
\n\nFor gateways activated prior to September 02, 2015, the gateway ARN contains the\n gateway name rather than the gateway ID. Changing the name of the gateway has no effect\n on the gateway ARN.
\nStorage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It\n is a string made of information such as your account, gateway name, and Amazon Web Services Region. This ARN is used to reference the gateway in other API operations as\n well as resource-based authorization.
\n\nFor gateways activated prior to September 02, 2015, the gateway ARN contains the\n gateway name rather than the gateway ID. Changing the name of the gateway has no effect\n on the gateway ARN.
\nAssociate an Amazon FSx file system with the FSx File Gateway. After the\n association process is complete, the file shares on the Amazon FSx file system are\n available for access through the gateway. This operation only supports the FSx File\n Gateway type.
" + "smithy.api#documentation": "Associate an Amazon FSx file system with the FSx File Gateway. After the\n association process is complete, the file shares on the Amazon FSx file system are\n available for access through the gateway. This operation only supports the FSx File Gateway\n type.
" } }, "com.amazonaws.storagegateway#AssociateFileSystemInput": { @@ -446,7 +446,7 @@ "UserName": { "target": "com.amazonaws.storagegateway#DomainUserName", "traits": { - "smithy.api#documentation": "The user name of the user credential that has permission to access the root share D$ of\n the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin\n user group.
", + "smithy.api#documentation": "The user name of the user credential that has permission to access the root share D$ of\n the Amazon FSx file system. The user account must belong to the Amazon FSx\n delegated admin user group.
", "smithy.api#required": {} } }, @@ -473,14 +473,14 @@ "LocationARN": { "target": "com.amazonaws.storagegateway#FileSystemLocationARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the\n FSx File Gateway.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with\n the FSx File Gateway.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.storagegateway#Tags", "traits": { - "smithy.api#documentation": "A list of up to 50 tags that can be assigned to the file system association. Each tag is a key-value pair.
" + "smithy.api#documentation": "A list of up to 50 tags that can be assigned to the file system association. Each tag is\n a key-value pair.
" } }, "AuditDestinationARN": { @@ -495,7 +495,7 @@ "EndpointNetworkConfiguration": { "target": "com.amazonaws.storagegateway#EndpointNetworkConfiguration", "traits": { - "smithy.api#documentation": "Specifies the network configuration information for the gateway associated with the Amazon FSx file system.
\nIf multiple file systems are associated with this gateway, this parameter's IpAddresses field is required.
Specifies the network configuration information for the gateway associated with the\n Amazon FSx file system.
\nIf multiple file systems are associated with this gateway, this parameter's\n IpAddresses field is required.
The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the Amazon S3 storage class that is associated with the pool. When you\n use your backup application to eject the tape, the tape is archived directly into the\n storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
\n\nValid Values: GLACIER | DEEP_ARCHIVE\n
The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the Amazon S3 storage class that is associated with the pool.\n When you use your backup application to eject the tape, the tape is archived directly into\n the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the\n pool.
\n\nValid Values: GLACIER | DEEP_ARCHIVE\n
\n The hour of the day to start the bandwidth rate limit interval.\n
", + "smithy.api#documentation": "The hour of the day to start the bandwidth rate limit interval.
", "smithy.api#required": {} } }, "StartMinuteOfHour": { "target": "com.amazonaws.storagegateway#MinuteOfHour", "traits": { - "smithy.api#documentation": "\n The minute of the hour to start the bandwidth rate limit interval.\n The interval begins at the start of that minute. To begin an interval exactly at \n the start of the hour, use the value 0.\n
The minute of the hour to start the bandwidth rate limit interval. The interval begins\n at the start of that minute. To begin an interval exactly at the start of the hour, use the\n value 0.
\n The hour of the day to end the bandwidth rate limit interval.\n
", + "smithy.api#documentation": "The hour of the day to end the bandwidth rate limit interval.
", "smithy.api#required": {} } }, "EndMinuteOfHour": { "target": "com.amazonaws.storagegateway#MinuteOfHour", "traits": { - "smithy.api#documentation": "\n The minute of the hour to end the bandwidth rate limit interval.\n
\n \n\n The bandwidth rate limit interval ends at the end of the minute. To end an interval\n at the end of an hour, use the value 59.\n
The minute of the hour to end the bandwidth rate limit interval.
\n\n The bandwidth rate limit interval ends at the end of the minute. To end an interval\n at the end of an hour, use the value 59.
\n The average upload rate limit component of the bandwidth rate limit interval,\n in bits per second. This field does not appear in the response if the upload rate limit is not set. \n
" + "smithy.api#documentation": "The average upload rate limit component of the bandwidth rate limit interval, in bits\n per second. This field does not appear in the response if the upload rate limit is not set.\n
" } }, "AverageDownloadRateLimitInBitsPerSec": { "target": "com.amazonaws.storagegateway#BandwidthDownloadRateLimit", "traits": { - "smithy.api#documentation": "\n The average download rate limit component of the bandwidth rate limit interval, \n in bits per second. This field does not appear in the response if the download rate limit is not set. \n
" + "smithy.api#documentation": "The average download rate limit component of the bandwidth rate limit interval, in bits\n per second. This field does not appear in the response if the download rate limit is not\n set.
" } } }, "traits": { - "smithy.api#documentation": "\n Describes a bandwidth rate limit interval for a gateway. A bandwidth\n rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit\n interval defines a period of time on one or more days of the week, during which bandwidth rate \n limits are specified for uploading, downloading, or both. \n
" + "smithy.api#documentation": "Describes a bandwidth rate limit interval for a gateway. A bandwidth rate limit\n schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit\n interval defines a period of time on one or more days of the week, during which bandwidth\n rate limits are specified for uploading, downloading, or both.
" } }, "com.amazonaws.storagegateway#BandwidthRateLimitIntervals": { @@ -816,7 +816,7 @@ "CacheStaleTimeoutInSeconds": { "target": "com.amazonaws.storagegateway#CacheStaleTimeoutInSeconds", "traits": { - "smithy.api#documentation": "Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of\n time since the last refresh after which access to the directory would cause the file\n gateway to first refresh that directory's contents from the Amazon S3 bucket or Amazon FSx file system. The TTL\n duration is in seconds.
\n\nValid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
" + "smithy.api#documentation": "Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of\n time since the last refresh after which access to the directory would cause the file\n gateway to first refresh that directory's contents from the Amazon S3 bucket\n or Amazon FSx file system. The TTL duration is in seconds.
\n\nValid Values:0, 300 to 2,592,000 seconds (5 minutes to 30 days)
" } } }, @@ -1182,13 +1182,13 @@ "KMSEncrypted": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "Set to true to use Amazon S3 server-side encryption with your own KMS\n key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false\n
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
Creates a Network File System (NFS) file share on an existing S3 File Gateway. In Storage\n Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage.\n Storage Gateway exposes file shares using an NFS interface. This operation is only\n supported for S3 File Gateways.
\n\nS3 File gateway requires Security Token Service (STS) to be activated to enable\n you to create a file share. Make sure STS is activated in the Region you are\n creating your S3 File Gateway in. If STS is not activated in the Region, activate\n it. For information about how to activate STS, see Activating and\n deactivating STS in an Region in the \n Identity and Access Management User Guide.
\n\nS3 File Gateways do not support creating hard or symbolic links on a file share.
\nCreates a Network File System (NFS) file share on an existing S3 File Gateway. In\n Storage Gateway, a file share is a file system mount point backed by Amazon S3\n cloud storage. Storage Gateway exposes file shares using an NFS interface. This operation\n is only supported for S3 File Gateways.
\n\nS3 File gateway requires Security Token Service (Amazon Web Services STS) to be\n activated to enable you to create a file share. Make sure Amazon Web Services STS is\n activated in the Amazon Web Services Region you are creating your S3 File Gateway in. If\n Amazon Web Services STS is not activated in the Amazon Web Services Region, activate\n it. For information about how to activate Amazon Web Services STS, see Activating and\n deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Identity and Access Management User Guide.
\n\nS3 File Gateways do not support creating hard or symbolic links on a file\n share.
\nA unique string value that you supply that is used by S3 File Gateway to ensure idempotent\n file share creation.
", + "smithy.api#documentation": "A unique string value that you supply that is used by S3 File Gateway to ensure\n idempotent file share creation.
", "smithy.api#required": {} } }, @@ -1262,33 +1262,33 @@ "KMSEncrypted": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "Set to true to use Amazon S3 server-side encryption with your own KMS\n key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false\n
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes\n when it accesses the underlying storage.
", + "smithy.api#documentation": "The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it\n accesses the underlying storage.
", "smithy.api#required": {} } }, "LocationARN": { "target": "com.amazonaws.storagegateway#LocationARN", "traits": { - "smithy.api#documentation": "The ARN of the backend storage used for storing file data. A prefix name can be added to\n the S3 bucket name. It must end with a \"/\".
\nYou can specify a bucket attached to an access point using a complete ARN that includes the\n bucket region as shown:
\n\n arn:aws:s3:region:account-id:accesspoint/access-point-name\n \n
If you specify a bucket attached to an access point, the bucket policy must be\n configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
\nA custom ARN for the backend storage used for storing data for file shares. It includes\n a resource ARN with an optional prefix concatenation. The prefix must end with a forward\n slash (/).
\nYou can specify LocationARN as a bucket ARN, access point ARN or access point alias,\n as shown in the following examples.
\n\nBucket ARN:
\n\n arn:aws:s3:::my-bucket/prefix/\n
Access point ARN:
\n\n arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/\n
If you specify an access point, the bucket policy must be configured to delegate\n access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
\n\nAccess point alias:
\n\n test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias\n
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
The list of clients that are allowed to access the S3 File Gateway. The list must contain\n either valid IP addresses or valid CIDR blocks.
" + "smithy.api#documentation": "The list of clients that are allowed to access the S3 File Gateway. The list must\n contain either valid IP addresses or valid CIDR blocks.
" } }, "Squash": { @@ -1336,7 +1336,7 @@ "FileShareName": { "target": "com.amazonaws.storagegateway#FileShareName", "traits": { - "smithy.api#documentation": "The name of the file share. Optional.
\n\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN.
The name of the file share. Optional.
\n\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to \n Amazon S3.
\nThis parameter is required for NFS file shares that connect to Amazon S3 \n through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
\nSpecifies the DNS name for the VPC endpoint that the NFS file share uses to connect to\n Amazon S3.
\nThis parameter is required for NFS file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nSpecifies the Region of the S3 bucket where the NFS file share stores files.
\nThis parameter is required for NFS file shares that connect to Amazon S3 \n through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
\nSpecifies the Region of the S3 bucket where the NFS file share stores files.
\nThis parameter is required for NFS file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nThe Amazon Resource Name (ARN) of the storage used for audit logs.
" } } }, @@ -1399,7 +1405,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a Server Message Block (SMB) file share on an existing S3 File Gateway. In Storage\n Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage.\n Storage Gateway exposes file shares using an SMB interface. This operation is only\n supported for S3 File Gateways.
\n\nS3 File Gateways require Security Token Service (STS) to be activated to enable\n you to create a file share. Make sure that STS is activated in the Region you\n are creating your S3 File Gateway in. If STS is not activated in this Region,\n activate it. For information about how to activate STS, see Activating and\n deactivating STS in an Region in the \n Identity and Access Management User Guide.
\n\nFile gateways don't support creating hard or symbolic links on a file\n share.
\nCreates a Server Message Block (SMB) file share on an existing S3 File Gateway. In\n Storage Gateway, a file share is a file system mount point backed by Amazon S3\n cloud storage. Storage Gateway exposes file shares using an SMB interface. This operation\n is only supported for S3 File Gateways.
\n\nS3 File Gateways require Security Token Service (Amazon Web Services STS) to be\n activated to enable you to create a file share. Make sure that Amazon Web Services STS\n is activated in the Amazon Web Services Region you are creating your S3 File Gateway in.\n If Amazon Web Services STS is not activated in this Amazon Web Services Region, activate\n it. For information about how to activate Amazon Web Services STS, see Activating and\n deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Identity and Access Management User Guide.
\n\nFile gateways don't support creating hard or symbolic links on a file\n share.
\nA unique string value that you supply that is used by S3 File Gateway to ensure idempotent\n file share creation.
", + "smithy.api#documentation": "A unique string value that you supply that is used by S3 File Gateway to ensure\n idempotent file share creation.
", "smithy.api#required": {} } }, @@ -1422,33 +1428,33 @@ "KMSEncrypted": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "Set to true to use Amazon S3 server-side encryption with your own KMS\n key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false\n
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes\n when it accesses the underlying storage.
", + "smithy.api#documentation": "The ARN of the Identity and Access Management (IAM) role that an S3 File Gateway assumes when it\n accesses the underlying storage.
", "smithy.api#required": {} } }, "LocationARN": { "target": "com.amazonaws.storagegateway#LocationARN", "traits": { - "smithy.api#documentation": "The ARN of the backend storage used for storing file data. A prefix name can be added to\n the S3 bucket name. It must end with a \"/\".
\nYou can specify a bucket attached to an access point using a complete ARN that includes the\n bucket region as shown:
\n\n arn:aws:s3:region:account-id:accesspoint/access-point-name\n \n
If you specify a bucket attached to an access point, the bucket policy must be\n configured to delegate access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
\nA custom ARN for the backend storage used for storing data for file shares. It includes\n a resource ARN with an optional prefix concatenation. The prefix must end with a forward\n slash (/).
\nYou can specify LocationARN as a bucket ARN, access point ARN or access point alias,\n as shown in the following examples.
\n\nBucket ARN:
\n\n arn:aws:s3:::my-bucket/prefix/\n
Access point ARN:
\n\n arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/\n
If you specify an access point, the bucket policy must be configured to delegate\n access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
\n\nAccess point alias:
\n\n test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias\n
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
The case of an object name in an Amazon S3 bucket. For ClientSpecified, the\n client determines the case sensitivity. For CaseSensitive, the gateway\n determines the case sensitivity. The default value is ClientSpecified.
The case of an object name in an Amazon S3 bucket. For\n ClientSpecified, the client determines the case sensitivity. For\n CaseSensitive, the gateway determines the case sensitivity. The default\n value is ClientSpecified.
The name of the file share. Optional.
\n\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN.
The name of the file share. Optional.
\n\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
\nThis parameter is required for SMB file shares that connect to Amazon S3 \n through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
\nSpecifies the DNS name for the VPC endpoint that the SMB file share uses to connect to\n Amazon S3.
\nThis parameter is required for SMB file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nSpecifies the Region of the S3 bucket where the SMB file share stores files.
\nThis parameter is required for SMB file shares that connect to Amazon S3 \n through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
\nSpecifies the Region of the S3 bucket where the SMB file share stores files.
\nThis parameter is required for SMB file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nSpecifies whether opportunistic locking is enabled for the SMB file share.
\nEnabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve \n access to files with the same name in different case.
\nValid Values: true | false\n
Specifies whether opportunistic locking is enabled for the SMB file share.
\nEnabling opportunistic locking on case-sensitive shares is not recommended for\n workloads that involve access to files with the same name in different case.
\nValid Values: true | false\n
Initiates a snapshot of a volume.
\n\nStorage Gateway provides the ability to back up point-in-time snapshots of your data\n to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also import the\n data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2).\n You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API\n enables you to take an ad hoc snapshot. For more information, see Editing a\n snapshot schedule.
\n\nIn the CreateSnapshot request, you identify the volume by providing its\n Amazon Resource Name (ARN). You must also provide description for the snapshot. When \n Storage Gateway takes the snapshot of specified volume, the snapshot and description\n appears in the Storage Gateway console. In response, Storage Gateway returns you a\n snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it\n when you want to create a volume from a snapshot. This operation is only supported in\n stored and cached volume gateway type.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information,\n see DescribeSnapshots\n or DeleteSnapshot in the Amazon Elastic Compute Cloud API\n Reference.
\nVolume and snapshot IDs are changing to a longer length ID format. For more\n information, see the important note on the Welcome page.
\nInitiates a snapshot of a volume.
\n\nStorage Gateway provides the ability to back up point-in-time snapshots of your\n data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also\n import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute\n Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis.\n This API enables you to take an ad hoc snapshot. For more information, see Editing a\n snapshot schedule.
\n\nIn the CreateSnapshot request, you identify the volume by providing its\n Amazon Resource Name (ARN). You must also provide description for the snapshot. When\n Storage Gateway takes the snapshot of specified volume, the snapshot and\n description appears in the Storage Gateway console. In response, Storage Gateway\n returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or\n later use it when you want to create a volume from a snapshot. This operation is only\n supported in stored and cached volume gateway type.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information,\n see DescribeSnapshots\n or DeleteSnapshot in the Amazon Elastic Compute Cloud API\n Reference.
\nVolume and snapshot IDs are changing to a longer length ID format. For more\n information, see the important note on the Welcome page.
\nSet to true to use Amazon S3 server-side encryption with your own KMS\n key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false\n
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
Tape retention lock can be configured in two modes. When configured in governance mode,\n accounts with specific IAM permissions are authorized to remove the tape retention lock\n from archived virtual tapes. When configured in compliance mode, the tape retention lock\n cannot be removed by any user, including the root account.
" + "smithy.api#documentation": "Tape retention lock can be configured in two modes. When configured in governance mode,\n Amazon Web Services accounts with specific IAM permissions are authorized to remove the\n tape retention lock from archived virtual tapes. When configured in compliance mode, the\n tape retention lock cannot be removed by any user, including the root Amazon Web Services account.
" } }, "RetentionLockTimeInDays": { @@ -1901,7 +1907,7 @@ "PoolARN": { "target": "com.amazonaws.storagegateway#PoolARN", "traits": { - "smithy.api#documentation": "The unique Amazon Resource Name (ARN) that represents the custom tape pool. Use the\n ListTapePools operation to return a list of tape pools for your\n account and Region.
" + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) that represents the custom tape pool. Use the\n ListTapePools operation to return a list of tape pools for your\n account and Amazon Web Services Region.
" } } } @@ -1932,7 +1938,7 @@ "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "The unique Amazon Resource Name (ARN) that represents the gateway to associate the\n virtual tape with. Use the ListGateways operation to return a list of\n gateways for your account and Region.
", + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) that represents the gateway to associate the\n virtual tape with. Use the ListGateways operation to return a list of\n gateways for your account and Amazon Web Services Region.
", "smithy.api#required": {} } }, @@ -1953,13 +1959,13 @@ "KMSEncrypted": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "Set to true to use Amazon S3 server-side encryption with your own KMS\n key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false\n
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
The unique Amazon Resource Name (ARN) that represents the gateway to associate the\n virtual tapes with. Use the ListGateways operation to return a list of\n gateways for your account and Region.
", + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) that represents the gateway to associate the\n virtual tapes with. Use the ListGateways operation to return a list of\n gateways for your account and Amazon Web Services Region.
", "smithy.api#required": {} } }, @@ -2060,13 +2066,13 @@ "KMSEncrypted": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "Set to true to use Amazon S3 server-side encryption with your own KMS\n key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false\n
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
Deletes a file share from an S3 File Gateway. This operation is only supported for S3 File\n Gateways.
" + "smithy.api#documentation": "Deletes a file share from an S3 File Gateway. This operation is only supported for S3\n File Gateways.
" } }, "com.amazonaws.storagegateway#DeleteFileShareInput": { @@ -2337,7 +2343,7 @@ "ForceDelete": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { - "smithy.api#documentation": "If this value is set to true, the operation deletes a file share\n immediately and aborts all data uploads to Amazon Web Services. Otherwise, the file share is not deleted\n until all data is uploaded to Amazon Web Services. This process aborts the data upload process, and the\n file share enters the FORCE_DELETING status.
Valid Values: true | false\n
If this value is set to true, the operation deletes a file share\n immediately and aborts all data uploads to Amazon Web Services. Otherwise, the file share is\n not deleted until all data is uploaded to Amazon Web Services. This process aborts the data\n upload process, and the file share enters the FORCE_DELETING status.
Valid Values: true | false\n
The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is\n associated with. Use the ListGateways operation to return a list of\n gateways for your account and Region.
", + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is\n associated with. Use the ListGateways operation to return a list of\n gateways for your account and Amazon Web Services Region.
", "smithy.api#required": {} } }, @@ -2790,7 +2796,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do \n not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This \n operation is supported only in the volume and tape gateway types.\n
\n \nThis operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth\n rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit\n interval defines a period of time on one or more days of the week, during which bandwidth rate \n limits are specified for uploading, downloading, or both. \n
\n \n\n A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, \n an ending hour and minute, and bandwidth rate limits for uploading and downloading\n
\n \n\n If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an \n empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN)\n of the gateway in your request.
" + "smithy.api#documentation": "Returns information about the bandwidth rate limit schedule of a gateway. By default,\n gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting\n is in effect. This operation is supported only in the volume and tape gateway types.
\n\nThis operation returns information about a gateway's bandwidth rate limit schedule. A\n bandwidth rate limit schedule consists of one or more bandwidth rate limit intervals. A\n bandwidth rate limit interval defines a period of time on one or more days of the week,\n during which bandwidth rate limits are specified for uploading, downloading, or both.
\n\nA bandwidth rate limit interval consists of one or more days of the week, a start hour\n and minute, an ending hour and minute, and bandwidth rate limits for uploading and\n downloading
\n\nIf no bandwidth rate limit schedule intervals are set for the gateway, this operation\n returns an empty response. To specify which gateway to describe, use the Amazon Resource\n Name (ARN) of the gateway in your request.
" } }, "com.amazonaws.storagegateway#DescribeBandwidthRateLimitScheduleInput": { @@ -2813,7 +2819,7 @@ "BandwidthRateLimitIntervals": { "target": "com.amazonaws.storagegateway#BandwidthRateLimitIntervals", "traits": { - "smithy.api#documentation": "\n An array that contains the bandwidth rate limit intervals for a tape or volume gateway.\n
" + "smithy.api#documentation": "An array that contains the bandwidth rate limit intervals for a tape or volume gateway.
" } } } @@ -2876,7 +2882,7 @@ "CacheDirtyPercentage": { "target": "com.amazonaws.storagegateway#double", "traits": { - "smithy.api#documentation": "The file share's contribution to the overall percentage of the gateway's cache\n that has not been persisted to Amazon Web Services. The sample is taken at the end of the reporting\n period.
" + "smithy.api#documentation": "The file share's contribution to the overall percentage of the gateway's cache\n that has not been persisted to Amazon Web Services. The sample is taken at the end of the\n reporting period.
" } }, "CacheHitPercentage": { @@ -2910,7 +2916,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a description of the gateway volumes specified in the request. This operation is\n only supported in the cached volume gateway types.
\n\nThe list of gateway volumes in the request must be from one gateway. In the response,\n Storage Gateway returns volume information sorted by volume Amazon Resource Name\n (ARN).
" + "smithy.api#documentation": "Returns a description of the gateway volumes specified in the request. This operation is\n only supported in the cached volume gateway types.
\n\nThe list of gateway volumes in the request must be from one gateway. In the response,\n Storage Gateway returns volume information sorted by volume Amazon Resource Name\n (ARN).
" } }, "com.amazonaws.storagegateway#DescribeCachediSCSIVolumesInput": { @@ -3005,7 +3011,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the file system association information. This operation is only supported for\n FSx File Gateways.
" + "smithy.api#documentation": "Gets the file system association information. This operation is only supported for FSx\n File Gateways.
" } }, "com.amazonaws.storagegateway#DescribeFileSystemAssociationsInput": { @@ -3014,7 +3020,7 @@ "FileSystemAssociationARNList": { "target": "com.amazonaws.storagegateway#FileSystemAssociationARNList", "traits": { - "smithy.api#documentation": "An array containing the Amazon Resource Name (ARN) of each file system association to be described.
", + "smithy.api#documentation": "An array containing the Amazon Resource Name (ARN) of each file system association to be\n described.
", "smithy.api#required": {} } } @@ -3026,7 +3032,7 @@ "FileSystemAssociationInfoList": { "target": "com.amazonaws.storagegateway#FileSystemAssociationInfoList", "traits": { - "smithy.api#documentation": "An array containing the FileSystemAssociationInfo data type of each file system association to be described. \n
An array containing the FileSystemAssociationInfo data type of each file\n system association to be described.\n
The Region where the Amazon EC2 instance is located.
" + "smithy.api#documentation": "The Amazon Web Services Region where the Amazon EC2 instance is located.
" } }, "Tags": { @@ -3182,7 +3188,7 @@ "SupportedGatewayCapacities": { "target": "com.amazonaws.storagegateway#SupportedGatewayCapacities", "traits": { - "smithy.api#documentation": "A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
" + "smithy.api#documentation": "A list of the metadata cache sizes that the gateway can support based on its current\n hardware specifications.
" } } }, @@ -3421,13 +3427,19 @@ "SMBSecurityStrategy": { "target": "com.amazonaws.storagegateway#SMBSecurityStrategy", "traits": { - "smithy.api#documentation": "The type of security strategy that was specified for file gateway.
\n\n\n ClientSpecified: If you use this option, requests are established\n based on what is negotiated by the client. This option is recommended when you want\n to maximize compatibility across different clients in your environment. Only supported for S3 File Gateways.
\n MandatorySigning: If you use this option, file gateway only allows\n connections from SMBv2 or SMBv3 clients that have signing enabled. This option works\n with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
\n MandatoryEncryption: If you use this option, file gateway only allows\n connections from SMBv3 clients that have encryption enabled. This option is highly\n recommended for environments that handle sensitive data. This option works with SMB\n clients on Microsoft Windows 8, Windows Server 2012 or newer.
The type of security strategy that was specified for file gateway.
\n\n\n ClientSpecified: If you use this option, requests are established\n based on what is negotiated by the client. This option is recommended when you want\n to maximize compatibility across different clients in your environment. Only\n supported for S3 File Gateways.
\n MandatorySigning: If you use this option, file gateway only allows\n connections from SMBv2 or SMBv3 clients that have signing enabled. This option works\n with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
\n MandatoryEncryption: If you use this option, file gateway only allows\n connections from SMBv3 clients that have encryption enabled. This option is highly\n recommended for environments that handle sensitive data. This option works with SMB\n clients on Microsoft Windows 8, Windows Server 2012 or newer.
The shares on this gateway appear when listing shares. Only supported for S3 File Gateways.
" + "smithy.api#documentation": "The shares on this gateway appear when listing shares. Only supported for S3 File\n Gateways.
" + } + }, + "SMBLocalGroups": { + "target": "com.amazonaws.storagegateway#SMBLocalGroups", + "traits": { + "smithy.api#documentation": "A list of Active Directory users and groups that have special permissions for SMB file\n shares on the gateway.
" } } } @@ -3525,7 +3537,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns the description of the gateway volumes specified in the request. The list of\n gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported\n in stored volume gateway type.
" + "smithy.api#documentation": "Returns the description of the gateway volumes specified in the request. The list of\n gateway volumes in the request must be from one gateway. In the response, Storage Gateway returns volume information sorted by volume ARNs. This operation is only\n supported in stored volume gateway type.
" } }, "com.amazonaws.storagegateway#DescribeStorediSCSIVolumesInput": { @@ -4150,7 +4162,7 @@ } ], "traits": { - "smithy.api#documentation": "Disassociates an Amazon FSx file system from the specified gateway. After the\n disassociation process finishes, the gateway can no longer access the Amazon FSx file\n system. This operation is only supported in the FSx File Gateway type.
" + "smithy.api#documentation": "Disassociates an Amazon FSx file system from the specified gateway. After the\n disassociation process finishes, the gateway can no longer access the Amazon FSx\n file system. This operation is only supported in the FSx File Gateway type.
" } }, "com.amazonaws.storagegateway#DisassociateFileSystemInput": { @@ -4166,7 +4178,7 @@ "ForceDelete": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { - "smithy.api#documentation": "If this value is set to true, the operation disassociates an Amazon FSx file system\n immediately. It ends all data uploads to the file system, and the file system association\n enters the FORCE_DELETING status. If this value is set to false, the Amazon FSx file system does not disassociate until all data is uploaded.
If this value is set to true, the operation disassociates an Amazon FSx file\n system immediately. It ends all data uploads to the file system, and the file system\n association enters the FORCE_DELETING status. If this value is set to false,\n the Amazon FSx file system does not disassociate until all data is uploaded.
A list of gateway IP addresses on which the associated Amazon FSx file system is available.
\nIf multiple file systems are associated with this gateway, this field is required.
\nA list of gateway IP addresses on which the associated Amazon FSx file system is\n available.
\nIf multiple file systems are associated with this gateway, this field is\n required.
\nSpecifies network configuration information for the gateway associated with the \n Amazon FSx file system.
" + "smithy.api#documentation": "Specifies network configuration information for the gateway associated with the Amazon FSx file system.
" } }, "com.amazonaws.storagegateway#EndpointType": { @@ -4634,7 +4646,7 @@ "target": "com.amazonaws.storagegateway#IPV4AddressCIDR" }, "traits": { - "smithy.api#documentation": "The list of clients that are allowed to access the S3 File Gateway. The list must contain\n either valid IP addresses or valid CIDR blocks.
", + "smithy.api#documentation": "The list of clients that are allowed to access the S3 File Gateway. The list must\n contain either valid IP addresses or valid CIDR blocks.
", "smithy.api#length": { "min": 1, "max": 100 @@ -4757,13 +4769,13 @@ "LocationARN": { "target": "com.amazonaws.storagegateway#FileSystemLocationARN", "traits": { - "smithy.api#documentation": "The ARN of the backend Amazon FSx file system used for storing file data. For\n information, see FileSystem in the Amazon FSx\n API Reference.
" + "smithy.api#documentation": "The ARN of the backend Amazon FSx file system used for storing file data. For\n information, see FileSystem in the\n Amazon FSx API Reference.
" } }, "FileSystemAssociationStatus": { "target": "com.amazonaws.storagegateway#FileSystemAssociationStatus", "traits": { - "smithy.api#documentation": "The status of the file system association. \n Valid Values: AVAILABLE | CREATING | DELETING | \n FORCE_DELETING | UPDATING | ERROR\n
The status of the file system association. Valid Values: AVAILABLE |\n CREATING | DELETING | FORCE_DELETING |\n UPDATING | ERROR\n
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair.
" + "smithy.api#documentation": "A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key\n name. Each tag is a key-value pair.
" } }, "CacheAttributes": { @@ -4787,7 +4799,13 @@ "EndpointNetworkConfiguration": { "target": "com.amazonaws.storagegateway#EndpointNetworkConfiguration", "traits": { - "smithy.api#documentation": "Specifies network configuration information for the gateway associated with the \n Amazon FSx file system.
\nIf multiple file systems are associated with this gateway, this parameter's IpAddresses \n field is required.
Specifies network configuration information for the gateway associated with the Amazon FSx file system.
\nIf multiple file systems are associated with this gateway, this parameter's\n IpAddresses field is required.
An array containing the FileSystemAssociationStatusDetail data type, which provides\n detailed information on file system association status.
" } } }, @@ -4810,6 +4828,26 @@ } } }, + "com.amazonaws.storagegateway#FileSystemAssociationStatusDetail": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.storagegateway#FileSystemAssociationSyncErrorCode", + "traits": { + "smithy.api#documentation": "The error code for a given file system association status.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Detailed information on file system association status.
" + } + }, + "com.amazonaws.storagegateway#FileSystemAssociationStatusDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.storagegateway#FileSystemAssociationStatusDetail" + } + }, "com.amazonaws.storagegateway#FileSystemAssociationSummary": { "type": "structure", "members": { @@ -4828,7 +4866,7 @@ "FileSystemAssociationStatus": { "target": "com.amazonaws.storagegateway#FileSystemAssociationStatus", "traits": { - "smithy.api#documentation": "The status of the file share. Valid Values: AVAILABLE | CREATING | DELETING | \n FORCE_DELETING | UPDATING | ERROR\n
The status of the file share. Valid Values: AVAILABLE |\n CREATING | DELETING | FORCE_DELETING |\n UPDATING | ERROR\n
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and Region.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and Amazon Web Services Region.
", "smithy.api#length": { "min": 50, "max": 500 @@ -4925,7 +4966,7 @@ "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and Region.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and Amazon Web Services Region.
" } }, "GatewayType": { @@ -4955,7 +4996,7 @@ "Ec2InstanceRegion": { "target": "com.amazonaws.storagegateway#Ec2InstanceRegion", "traits": { - "smithy.api#documentation": "The Region where the Amazon EC2 instance is located.
" + "smithy.api#documentation": "The Amazon Web Services Region where the Amazon EC2 instance is located.
" } } }, @@ -5198,7 +5239,7 @@ "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and Region.
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and Amazon Web Services Region.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
Gets a list of the file shares for a specific S3 File Gateway, or the list of file shares\n that belong to the calling user account. This operation is only supported for S3 File Gateways.
", + "smithy.api#documentation": "Gets a list of the file shares for a specific S3 File Gateway, or the list of file\n shares that belong to the calling user account. This operation is only supported for S3\n File Gateways.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -5438,13 +5479,13 @@ "Limit": { "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { - "smithy.api#documentation": "The maximum number of file system associations to return in the response. If present, Limit must be an integer with a value greater than zero. Optional.
The maximum number of file system associations to return in the response. If present,\n Limit must be an integer with a value greater than zero. Optional.
Opaque pagination token returned from a previous ListFileSystemAssociations operation. If present, Marker specifies where to continue the list from after a previous call to ListFileSystemAssociations. Optional.
Opaque pagination token returned from a previous ListFileSystemAssociations\n operation. If present, Marker specifies where to continue the list from after\n a previous call to ListFileSystemAssociations. Optional.
If the request includes Marker, the response returns that value in this field.
If the request includes Marker, the response returns that value in this\n field.
If a value is present, there are more file system associations to return. \n In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file system associations.
If a value is present, there are more file system associations to return. In a\n subsequent request, use NextMarker as the value for Marker to\n retrieve the next set of file system associations.
An array of information about the Amazon FSx gateway's file system associations.
" + "smithy.api#documentation": "An array of information about the Amazon FSx gateway's file system\n associations.
" } } } @@ -5489,7 +5530,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists gateways owned by an account in an Region specified in the request. The\n returned list is ordered by gateway Amazon Resource Name (ARN).
\n\nBy default, the operation returns a maximum of 100 gateways. This operation supports\n pagination that allows you to optionally reduce the number of gateways returned in a\n response.
\n\nIf you have more gateways than are returned in a response (that is, the response returns\n only a truncated list of your gateways), the response contains a marker that you can\n specify in your next request to fetch the next page of gateways.
", + "smithy.api#documentation": "Lists gateways owned by an Amazon Web Services account in an Amazon Web Services Region\n specified in the request. The returned list is ordered by gateway Amazon Resource Name\n (ARN).
\n\nBy default, the operation returns a maximum of 100 gateways. This operation supports\n pagination that allows you to optionally reduce the number of gateways returned in a\n response.
\n\nIf you have more gateways than are returned in a response (that is, the response returns\n only a truncated list of your gateways), the response contains a marker that you can\n specify in your next request to fetch the next page of gateways.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "Marker", @@ -5974,7 +6015,7 @@ "com.amazonaws.storagegateway#LocationARN": { "type": "string", "traits": { - "smithy.api#documentation": "The ARN of the backend storage used for storing file data. A prefix name can be added to\n the S3 bucket name. It must end with a \"/\".
", + "smithy.api#documentation": "A custom ARN for the backend storage used for storing data for file shares. It includes\n a resource ARN with an optional prefix concatenation. The prefix must end with a forward\n slash (/).
\nYou can specify LocationARN as a bucket ARN, access point ARN or access point alias,\n as shown in the following examples.
\n\nBucket ARN:
\n\n arn:aws:s3:::my-bucket/prefix/\n
Access point ARN:
\n\n arn:aws:s3:region:account-id:accesspoint/access-point-name/prefix/\n
If you specify an access point, the bucket policy must be configured to delegate\n access control to the access point. For information, see Delegating access control to access points in the Amazon S3 User Guide.
\n\nAccess point alias:
\n\n test-ap-ab123cdef4gehijklmn5opqrstuvuse1a-s3alias\n
Describes Network File System (NFS) file share default values. Files and folders stored\n as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions\n assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that\n represent files and folders are assigned these default Unix permissions. This operation is\n only supported for S3 File Gateways.
" + "smithy.api#documentation": "Describes Network File System (NFS) file share default values. Files and folders stored\n as Amazon S3 objects in S3 buckets don't, by default, have Unix file\n permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3\n objects that represent files and folders are assigned these default Unix permissions. This\n operation is only supported for S3 File Gateways.
" } }, "com.amazonaws.storagegateway#NFSFileShareInfo": { @@ -6072,7 +6113,7 @@ "KMSEncrypted": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { - "smithy.api#documentation": "Set to true to use Amazon S3 server-side encryption with your own KMS\n key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false\n
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
The name of the file share. Optional.
\n\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN.
The name of the file share. Optional.
\n\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.
Specifies the DNS name for the VPC endpoint that the NFS file share uses to connect to Amazon S3.
\nThis parameter is required for NFS file shares that connect to Amazon S3 \n through a VPC endpoint, a VPC access point, or an access point alias that points to a \n VPC access point.
\nSpecifies the DNS name for the VPC endpoint that the NFS file share uses to connect to\n Amazon S3.
\nThis parameter is required for NFS file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nSpecifies the Region of the S3 bucket where the NFS file share stores files.
\nThis parameter is required for NFS file shares that connect to Amazon S3 \n through a VPC endpoint, a VPC access point, or an access point alias that points to a \n VPC access point.
\nSpecifies the Region of the S3 bucket where the NFS file share stores files.
\nThis parameter is required for NFS file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nThe Amazon Resource Name (ARN) of the storage used for audit logs.
" } } }, "traits": { - "smithy.api#documentation": "The Unix file permissions and ownership information assigned, by default, to native S3\n objects when an S3 File Gateway discovers them in S3 buckets. This operation is only supported in\n S3 File Gateways.
" + "smithy.api#documentation": "The Unix file permissions and ownership information assigned, by default, to native S3\n objects when an S3 File Gateway discovers them in S3 buckets. This operation is only\n supported in S3 File Gateways.
" } }, "com.amazonaws.storagegateway#NFSFileShareInfoList": { @@ -6245,7 +6292,7 @@ } ], "traits": { - "smithy.api#documentation": "Sends you notification through CloudWatch Events when all files written to your file\n share have been uploaded to Amazon S3.
\n\nStorage Gateway can send a notification through Amazon CloudWatch Events when all\n files written to your file share up to that point in time have been uploaded to Amazon S3.\n These files include files written to the file share up to the time that you make a request\n for notification. When the upload is done, Storage Gateway sends you notification through\n an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification\n through event targets such as Amazon SNS or Lambda function. \n This operation is only supported for S3 File Gateways.
\n\n \n\nFor more information, see Getting file upload notification in the Storage Gateway User\n Guide.
" + "smithy.api#documentation": "Sends you notification through CloudWatch Events when all files written to your file\n share have been uploaded to Amazon S3.
\n\nStorage Gateway can send a notification through Amazon CloudWatch Events when all\n files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you\n make a request for notification. When the upload is done, Storage Gateway sends you\n notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to\n send the notification through event targets such as Amazon SNS or Lambda function. This operation is only supported for S3 File Gateways.
\n\n \n\nFor more information, see Getting file upload notification in the Storage Gateway User\n Guide.
" } }, "com.amazonaws.storagegateway#NotifyWhenUploadedInput": { @@ -6283,7 +6330,7 @@ "com.amazonaws.storagegateway#ObjectACL": { "type": "string", "traits": { - "smithy.api#documentation": "A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that an S3 File Gateway puts objects into. The default value is private.
A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that an S3 File Gateway puts objects into. The default value is\n private.
The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your\n account and Region.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your\n account and Amazon Web Services Region.
" } }, "PoolName": { @@ -6399,7 +6446,7 @@ "RetentionLockType": { "target": "com.amazonaws.storagegateway#RetentionLockType", "traits": { - "smithy.api#documentation": "Tape retention lock type, which can be configured in two modes. When configured in\n governance mode, accounts with specific IAM permissions are authorized to remove the\n tape retention lock from archived virtual tapes. When configured in compliance mode, the\n tape retention lock cannot be removed by any user, including the root account.
" + "smithy.api#documentation": "Tape retention lock type, which can be configured in two modes. When configured in\n governance mode, Amazon Web Services accounts with specific IAM permissions are authorized\n to remove the tape retention lock from archived virtual tapes. When configured in\n compliance mode, the tape retention lock cannot be removed by any user, including the root\n Amazon Web Services account.
" } }, "RetentionLockTimeInDays": { @@ -6486,7 +6533,7 @@ } ], "traits": { - "smithy.api#documentation": "Refreshes the cached inventory of objects for the specified file share. This operation\n finds objects in the Amazon S3 bucket that were added, removed, or replaced since the\n gateway last listed the bucket's contents and cached the results. This operation does\n not import files into the S3 File Gateway cache storage. It only updates the cached inventory\n to reflect changes in the inventory of the objects in the S3 bucket. This operation is only\n supported in the S3 File Gateway types.
\nYou can subscribe to be notified through an Amazon\n CloudWatch event when your RefreshCache operation completes. For more\n information, see Getting notified about file operations in the Storage Gateway\n User Guide. This operation is Only supported for S3 File Gateways.
When this API is called, it only initiates the refresh operation. When the API call\n completes and returns a success code, it doesn't necessarily mean that the file\n refresh has completed. You should use the refresh-complete notification to determine that\n the operation has completed before you check for new files on the gateway file share. You\n can subscribe to be notified through a CloudWatch event when your RefreshCache\n operation completes.
Throttle limit: This API is asynchronous, so the gateway will accept no more than two\n refreshes at any time. We recommend using the refresh-complete CloudWatch event\n notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.
\n\nIf you invoke the RefreshCache API when two requests are already being processed, any\n new request will cause an InvalidGatewayRequestException error because too\n many requests were sent to the server.
For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.
" + "smithy.api#documentation": "Refreshes the cached inventory of objects for the specified file share. This operation\n finds objects in the Amazon S3 bucket that were added, removed, or replaced since\n the gateway last listed the bucket's contents and cached the results. This operation\n does not import files into the S3 File Gateway cache storage. It only updates the cached\n inventory to reflect changes in the inventory of the objects in the S3 bucket. This\n operation is only supported in the S3 File Gateway types.
\nYou can subscribe to be notified through an Amazon CloudWatch event when your\n RefreshCache operation completes. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide. This operation is Only supported for S3 File Gateways.
When this API is called, it only initiates the refresh operation. When the API call\n completes and returns a success code, it doesn't necessarily mean that the file\n refresh has completed. You should use the refresh-complete notification to determine that\n the operation has completed before you check for new files on the gateway file share. You\n can subscribe to be notified through a CloudWatch event when your RefreshCache\n operation completes.
Throttle limit: This API is asynchronous, so the gateway will accept no more than two\n refreshes at any time. We recommend using the refresh-complete CloudWatch event\n notification before issuing additional requests. For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.
\n\nIf you invoke the RefreshCache API when two requests are already being processed, any\n new request will cause an InvalidGatewayRequestException error because too\n many requests were sent to the server.
For more information, see Getting notified about file operations in the Storage Gateway\n User Guide.
" } }, "com.amazonaws.storagegateway#RefreshCacheInput": { @@ -6502,7 +6549,7 @@ "FolderList": { "target": "com.amazonaws.storagegateway#FolderList", "traits": { - "smithy.api#documentation": "A comma-separated list of the paths of folders to refresh in the cache. The default is\n [\"/\"]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to true, the entire S3 bucket that\n the file share has access to is refreshed.
A comma-separated list of the paths of folders to refresh in the cache. The default is\n [\"/\"]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to true, the entire S3\n bucket that the file share has access to is refreshed.
Resets all cache disks that have encountered an error and makes the disks available for\n reconfiguration as cache storage. If your cache disk encounters an error, the gateway\n prevents read and write operations on virtual tapes in the gateway. For example, an error\n can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the\n gateway loses its cache storage. At this point, you can reconfigure the disks as cache\n disks. This operation is only supported in the cached volume and tape types.
\n\nIf the cache disk you are resetting contains data that has not been uploaded to\n Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no\n configured cache disks left in the gateway, so you must configure at least one new cache\n disk for your gateway to function properly.
\nResets all cache disks that have encountered an error and makes the disks available for\n reconfiguration as cache storage. If your cache disk encounters an error, the gateway\n prevents read and write operations on virtual tapes in the gateway. For example, an error\n can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the\n gateway loses its cache storage. At this point, you can reconfigure the disks as cache\n disks. This operation is only supported in the cached volume and tape types.
\n\nIf the cache disk you are resetting contains data that has not been uploaded to\n Amazon S3 yet, that data can be lost. After you reset cache disks, there will\n be no configured cache disks left in the gateway, so you must configure at least one new\n cache disk for your gateway to function properly.
\nThe Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to.\n Use the ListGateways operation to return a list of gateways for your\n account and Region.
\n\nYou retrieve archived virtual tapes to only one gateway and the gateway must be a tape\n gateway.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to.\n Use the ListGateways operation to return a list of gateways for your\n account and Amazon Web Services Region.
\n\nYou retrieve archived virtual tapes to only one gateway and the gateway must be a tape\n gateway.
", "smithy.api#required": {} } } @@ -6812,7 +6859,7 @@ "KMSEncrypted": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { - "smithy.api#documentation": "Set to true to use Amazon S3 server-side encryption with your own KMS\n key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false\n
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
The case of an object name in an Amazon S3 bucket. For ClientSpecified, the\n client determines the case sensitivity. For CaseSensitive, the gateway\n determines the case sensitivity. The default value is ClientSpecified.
The case of an object name in an Amazon S3 bucket. For\n ClientSpecified, the client determines the case sensitivity. For\n CaseSensitive, the gateway determines the case sensitivity. The default\n value is ClientSpecified.
The name of the file share. Optional.
\n\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN.
The name of the file share. Optional.
\n\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.
Specifies the DNS name for the VPC endpoint that the SMB file share uses to connect to Amazon S3.
\nThis parameter is required for SMB file shares that connect to Amazon S3 \n through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
\nSpecifies the DNS name for the VPC endpoint that the SMB file share uses to connect to\n Amazon S3.
\nThis parameter is required for SMB file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nSpecifies the Region of the S3 bucket where the SMB file share stores files.
\nThis parameter is required for SMB file shares that connect to Amazon S3 \n through a VPC endpoint, a VPC access point, or an access point alias that points to a VPC access point.
\nSpecifies the Region of the S3 bucket where the SMB file share stores files.
\nThis parameter is required for SMB file shares that connect to Amazon S3\n through a VPC endpoint, a VPC access point, or an access point alias that points to a\n VPC access point.
\nSpecifies whether opportunistic locking is enabled for the SMB file share.
\nEnabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve \n access to files with the same name in different case.
\nValid Values: true | false\n
Specifies whether opportunistic locking is enabled for the SMB file share.
\nEnabling opportunistic locking on case-sensitive shares is not recommended for\n workloads that involve access to files with the same name in different case.
\nValid Values: true | false\n
The Windows file permissions and ownership information assigned, by default, to native\n S3 objects when S3 File Gateway discovers them in S3 buckets. This operation is only supported\n for S3 File Gateways.
" + "smithy.api#documentation": "The Windows file permissions and ownership information assigned, by default, to native\n S3 objects when S3 File Gateway discovers them in S3 buckets. This operation is only\n supported for S3 File Gateways.
" } }, "com.amazonaws.storagegateway#SMBFileShareInfoList": { @@ -6966,6 +7013,20 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.storagegateway#SMBLocalGroups": { + "type": "structure", + "members": { + "GatewayAdmins": { + "target": "com.amazonaws.storagegateway#UserList", + "traits": { + "smithy.api#documentation": "A list of Active Directory users and groups that have local Gateway Admin permissions.\n Acceptable formats include: DOMAIN\\User1, user1,\n DOMAIN\\group1, and group1.
Gateway Admins can use the Shared Folders Microsoft Management Console snap-in to\n force-close files that are open and locked.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of Active Directory users and groups that have special permissions for SMB file\n shares on the gateway.
" + } + }, "com.amazonaws.storagegateway#SMBSecurityStrategy": { "type": "string", "traits": { @@ -7073,7 +7134,7 @@ } ], "traits": { - "smithy.api#documentation": "Sets the password for the guest user smbguest. The smbguest\n user is the user when the authentication method for the file share is set to\n GuestAccess. This operation only supported for S3 File Gateways
Sets the password for the guest user smbguest. The smbguest\n user is the user when the authentication method for the file share is set to\n GuestAccess. This operation only supported for S3 File Gateways
Storage Gateway is the service that connects an on-premises software appliance with\n cloud-based storage to provide seamless and secure integration between an\n organization's on-premises IT environment and the Amazon Web Services storage infrastructure. The\n service enables you to securely upload data to the Cloud for cost effective backup and\n rapid disaster recovery.
\n\nUse the following links to get started using the Storage Gateway Service\n API Reference:
\n\n\n Storage Gateway required request headers: Describes the required\n headers that you must send with every POST request to Storage Gateway.
\n\n Signing requests: Storage Gateway requires that you authenticate\n every request you send; this topic describes how sign such a request.
\n\n Error responses: Provides reference information about Storage Gateway\n errors.
\n\n Operations in \n Storage Gateway: Contains detailed descriptions of all Storage Gateway\n operations, their request parameters, response elements, possible errors, and\n examples of requests and responses.
\n\n Storage Gateway\n endpoints and quotas: Provides a list of each Region and the endpoints\n available for use with Storage Gateway.
\nStorage Gateway resource IDs are in uppercase. When you use these resource IDs\n with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your\n resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the\n ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with\n the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the\n EC2 API might not behave as expected.
IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes\n are changing to a longer format. Starting in December 2016, all new volumes and\n snapshots will be created with a 17-character string. Starting in April 2016, you will\n be able to use these longer IDs so you can test your systems with the new format. For\n more information, see Longer EC2 and\n EBS resource IDs.
\n\nFor example, a volume Amazon Resource Name (ARN) with the longer volume ID format\n looks like the following:
\n\n\n arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.
A snapshot ID with the longer ID format looks like the following:\n snap-78e226633445566ee.
For more information, see Announcement:\n Heads-up – Longer Storage Gateway volume and snapshot IDs coming in\n 2016.
\nStorage Gateway is the service that connects an on-premises software appliance\n with cloud-based storage to provide seamless and secure integration between an\n organization's on-premises IT environment and the Amazon Web Services storage\n infrastructure. The service enables you to securely upload data to the Amazon Web Services Cloud for cost effective backup and rapid disaster recovery.
\n\nUse the following links to get started using the Storage Gateway\n Service API Reference:
\n\n\n Storage Gateway required request headers: Describes the required\n headers that you must send with every POST request to Storage Gateway.
\n\n Signing requests: Storage Gateway requires that you authenticate\n every request you send; this topic describes how sign such a request.
\n\n Error responses: Provides reference information about Storage Gateway errors.
\n\n Operations in Storage Gateway: Contains detailed descriptions of all Storage Gateway operations, their request parameters, response elements, possible errors, and\n examples of requests and responses.
\n\n Storage Gateway\n endpoints and quotas: Provides a list of each Amazon Web Services Region\n and the endpoints available for use with Storage Gateway.
\nStorage Gateway resource IDs are in uppercase. When you use these resource IDs\n with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change\n your resource ID to lowercase to use it with the EC2 API. For example, in Storage\n Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use\n this ID with the EC2 API, you must change it to vol-aa22bb012345daf670.\n Otherwise, the EC2 API might not behave as expected.
IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway\n volumes are changing to a longer format. Starting in December 2016, all new volumes and\n snapshots will be created with a 17-character string. Starting in April 2016, you will\n be able to use these longer IDs so you can test your systems with the new format. For\n more information, see Longer EC2 and\n EBS resource IDs.
\n\nFor example, a volume Amazon Resource Name (ARN) with the longer volume ID format\n looks like the following:
\n\n\n arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.
A snapshot ID with the longer ID format looks like the following:\n snap-78e226633445566ee.
For more information, see Announcement:\n Heads-up – Longer Storage Gateway volume and snapshot IDs coming in\n 2016.
\nThe Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and Region.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and Amazon Web Services Region.
" } }, "PoolId": { @@ -8267,7 +8331,7 @@ } ], "traits": { - "smithy.api#documentation": "\n Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do \n not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect.\n Use this to initiate or update a gateway's bandwidth rate limit schedule.\n This operation is supported in the volume and tape gateway types.\n
" + "smithy.api#documentation": "Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways\n do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in\n effect. Use this to initiate or update a gateway's bandwidth rate limit schedule. This\n operation is supported in the volume and tape gateway types.
" } }, "com.amazonaws.storagegateway#UpdateBandwidthRateLimitScheduleInput": { @@ -8282,7 +8346,7 @@ "BandwidthRateLimitIntervals": { "target": "com.amazonaws.storagegateway#BandwidthRateLimitIntervals", "traits": { - "smithy.api#documentation": "\n An array containing bandwidth rate limit schedule intervals for a gateway. \n When no bandwidth rate limit intervals have been scheduled, the array is empty.\n
", + "smithy.api#documentation": "An array containing bandwidth rate limit schedule intervals for a gateway. When no\n bandwidth rate limit intervals have been scheduled, the array is empty.
", "smithy.api#required": {} } } @@ -8388,7 +8452,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a file system association. This operation is only supported in the FSx File Gateways.
" + "smithy.api#documentation": "Updates a file system association. This operation is only supported in the FSx File\n Gateways.
" } }, "com.amazonaws.storagegateway#UpdateFileSystemAssociationInput": { @@ -8397,14 +8461,14 @@ "FileSystemAssociationARN": { "target": "com.amazonaws.storagegateway#FileSystemAssociationARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the file system association that you want to update.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the file system association that you want to\n update.
", "smithy.api#required": {} } }, "UserName": { "target": "com.amazonaws.storagegateway#DomainUserName", "traits": { - "smithy.api#documentation": "The user name of the user credential that has permission to access the root share D$ of\n the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin\n user group.
" + "smithy.api#documentation": "The user name of the user credential that has permission to access the root share D$ of\n the Amazon FSx file system. The user account must belong to the Amazon FSx\n delegated admin user group.
" } }, "Password": { @@ -8637,7 +8701,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a Network File System (NFS) file share. This operation is only supported in S3 File Gateways.
\n\nTo leave a file share field unchanged, set the corresponding input field to\n null.
\nUpdates the following file share settings:
\n\nDefault storage class for your S3 bucket
\nMetadata defaults for your S3 bucket
\nAllowed NFS clients for your file share
\nSquash settings
\nWrite status of your file share
\nUpdates a Network File System (NFS) file share. This operation is only supported in S3\n File Gateways.
\n\nTo leave a file share field unchanged, set the corresponding input field to\n null.
\nUpdates the following file share settings:
\n\nDefault storage class for your S3 bucket
\nMetadata defaults for your S3 bucket
\nAllowed NFS clients for your file share
\nSquash settings
\nWrite status of your file share
\nSet to true to use Amazon S3 server-side encryption with your own KMS\n key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false\n
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
The list of clients that are allowed to access the S3 File Gateway. The list must contain\n either valid IP addresses or valid CIDR blocks.
" + "smithy.api#documentation": "The list of clients that are allowed to access the S3 File Gateway. The list must\n contain either valid IP addresses or valid CIDR blocks.
" } }, "Squash": { @@ -8713,13 +8777,13 @@ "FileShareName": { "target": "com.amazonaws.storagegateway#FileShareName", "traits": { - "smithy.api#documentation": "The name of the file share. Optional.
\n\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN.
The name of the file share. Optional.
\n\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.
specifies refresh cache information for the file share.
" + "smithy.api#documentation": "Specifies refresh cache information for the file share.
" } }, "NotificationPolicy": { @@ -8727,6 +8791,12 @@ "traits": { "smithy.api#documentation": "The notification policy of the file share. SettlingTimeInSeconds controls\n the number of seconds to wait after the last point in time a client wrote to a file before\n generating an ObjectUploaded notification. Because clients can make many small\n writes to files, it's best to set this parameter for as long as possible to avoid\n generating multiple notifications for the same file in a small time period.
\n SettlingTimeInSeconds has no effect on the timing of the object\n uploading to Amazon S3, only the timing of the notification.
The following example sets NotificationPolicy on with\n SettlingTimeInSeconds set to 60.
\n {\\\"Upload\\\": {\\\"SettlingTimeInSeconds\\\": 60}}\n
The following example sets NotificationPolicy off.
\n {}\n
The Amazon Resource Name (ARN) of the storage used for audit logs.
" + } } }, "traits": { @@ -8764,7 +8834,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a Server Message Block (SMB) file share. This operation is only supported for\n S3 File Gateways.
\n\nTo leave a file share field unchanged, set the corresponding input field to\n null.
\nFile gateways require Security Token Service (STS) to be activated to enable\n you to create a file share. Make sure that STS is activated in the Region you\n are creating your file gateway in. If STS is not activated in this Region,\n activate it. For information about how to activate STS, see Activating and\n deactivating STS in an Region in the Identity and Access Management\n User Guide.
\n\nFile gateways don't support creating hard or symbolic links on a file\n share.
\nUpdates a Server Message Block (SMB) file share. This operation is only supported for S3\n File Gateways.
\n\nTo leave a file share field unchanged, set the corresponding input field to\n null.
\nFile gateways require Security Token Service (Amazon Web Services STS) to be\n activated to enable you to create a file share. Make sure that Amazon Web Services STS\n is activated in the Amazon Web Services Region you are creating your file gateway in. If\n Amazon Web Services STS is not activated in this Amazon Web Services Region, activate\n it. For information about how to activate Amazon Web Services STS, see Activating and\n deactivating Amazon Web Services STS in an Amazon Web Services Region in the\n Identity and Access Management User Guide.
\n\nFile gateways don't support creating hard or symbolic links on a file\n share.
\nSet to true to use Amazon S3 server-side encryption with your own KMS\n key, or false to use a key managed by Amazon S3. Optional.
Valid Values: true | false\n
Set to true to use Amazon S3 server-side encryption with your own\n KMS key, or false to use a key managed by Amazon S3.\n Optional.
Valid Values: true | false\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted is true. Optional.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This\n value can only be set when KMSEncrypted is true. Optional.
The default storage class for objects put into an Amazon S3 bucket by the S3 File Gateway.\n The default value is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
The default storage class for objects put into an Amazon S3 bucket by the S3\n File Gateway. The default value is S3_INTELLIGENT_TIERING. Optional.
Valid Values: S3_STANDARD | S3_INTELLIGENT_TIERING |\n S3_STANDARD_IA | S3_ONEZONE_IA\n
The case of an object name in an Amazon S3 bucket. For ClientSpecified, the\n client determines the case sensitivity. For CaseSensitive, the gateway\n determines the case sensitivity. The default value is ClientSpecified.
The case of an object name in an Amazon S3 bucket. For\n ClientSpecified, the client determines the case sensitivity. For\n CaseSensitive, the gateway determines the case sensitivity. The default\n value is ClientSpecified.
The name of the file share. Optional.
\n\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN.
The name of the file share. Optional.
\n\n\n FileShareName must be set if an S3 prefix name is set in\n LocationARN, or if an access point or access point alias is used.
Specifies whether opportunistic locking is enabled for the SMB file share.
\nEnabling opportunistic locking on case-sensitive shares is not recommended for workloads that involve \n access to files with the same name in different case.
\nValid Values: true | false\n
Specifies whether opportunistic locking is enabled for the SMB file share.
\nEnabling opportunistic locking on case-sensitive shares is not recommended for\n workloads that involve access to files with the same name in different case.
\nValid Values: true | false\n
Updates the list of Active Directory users and groups that have special permissions for\n SMB file shares on the gateway.
" + } + }, + "com.amazonaws.storagegateway#UpdateSMBLocalGroupsInput": { + "type": "structure", + "members": { + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", + "traits": { + "smithy.api#required": {} + } + }, + "SMBLocalGroups": { + "target": "com.amazonaws.storagegateway#SMBLocalGroups", + "traits": { + "smithy.api#documentation": "A list of Active Directory users and groups that you want to grant special permissions\n for SMB file shares on the gateway.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.storagegateway#UpdateSMBLocalGroupsOutput": { + "type": "structure", + "members": { + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" + } + } + }, "com.amazonaws.storagegateway#UpdateSMBSecurityStrategy": { "type": "operation", "input": { @@ -8982,7 +9098,7 @@ "SMBSecurityStrategy": { "target": "com.amazonaws.storagegateway#SMBSecurityStrategy", "traits": { - "smithy.api#documentation": "Specifies the type of security strategy.
\n\nClientSpecified: if you use this option, requests are established based on what is\n negotiated by the client. This option is recommended when you want to maximize\n compatibility across different clients in your environment. Supported only in S3 File Gateway.
\n\nMandatorySigning: if you use this option, file gateway only allows connections from\n SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on\n Microsoft Windows Vista, Windows Server 2008 or newer.
\n\nMandatoryEncryption: if you use this option, file gateway only allows connections from\n SMBv3 clients that have encryption enabled. This option is highly recommended for\n environments that handle sensitive data. This option works with SMB clients on Microsoft\n Windows 8, Windows Server 2012 or newer.
", + "smithy.api#documentation": "Specifies the type of security strategy.
\n\nClientSpecified: if you use this option, requests are established based on what is\n negotiated by the client. This option is recommended when you want to maximize\n compatibility across different clients in your environment. Supported only in S3 File\n Gateway.
\n\nMandatorySigning: if you use this option, file gateway only allows connections from\n SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on\n Microsoft Windows Vista, Windows Server 2008 or newer.
\n\nMandatoryEncryption: if you use this option, file gateway only allows connections from\n SMBv3 clients that have encryption enabled. This option is highly recommended for\n environments that handle sensitive data. This option works with SMB clients on Microsoft\n Windows 8, Windows Server 2012 or newer.
", "smithy.api#required": {} } } diff --git a/codegen/sdk/aws-models/transcribestreaming.2017-10-26.json b/codegen/sdk/aws-models/transcribestreaming.2017-10-26.json new file mode 100644 index 00000000000..15e13dbc6f6 --- /dev/null +++ b/codegen/sdk/aws-models/transcribestreaming.2017-10-26.json @@ -0,0 +1,1474 @@ +{ + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.transcribestreaming#Alternative": { + "type": "structure", + "members": { + "Transcript": { + "target": "com.amazonaws.transcribestreaming#String", + "traits": { + "smithy.api#documentation": "The text that was transcribed from the audio.
" + } + }, + "Items": { + "target": "com.amazonaws.transcribestreaming#ItemList", + "traits": { + "smithy.api#documentation": "One or more alternative interpretations of the input audio.
" + } + }, + "Entities": { + "target": "com.amazonaws.transcribestreaming#EntityList", + "traits": { + "smithy.api#documentation": "Contains the entities identified as personally identifiable information (PII) in the transcription output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of possible transcriptions for the audio.
" + } + }, + "com.amazonaws.transcribestreaming#AlternativeList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribestreaming#Alternative" + } + }, + "com.amazonaws.transcribestreaming#AudioChunk": { + "type": "blob" + }, + "com.amazonaws.transcribestreaming#AudioEvent": { + "type": "structure", + "members": { + "AudioChunk": { + "target": "com.amazonaws.transcribestreaming#AudioChunk", + "traits": { + "smithy.api#documentation": "An audio blob that contains the next part of the audio that you want to transcribe. The\n maximum audio chunk size is 32 KB.
", + "smithy.api#eventPayload": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Provides a wrapper for the audio chunks that you are sending.
\nFor information on audio encoding in Amazon Transcribe, see \n Speech input. For information\n on audio encoding formats in Amazon Transcribe Medical, see \n Speech input.
" + } + }, + "com.amazonaws.transcribestreaming#AudioStream": { + "type": "union", + "members": { + "AudioEvent": { + "target": "com.amazonaws.transcribestreaming#AudioEvent", + "traits": { + "smithy.api#documentation": "A blob of audio from your application. You audio stream consists of one or more audio\n events.
\nFor information on audio encoding formats in Amazon Transcribe, see Speech input. For\n information on audio encoding formats in Amazon Transcribe Medical, see Speech input.
\nFor more information on stream encoding in Amazon Transcribe, see Event stream encoding. For\n information on stream encoding in Amazon Transcribe Medical, see Event stream encoding.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the audio stream from your application to Amazon Transcribe.
", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.transcribestreaming#BadRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.transcribestreaming#String" + } + }, + "traits": { + "smithy.api#documentation": "One or more arguments to the StartStreamTranscription or\n StartMedicalStreamTranscription operation was invalid. For example,\n MediaEncoding was not set to a valid encoding, or LanguageCode was\n not set to a valid code. Check the parameters and try your request again.
A new stream started with the same session ID. The current stream has been\n terminated.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.transcribestreaming#ContentIdentificationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PII", + "name": "PII" + } + ] + } + }, + "com.amazonaws.transcribestreaming#ContentRedactionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PII", + "name": "PII" + } + ] + } + }, + "com.amazonaws.transcribestreaming#Double": { + "type": "double" + }, + "com.amazonaws.transcribestreaming#Entity": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#documentation": "The start time of speech that was identified as PII.
" + } + }, + "EndTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#documentation": "The end time of speech that was identified as PII.
" + } + }, + "Category": { + "target": "com.amazonaws.transcribestreaming#String", + "traits": { + "smithy.api#documentation": "The category of of information identified in this entity; for example, PII.
" + } + }, + "Type": { + "target": "com.amazonaws.transcribestreaming#String", + "traits": { + "smithy.api#documentation": "The type of PII identified in this entity; for example, name or credit card number.
" + } + }, + "Content": { + "target": "com.amazonaws.transcribestreaming#String", + "traits": { + "smithy.api#documentation": "The words in the transcription output that have been identified as a PII entity.
" + } + }, + "Confidence": { + "target": "com.amazonaws.transcribestreaming#Confidence", + "traits": { + "smithy.api#documentation": "A value between zero and one that Amazon Transcribe assigns to PII identified in the source audio. Larger values indicate a higher confidence in PII identification.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The entity identified as personally identifiable information (PII).
" + } + }, + "com.amazonaws.transcribestreaming#EntityList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribestreaming#Entity" + } + }, + "com.amazonaws.transcribestreaming#InternalFailureException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.transcribestreaming#String" + } + }, + "traits": { + "smithy.api#documentation": "A problem occurred while processing the audio. Amazon Transcribe or Amazon Transcribe Medical terminated processing. Try\n your request again.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.transcribestreaming#Item": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#documentation": "The offset from the beginning of the audio stream to the beginning of the audio that\n resulted in the item.
" + } + }, + "EndTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#documentation": "The offset from the beginning of the audio stream to the end of the audio that resulted in\n the item.
" + } + }, + "Type": { + "target": "com.amazonaws.transcribestreaming#ItemType", + "traits": { + "smithy.api#documentation": "The type of the item. PRONUNCIATION indicates that the item is a word that\n was recognized in the input audio. PUNCTUATION indicates that the item was\n interpreted as a pause in the input audio.
The word or punctuation that was recognized in the input audio.
" + } + }, + "VocabularyFilterMatch": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether a word in the item matches a word in the vocabulary filter you've chosen\n for your real-time stream. If true then a word in the item matches your\n vocabulary filter.
If speaker identification is enabled, shows the speakers identified in the real-time\n stream.
" + } + }, + "Confidence": { + "target": "com.amazonaws.transcribestreaming#Confidence", + "traits": { + "smithy.api#documentation": "A value between 0 and 1 for an item that is a confidence score that Amazon Transcribe assigns to each\n word or phrase that it transcribes.
" + } + }, + "Stable": { + "target": "com.amazonaws.transcribestreaming#Stable", + "traits": { + "smithy.api#documentation": "If partial result stabilization has been enabled, indicates whether the word or phrase in\n the item is stable. If Stable is true, the result is stable.
A word, phrase, or punctuation mark that is transcribed from the input audio.
" + } + }, + "com.amazonaws.transcribestreaming#ItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribestreaming#Item" + } + }, + "com.amazonaws.transcribestreaming#ItemType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "pronunciation", + "name": "PRONUNCIATION" + }, + { + "value": "punctuation", + "name": "PUNCTUATION" + } + ] + } + }, + "com.amazonaws.transcribestreaming#LanguageCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "en-US", + "name": "EN_US" + }, + { + "value": "en-GB", + "name": "EN_GB" + }, + { + "value": "es-US", + "name": "ES_US" + }, + { + "value": "fr-CA", + "name": "FR_CA" + }, + { + "value": "fr-FR", + "name": "FR_FR" + }, + { + "value": "en-AU", + "name": "EN_AU" + }, + { + "value": "it-IT", + "name": "IT_IT" + }, + { + "value": "de-DE", + "name": "DE_DE" + }, + { + "value": "pt-BR", + "name": "PT_BR" + }, + { + "value": "ja-JP", + "name": "JA_JP" + }, + { + "value": "ko-KR", + "name": "KO_KR" + }, + { + "value": "zh-CN", + "name": "ZH_CN" + } + ] + } + }, + "com.amazonaws.transcribestreaming#LimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.transcribestreaming#String" + } + }, + "traits": { + "smithy.api#documentation": "You have exceeded the maximum number of concurrent transcription streams, are starting\n transcription streams too quickly, or the maximum audio length of 4 hours. Wait until a stream\n has finished processing, or break your audio stream into smaller chunks and try your request\n again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.transcribestreaming#MediaEncoding": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "pcm", + "name": "PCM" + }, + { + "value": "ogg-opus", + "name": "OGG_OPUS" + }, + { + "value": "flac", + "name": "FLAC" + } + ] + } + }, + "com.amazonaws.transcribestreaming#MediaSampleRateHertz": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 8000, + "max": 48000 + } + } + }, + "com.amazonaws.transcribestreaming#MedicalAlternative": { + "type": "structure", + "members": { + "Transcript": { + "target": "com.amazonaws.transcribestreaming#String", + "traits": { + "smithy.api#documentation": "The text that was transcribed from the audio.
" + } + }, + "Items": { + "target": "com.amazonaws.transcribestreaming#MedicalItemList", + "traits": { + "smithy.api#documentation": "A list of objects that contains words and punctuation marks that represents one or\n more interpretations of the input audio.
" + } + }, + "Entities": { + "target": "com.amazonaws.transcribestreaming#MedicalEntityList", + "traits": { + "smithy.api#documentation": "Contains the medical entities identified as personal health information in the transcription output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of possible transcriptions for the audio.
" + } + }, + "com.amazonaws.transcribestreaming#MedicalAlternativeList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribestreaming#MedicalAlternative" + } + }, + "com.amazonaws.transcribestreaming#MedicalContentIdentificationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PHI", + "name": "PHI" + } + ] + } + }, + "com.amazonaws.transcribestreaming#MedicalEntity": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#documentation": "The start time of the speech that was identified as a medical entity.
" + } + }, + "EndTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#documentation": "The end time of the speech that was identified as a medical entity.
" + } + }, + "Category": { + "target": "com.amazonaws.transcribestreaming#String", + "traits": { + "smithy.api#documentation": "The type of personal health information of the medical entity.
" + } + }, + "Content": { + "target": "com.amazonaws.transcribestreaming#String", + "traits": { + "smithy.api#documentation": "The word or words in the transcription output that have been identified as a\n medical entity.
" + } + }, + "Confidence": { + "target": "com.amazonaws.transcribestreaming#Confidence", + "traits": { + "smithy.api#documentation": "A value between zero and one that Amazon Transcribe Medical assigned to the personal health information\n that it identified in the source audio. Larger values indicate that Amazon Transcribe Medical has higher\n confidence in the personal health information that it identified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The medical entity identified as personal health information.
" + } + }, + "com.amazonaws.transcribestreaming#MedicalEntityList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribestreaming#MedicalEntity" + } + }, + "com.amazonaws.transcribestreaming#MedicalItem": { + "type": "structure", + "members": { + "StartTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#documentation": "The number of seconds into an audio stream that indicates the creation time of an\n item.
" + } + }, + "EndTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#documentation": "The number of seconds into an audio stream that indicates the creation time of an\n item.
" + } + }, + "Type": { + "target": "com.amazonaws.transcribestreaming#ItemType", + "traits": { + "smithy.api#documentation": "The type of the item. PRONUNCIATION indicates that the item is a word\n that was recognized in the input audio. PUNCTUATION indicates that the item\n was interpreted as a pause in the input audio, such as a period to indicate the end of a\n sentence.
The word or punctuation mark that was recognized in the input audio.
" + } + }, + "Confidence": { + "target": "com.amazonaws.transcribestreaming#Confidence", + "traits": { + "smithy.api#documentation": "A value between 0 and 1 for an item that is a confidence score that Amazon Transcribe Medical assigns to\n each word that it transcribes.
" + } + }, + "Speaker": { + "target": "com.amazonaws.transcribestreaming#String", + "traits": { + "smithy.api#documentation": "If speaker identification is enabled, shows the integer values that correspond to the\n different speakers identified in the stream. For example, if the value of\n Speaker in the stream is either a 0 or a 1,\n that indicates that Amazon Transcribe Medical has identified two speakers in the stream. The value of\n 0 corresponds to one speaker and the value of 1\n corresponds to the other speaker.
A word, phrase, or punctuation mark that is transcribed from the input audio.
" + } + }, + "com.amazonaws.transcribestreaming#MedicalItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribestreaming#MedicalItem" + } + }, + "com.amazonaws.transcribestreaming#MedicalResult": { + "type": "structure", + "members": { + "ResultId": { + "target": "com.amazonaws.transcribestreaming#String", + "traits": { + "smithy.api#documentation": "A unique identifier for the result.
" + } + }, + "StartTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#documentation": "The time, in seconds, from the beginning of the audio stream to the beginning of the\n result.
" + } + }, + "EndTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#documentation": "The time, in seconds, from the beginning of the audio stream to the end of the\n result.
" + } + }, + "IsPartial": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#documentation": "Amazon Transcribe Medical divides the incoming audio stream into segments at natural points in the audio.\n Transcription results are returned based on these segments.
\nThe IsPartial field is true to indicate that Amazon Transcribe Medical has\n additional transcription data to send. The IsPartial field is\n false to indicate that this is the last transcription result for the\n segment.
A list of possible transcriptions of the audio. Each alternative typically contains\n one Item that contains the result of the transcription.
When channel identification is enabled, Amazon Transcribe Medical transcribes the speech from each audio\n channel separately.
\nYou can use ChannelId to retrieve the transcription results for a single\n channel in your audio stream.
The results of transcribing a portion of the input audio stream.
" + } + }, + "com.amazonaws.transcribestreaming#MedicalResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribestreaming#MedicalResult" + } + }, + "com.amazonaws.transcribestreaming#MedicalTranscript": { + "type": "structure", + "members": { + "Results": { + "target": "com.amazonaws.transcribestreaming#MedicalResultList", + "traits": { + "smithy.api#documentation": "\n MedicalResult objects that contain the results of transcribing a\n portion of the input audio stream. The array can be empty.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The medical transcript in a MedicalTranscriptEvent.
" + } + }, + "com.amazonaws.transcribestreaming#MedicalTranscriptEvent": { + "type": "structure", + "members": { + "Transcript": { + "target": "com.amazonaws.transcribestreaming#MedicalTranscript", + "traits": { + "smithy.api#documentation": "The transcription of the audio stream. The transcription is composed of all of the\n items in the results list.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a set of transcription results from the server to the client. It contains\n one or more segments of the transcription.
" + } + }, + "com.amazonaws.transcribestreaming#MedicalTranscriptResultStream": { + "type": "union", + "members": { + "TranscriptEvent": { + "target": "com.amazonaws.transcribestreaming#MedicalTranscriptEvent", + "traits": { + "smithy.api#documentation": "A portion of the transcription of the audio stream. Events are sent periodically from\n Amazon Transcribe Medical to your application. The event can be a partial transcription of a section of the\n audio stream, or it can be the entire transcription of that portion of the audio\n stream.
" + } + }, + "BadRequestException": { + "target": "com.amazonaws.transcribestreaming#BadRequestException" + }, + "LimitExceededException": { + "target": "com.amazonaws.transcribestreaming#LimitExceededException" + }, + "InternalFailureException": { + "target": "com.amazonaws.transcribestreaming#InternalFailureException" + }, + "ConflictException": { + "target": "com.amazonaws.transcribestreaming#ConflictException" + }, + "ServiceUnavailableException": { + "target": "com.amazonaws.transcribestreaming#ServiceUnavailableException" + } + }, + "traits": { + "smithy.api#documentation": "Represents the transcription result stream from Amazon Transcribe Medical to your application.
", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.transcribestreaming#ModelName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" + } + }, + "com.amazonaws.transcribestreaming#NumberOfChannels": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 2 + } + } + }, + "com.amazonaws.transcribestreaming#PartialResultsStability": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "high", + "name": "HIGH" + }, + { + "value": "medium", + "name": "MEDIUM" + }, + { + "value": "low", + "name": "LOW" + } + ] + } + }, + "com.amazonaws.transcribestreaming#PiiEntityTypes": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 300 + }, + "smithy.api#pattern": "^[A-Z_, ]+$" + } + }, + "com.amazonaws.transcribestreaming#RequestId": { + "type": "string" + }, + "com.amazonaws.transcribestreaming#Result": { + "type": "structure", + "members": { + "ResultId": { + "target": "com.amazonaws.transcribestreaming#String", + "traits": { + "smithy.api#documentation": "A unique identifier for the result.
" + } + }, + "StartTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#documentation": "The offset in seconds from the beginning of the audio stream to the beginning of the\n result.
" + } + }, + "EndTime": { + "target": "com.amazonaws.transcribestreaming#Double", + "traits": { + "smithy.api#documentation": "The offset in seconds from the beginning of the audio stream to the end of the\n result.
" + } + }, + "IsPartial": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#documentation": "Amazon Transcribe divides the incoming audio stream into segments at natural points in the audio.\n Transcription results are returned based on these segments.
\nThe IsPartial field is true to indicate that Amazon Transcribe has\n additional transcription data to send, false to indicate that this is the last\n transcription result for the segment.
A list of possible transcriptions for the audio. Each alternative typically contains one\n item that contains the result of the transcription.
When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio\n channel separately.
\nYou can use ChannelId to retrieve the transcription results for a single\n channel in your audio stream.
The result of transcribing a portion of the input audio stream.
" + } + }, + "com.amazonaws.transcribestreaming#ResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.transcribestreaming#Result" + } + }, + "com.amazonaws.transcribestreaming#ServiceUnavailableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.transcribestreaming#String" + } + }, + "traits": { + "smithy.api#documentation": "Service is currently unavailable. Try your request later.
", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.transcribestreaming#SessionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + } + }, + "com.amazonaws.transcribestreaming#Specialty": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PRIMARYCARE", + "name": "PRIMARYCARE" + }, + { + "value": "CARDIOLOGY", + "name": "CARDIOLOGY" + }, + { + "value": "NEUROLOGY", + "name": "NEUROLOGY" + }, + { + "value": "ONCOLOGY", + "name": "ONCOLOGY" + }, + { + "value": "RADIOLOGY", + "name": "RADIOLOGY" + }, + { + "value": "UROLOGY", + "name": "UROLOGY" + } + ] + } + }, + "com.amazonaws.transcribestreaming#Stable": { + "type": "boolean", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.transcribestreaming#StartMedicalStreamTranscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.transcribestreaming#StartMedicalStreamTranscriptionRequest" + }, + "output": { + "target": "com.amazonaws.transcribestreaming#StartMedicalStreamTranscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.transcribestreaming#BadRequestException" + }, + { + "target": "com.amazonaws.transcribestreaming#ConflictException" + }, + { + "target": "com.amazonaws.transcribestreaming#InternalFailureException" + }, + { + "target": "com.amazonaws.transcribestreaming#LimitExceededException" + }, + { + "target": "com.amazonaws.transcribestreaming#ServiceUnavailableException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe Medical and the\n transcription results are streamed to your application.
", + "smithy.api#http": { + "method": "POST", + "uri": "/medical-stream-transcription", + "code": 200 + } + } + }, + "com.amazonaws.transcribestreaming#StartMedicalStreamTranscriptionRequest": { + "type": "structure", + "members": { + "LanguageCode": { + "target": "com.amazonaws.transcribestreaming#LanguageCode", + "traits": { + "smithy.api#documentation": "Indicates the source language used in the input audio stream. For Amazon Transcribe Medical, this is US\n English (en-US).
", + "smithy.api#httpHeader": "x-amzn-transcribe-language-code", + "smithy.api#required": {} + } + }, + "MediaSampleRateHertz": { + "target": "com.amazonaws.transcribestreaming#MediaSampleRateHertz", + "traits": { + "smithy.api#documentation": "The sample rate of the input audio in Hertz.
", + "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate", + "smithy.api#required": {} + } + }, + "MediaEncoding": { + "target": "com.amazonaws.transcribestreaming#MediaEncoding", + "traits": { + "smithy.api#documentation": "The encoding used for the input audio.
", + "smithy.api#httpHeader": "x-amzn-transcribe-media-encoding", + "smithy.api#required": {} + } + }, + "VocabularyName": { + "target": "com.amazonaws.transcribestreaming#VocabularyName", + "traits": { + "smithy.api#documentation": "The name of the medical custom vocabulary to use when processing the real-time\n stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-name" + } + }, + "Specialty": { + "target": "com.amazonaws.transcribestreaming#Specialty", + "traits": { + "smithy.api#documentation": "The medical specialty of the clinician or provider.
", + "smithy.api#httpHeader": "x-amzn-transcribe-specialty", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.transcribestreaming#Type", + "traits": { + "smithy.api#documentation": "The type of input audio. Choose DICTATION for a provider dictating\n patient notes. Choose CONVERSATION for a dialogue between a patient and one\n or more medical professionanls.
When true, enables speaker identification in your real-time\n stream.
Optional. An identifier for the transcription session. If you don't provide a session\n ID, Amazon Transcribe generates one for you and returns it in the response.
", + "smithy.api#httpHeader": "x-amzn-transcribe-session-id" + } + }, + "AudioStream": { + "target": "com.amazonaws.transcribestreaming#AudioStream", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "EnableChannelIdentification": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#documentation": "When true, instructs Amazon Transcribe Medical to process each audio channel separately and\n then merge the transcription output of each channel into a single transcription.
Amazon Transcribe Medical also produces a transcription of each item. An item includes the start time,\n end time, and any alternative transcriptions.
\nYou can't set both ShowSpeakerLabel and\n EnableChannelIdentification in the same request. If you set both, your\n request returns a BadRequestException.
The number of channels that are in your audio stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-number-of-channels" + } + }, + "ContentIdentificationType": { + "target": "com.amazonaws.transcribestreaming#MedicalContentIdentificationType", + "traits": { + "smithy.api#documentation": "Set this field to PHI to identify personal health information in the\n transcription output.
An identifier for the streaming transcription.
", + "smithy.api#httpHeader": "x-amzn-request-id" + } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribestreaming#LanguageCode", + "traits": { + "smithy.api#documentation": "The language code for the response transcript. For Amazon Transcribe Medical, this is US English\n (en-US).
", + "smithy.api#httpHeader": "x-amzn-transcribe-language-code" + } + }, + "MediaSampleRateHertz": { + "target": "com.amazonaws.transcribestreaming#MediaSampleRateHertz", + "traits": { + "smithy.api#documentation": "The sample rate of the input audio in Hertz.
", + "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate" + } + }, + "MediaEncoding": { + "target": "com.amazonaws.transcribestreaming#MediaEncoding", + "traits": { + "smithy.api#documentation": "The encoding used for the input audio stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-media-encoding" + } + }, + "VocabularyName": { + "target": "com.amazonaws.transcribestreaming#VocabularyName", + "traits": { + "smithy.api#documentation": "The name of the vocabulary used when processing the stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-name" + } + }, + "Specialty": { + "target": "com.amazonaws.transcribestreaming#Specialty", + "traits": { + "smithy.api#documentation": "The specialty in the medical domain.
", + "smithy.api#httpHeader": "x-amzn-transcribe-specialty" + } + }, + "Type": { + "target": "com.amazonaws.transcribestreaming#Type", + "traits": { + "smithy.api#documentation": "The type of audio that was transcribed.
", + "smithy.api#httpHeader": "x-amzn-transcribe-type" + } + }, + "ShowSpeakerLabel": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#documentation": "Shows whether speaker identification was enabled in the stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-show-speaker-label" + } + }, + "SessionId": { + "target": "com.amazonaws.transcribestreaming#SessionId", + "traits": { + "smithy.api#documentation": "Optional. An identifier for the transcription session. If you don't provide a session\n ID, Amazon Transcribe generates one for you and returns it in the response.
", + "smithy.api#httpHeader": "x-amzn-transcribe-session-id" + } + }, + "TranscriptResultStream": { + "target": "com.amazonaws.transcribestreaming#MedicalTranscriptResultStream", + "traits": { + "smithy.api#documentation": "Represents the stream of transcription events from Amazon Transcribe Medical to your application.
", + "smithy.api#httpPayload": {} + } + }, + "EnableChannelIdentification": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#documentation": "Shows whether channel identification has been enabled in the stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-enable-channel-identification" + } + }, + "NumberOfChannels": { + "target": "com.amazonaws.transcribestreaming#NumberOfChannels", + "traits": { + "smithy.api#documentation": "The number of channels identified in the stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-number-of-channels" + } + }, + "ContentIdentificationType": { + "target": "com.amazonaws.transcribestreaming#MedicalContentIdentificationType", + "traits": { + "smithy.api#documentation": "If the value is PHI, indicates that you've configured your stream to\n identify personal health information.
Starts a bidirectional HTTP/2 stream where audio is streamed to Amazon Transcribe and the transcription\n results are streamed to your application.
\nThe following are encoded as HTTP/2 headers:
\nx-amzn-transcribe-language-code
\nx-amzn-transcribe-media-encoding
\nx-amzn-transcribe-sample-rate
\nx-amzn-transcribe-session-id
\nSee the SDK for Go API Reference for more detail.
", + "smithy.api#http": { + "method": "POST", + "uri": "/stream-transcription", + "code": 200 + } + } + }, + "com.amazonaws.transcribestreaming#StartStreamTranscriptionRequest": { + "type": "structure", + "members": { + "LanguageCode": { + "target": "com.amazonaws.transcribestreaming#LanguageCode", + "traits": { + "smithy.api#documentation": "Indicates the source language used in the input audio stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-language-code", + "smithy.api#required": {} + } + }, + "MediaSampleRateHertz": { + "target": "com.amazonaws.transcribestreaming#MediaSampleRateHertz", + "traits": { + "smithy.api#documentation": "The sample rate, in Hertz, of the input audio. We suggest that you use 8,000 Hz for low\n quality audio and 16,000 Hz for high quality audio.
", + "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate", + "smithy.api#required": {} + } + }, + "MediaEncoding": { + "target": "com.amazonaws.transcribestreaming#MediaEncoding", + "traits": { + "smithy.api#documentation": "The encoding used for the input audio.
", + "smithy.api#httpHeader": "x-amzn-transcribe-media-encoding", + "smithy.api#required": {} + } + }, + "VocabularyName": { + "target": "com.amazonaws.transcribestreaming#VocabularyName", + "traits": { + "smithy.api#documentation": "The name of the vocabulary to use when processing the transcription job.
", + "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-name" + } + }, + "SessionId": { + "target": "com.amazonaws.transcribestreaming#SessionId", + "traits": { + "smithy.api#documentation": "A identifier for the transcription session. Use this parameter when you want to retry a\n session. If you don't provide a session ID, Amazon Transcribe will generate one for you and return it in\n the response.
", + "smithy.api#httpHeader": "x-amzn-transcribe-session-id" + } + }, + "AudioStream": { + "target": "com.amazonaws.transcribestreaming#AudioStream", + "traits": { + "smithy.api#documentation": "PCM-encoded stream of audio blobs. The audio stream is encoded as an HTTP/2 data\n frame.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "VocabularyFilterName": { + "target": "com.amazonaws.transcribestreaming#VocabularyFilterName", + "traits": { + "smithy.api#documentation": "The name of the vocabulary filter you've created that is unique to your account.\n Provide the name in this field to successfully use it in a stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-name" + } + }, + "VocabularyFilterMethod": { + "target": "com.amazonaws.transcribestreaming#VocabularyFilterMethod", + "traits": { + "smithy.api#documentation": "The manner in which you use your vocabulary filter to filter words in your transcript.\n Remove removes filtered words from your transcription results.\n Mask masks filtered words with a *** in your transcription results.\n Tag keeps the filtered words in your transcription results and tags them. The\n tag appears as VocabularyFilterMatch equal to True\n
When true, enables speaker identification in your real-time stream.
When true, instructs Amazon Transcribe to process each audio channel separately and then\n merge the transcription output of each channel into a single transcription.
Amazon Transcribe also produces a transcription of each item. An item includes the start time, end\n time, and any alternative transcriptions.
\nYou can't set both ShowSpeakerLabel and\n EnableChannelIdentification in the same request. If you set both, your request\n returns a BadRequestException.
The number of channels that are in your audio stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-number-of-channels" + } + }, + "EnablePartialResultsStabilization": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#documentation": "When true, instructs Amazon Transcribe to present transcription results that have the\n partial results stabilized. Normally, any word or phrase from one partial result can change in\n a subsequent partial result. With partial results stabilization enabled, only the last few\n words of one partial result can change in another partial result.
You can use this field to set the stability level of the transcription results. A higher\n stability level means that the transcription results are less likely to change. Higher\n stability levels can come with lower overall transcription accuracy.
", + "smithy.api#httpHeader": "x-amzn-transcribe-partial-results-stability" + } + }, + "ContentIdentificationType": { + "target": "com.amazonaws.transcribestreaming#ContentIdentificationType", + "traits": { + "smithy.api#documentation": "Set this field to PII to identify personally identifiable information (PII) in the transcription output. Content identification is performed only upon complete transcription of the audio segments.
\nYou can’t set both ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.
Set this field to PII to redact personally identifiable information (PII) in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.
\nYou can’t set both ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.
List the PII entity types you want to identify or redact. In order to specify entity types, you must have \n either ContentIdentificationType or ContentRedactionType enabled.
\n PiiEntityTypes is an optional parameter with a default value of ALL.
The name of the language model you want to use.
", + "smithy.api#httpHeader": "x-amzn-transcribe-language-model-name" + } + } + } + }, + "com.amazonaws.transcribestreaming#StartStreamTranscriptionResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.transcribestreaming#RequestId", + "traits": { + "smithy.api#documentation": "An identifier for the streaming transcription.
", + "smithy.api#httpHeader": "x-amzn-request-id" + } + }, + "LanguageCode": { + "target": "com.amazonaws.transcribestreaming#LanguageCode", + "traits": { + "smithy.api#documentation": "The language code for the input audio stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-language-code" + } + }, + "MediaSampleRateHertz": { + "target": "com.amazonaws.transcribestreaming#MediaSampleRateHertz", + "traits": { + "smithy.api#documentation": "The sample rate for the input audio stream. Use 8,000 Hz for low quality audio and 16,000 Hz\n for high quality audio.
", + "smithy.api#httpHeader": "x-amzn-transcribe-sample-rate" + } + }, + "MediaEncoding": { + "target": "com.amazonaws.transcribestreaming#MediaEncoding", + "traits": { + "smithy.api#documentation": "The encoding used for the input audio stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-media-encoding" + } + }, + "VocabularyName": { + "target": "com.amazonaws.transcribestreaming#VocabularyName", + "traits": { + "smithy.api#documentation": "The name of the vocabulary used when processing the stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-name" + } + }, + "SessionId": { + "target": "com.amazonaws.transcribestreaming#SessionId", + "traits": { + "smithy.api#documentation": "An identifier for a specific transcription session.
", + "smithy.api#httpHeader": "x-amzn-transcribe-session-id" + } + }, + "TranscriptResultStream": { + "target": "com.amazonaws.transcribestreaming#TranscriptResultStream", + "traits": { + "smithy.api#documentation": "Represents the stream of transcription events from Amazon Transcribe to your application.
", + "smithy.api#httpPayload": {} + } + }, + "VocabularyFilterName": { + "target": "com.amazonaws.transcribestreaming#VocabularyFilterName", + "traits": { + "smithy.api#documentation": "The name of the vocabulary filter used in your real-time stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-name" + } + }, + "VocabularyFilterMethod": { + "target": "com.amazonaws.transcribestreaming#VocabularyFilterMethod", + "traits": { + "smithy.api#documentation": "The vocabulary filtering method used in the real-time stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-vocabulary-filter-method" + } + }, + "ShowSpeakerLabel": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#documentation": "Shows whether speaker identification was enabled in the stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-show-speaker-label" + } + }, + "EnableChannelIdentification": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#documentation": "Shows whether channel identification has been enabled in the stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-enable-channel-identification" + } + }, + "NumberOfChannels": { + "target": "com.amazonaws.transcribestreaming#NumberOfChannels", + "traits": { + "smithy.api#documentation": "The number of channels identified in the stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-number-of-channels" + } + }, + "EnablePartialResultsStabilization": { + "target": "com.amazonaws.transcribestreaming#Boolean", + "traits": { + "smithy.api#documentation": "Shows whether partial results stabilization has been enabled in the stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-enable-partial-results-stabilization" + } + }, + "PartialResultsStability": { + "target": "com.amazonaws.transcribestreaming#PartialResultsStability", + "traits": { + "smithy.api#documentation": "If partial results stabilization has been enabled in the stream, shows the stability\n level.
", + "smithy.api#httpHeader": "x-amzn-transcribe-partial-results-stability" + } + }, + "ContentIdentificationType": { + "target": "com.amazonaws.transcribestreaming#ContentIdentificationType", + "traits": { + "smithy.api#documentation": "Shows whether content identification was enabled in this stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-content-identification-type" + } + }, + "ContentRedactionType": { + "target": "com.amazonaws.transcribestreaming#ContentRedactionType", + "traits": { + "smithy.api#documentation": "Shows whether content redaction was enabled in this stream.
", + "smithy.api#httpHeader": "x-amzn-transcribe-content-redaction-type" + } + }, + "PiiEntityTypes": { + "target": "com.amazonaws.transcribestreaming#PiiEntityTypes", + "traits": { + "smithy.api#documentation": "Lists the PII entity types you specified in your request.
", + "smithy.api#httpHeader": "x-amzn-transcribe-pii-entity-types" + } + }, + "LanguageModelName": { + "target": "com.amazonaws.transcribestreaming#ModelName", + "traits": { + "smithy.api#httpHeader": "x-amzn-transcribe-language-model-name" + } + } + } + }, + "com.amazonaws.transcribestreaming#String": { + "type": "string" + }, + "com.amazonaws.transcribestreaming#Transcribe": { + "type": "service", + "version": "2017-10-26", + "operations": [ + { + "target": "com.amazonaws.transcribestreaming#StartMedicalStreamTranscription" + }, + { + "target": "com.amazonaws.transcribestreaming#StartStreamTranscription" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "Transcribe Streaming", + "arnNamespace": "transcribe", + "cloudFormationName": "TranscribeStreaming", + "cloudTrailEventSource": "transcribestreaming.amazonaws.com", + "endpointPrefix": "transcribestreaming" + }, + "aws.auth#sigv4": { + "name": "transcribe" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Operations and objects for transcribing streaming speech to text.
", + "smithy.api#title": "Amazon Transcribe Streaming Service" + } + }, + "com.amazonaws.transcribestreaming#Transcript": { + "type": "structure", + "members": { + "Results": { + "target": "com.amazonaws.transcribestreaming#ResultList", + "traits": { + "smithy.api#documentation": "\n Result objects that contain the results of transcribing a portion of the\n input audio stream. The array can be empty.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The transcription in a TranscriptEvent.
" + } + }, + "com.amazonaws.transcribestreaming#TranscriptEvent": { + "type": "structure", + "members": { + "Transcript": { + "target": "com.amazonaws.transcribestreaming#Transcript", + "traits": { + "smithy.api#documentation": "The transcription of the audio stream. The transcription is composed of all of the items\n in the results list.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a set of transcription results from the server to the client. It contains one\n or more segments of the transcription.
" + } + }, + "com.amazonaws.transcribestreaming#TranscriptResultStream": { + "type": "union", + "members": { + "TranscriptEvent": { + "target": "com.amazonaws.transcribestreaming#TranscriptEvent", + "traits": { + "smithy.api#documentation": "A portion of the transcription of the audio stream. Events are sent periodically from\n Amazon Transcribe to your application. The event can be a partial transcription of a section of the audio\n stream, or it can be the entire transcription of that portion of the audio stream.\n
" + } + }, + "BadRequestException": { + "target": "com.amazonaws.transcribestreaming#BadRequestException", + "traits": { + "smithy.api#documentation": "A client error occurred when the stream was created. Check the parameters of the request\n and try your request again.
" + } + }, + "LimitExceededException": { + "target": "com.amazonaws.transcribestreaming#LimitExceededException", + "traits": { + "smithy.api#documentation": "Your client has exceeded one of the Amazon Transcribe limits, typically the limit on audio length.\n Break your audio stream into smaller chunks and try your request again.
" + } + }, + "InternalFailureException": { + "target": "com.amazonaws.transcribestreaming#InternalFailureException", + "traits": { + "smithy.api#documentation": "A problem occurred while processing the audio. Amazon Transcribe terminated processing.
" + } + }, + "ConflictException": { + "target": "com.amazonaws.transcribestreaming#ConflictException", + "traits": { + "smithy.api#documentation": "A new stream started with the same session ID. The current stream has been\n terminated.
" + } + }, + "ServiceUnavailableException": { + "target": "com.amazonaws.transcribestreaming#ServiceUnavailableException", + "traits": { + "smithy.api#documentation": "Service is currently unavailable. Try your request later.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the transcription result stream from Amazon Transcribe to your application.
", + "smithy.api#streaming": {} + } + }, + "com.amazonaws.transcribestreaming#Type": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CONVERSATION", + "name": "CONVERSATION" + }, + { + "value": "DICTATION", + "name": "DICTATION" + } + ] + } + }, + "com.amazonaws.transcribestreaming#VocabularyFilterMethod": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "remove", + "name": "REMOVE" + }, + { + "value": "mask", + "name": "MASK" + }, + { + "value": "tag", + "name": "TAG" + } + ] + } + }, + "com.amazonaws.transcribestreaming#VocabularyFilterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" + } + }, + "com.amazonaws.transcribestreaming#VocabularyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + }, + "smithy.api#pattern": "^[0-9a-zA-Z._-]+$" + } + } + } +} diff --git a/codegen/sdk/aws-models/workmail.2017-10-01.json b/codegen/sdk/aws-models/workmail.2017-10-01.json index c5ca6abd42f..95afd2ab4b9 100644 --- a/codegen/sdk/aws-models/workmail.2017-10-01.json +++ b/codegen/sdk/aws-models/workmail.2017-10-01.json @@ -968,7 +968,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an access control rule for the specified WorkMail organization.
" + "smithy.api#documentation": "Deletes an access control rule for the specified WorkMail organization.
\nDeleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
\nDeletes the mobile device access override for the given WorkMail organization, user, and device.
" + "smithy.api#documentation": "Deletes the mobile device access override for the given WorkMail organization, user, and device.
\nDeleting already deleted and non-existing overrides does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
\nDeletes a mobile device access rule for the specified Amazon WorkMail organization.
" + "smithy.api#documentation": "Deletes a mobile device access rule for the specified Amazon WorkMail organization.
\nDeleting already deleted and non-existing rules does not produce an error. In those cases, the service sends back an HTTP 200 response with an empty HTTP body.
\nRemoves a domain from Amazon WorkMail, stops email routing to WorkMail, and removes the authorization allowing WorkMail use. SES keeps the domain because other applications may use it. You must first \n remove any email address used by WorkMail entities before you remove the domain.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#DeregisterMailDomainRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "The Amazon WorkMail organization for which the domain will be deregistered.
", + "smithy.api#required": {} + } + }, + "DomainName": { + "target": "com.amazonaws.workmail#WorkMailDomainName", + "traits": { + "smithy.api#documentation": "The domain to deregister in WorkMail and SES.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#DeregisterMailDomainResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.workmail#DescribeGroup": { "type": "operation", "input": { @@ -2378,6 +2431,57 @@ "type": "structure", "members": {} }, + "com.amazonaws.workmail#DnsRecord": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.workmail#String", + "traits": { + "smithy.api#documentation": "The RFC 1035 record type. Possible values: CNAME, A, MX.
The DNS hostname.- For example, domain.example.com.
The value returned by the DNS for a query to that hostname and record type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A DNS record uploaded to your DNS provider.
" + } + }, + "com.amazonaws.workmail#DnsRecordVerificationStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "VERIFIED", + "name": "VERIFIED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.workmail#DnsRecords": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#DnsRecord" + } + }, "com.amazonaws.workmail#Domain": { "type": "structure", "members": { @@ -2527,7 +2631,7 @@ "Period": { "target": "com.amazonaws.workmail#RetentionPeriod", "traits": { - "smithy.api#documentation": "The period of time at which the folder configuration action is applied.
" + "smithy.api#documentation": "The number of days for which the folder-configuration action applies.
" } } }, @@ -2712,6 +2816,87 @@ } } }, + "com.amazonaws.workmail#GetMailDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#GetMailDomainRequest" + }, + "output": { + "target": "com.amazonaws.workmail#GetMailDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#MailDomainNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "Gets details for a mail domain, including domain records required to configure your domain with recommended security.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#GetMailDomainRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "The Amazon WorkMail organization for which the domain is retrieved.
", + "smithy.api#required": {} + } + }, + "DomainName": { + "target": "com.amazonaws.workmail#WorkMailDomainName", + "traits": { + "smithy.api#documentation": "The domain from which you want to retrieve details.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#GetMailDomainResponse": { + "type": "structure", + "members": { + "Records": { + "target": "com.amazonaws.workmail#DnsRecords", + "traits": { + "smithy.api#documentation": "A list of the DNS records that Amazon WorkMail recommends adding in your DNS provider for the best user experience. The records configure your domain with DMARC, SPF, DKIM, and direct incoming \n email traffic to SES. See admin guide for more details.
" + } + }, + "IsTestDomain": { + "target": "com.amazonaws.workmail#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the domain is a test domain provided by WorkMail, or a custom domain.
" + } + }, + "IsDefault": { + "target": "com.amazonaws.workmail#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the domain is the default domain for your organization.
" + } + }, + "OwnershipVerificationStatus": { + "target": "com.amazonaws.workmail#DnsRecordVerificationStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of the domain ownership verification.
" + } + }, + "DkimVerificationStatus": { + "target": "com.amazonaws.workmail#DnsRecordVerificationStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of a DKIM verification.
" + } + } + } + }, "com.amazonaws.workmail#GetMailboxDetails": { "type": "operation", "input": { @@ -3036,6 +3221,18 @@ "smithy.api#error": "client" } }, + "com.amazonaws.workmail#InvalidCustomSesConfigurationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.workmail#String" + } + }, + "traits": { + "smithy.api#documentation": "You SES configuration has customizations that Amazon WorkMail cannot save. The error message lists the invalid setting. For examples of invalid settings, refer to \n CreateReceiptRule.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.workmail#InvalidParameterException": { "type": "structure", "members": { @@ -3402,6 +3599,76 @@ } } }, + "com.amazonaws.workmail#ListMailDomains": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#ListMailDomainsRequest" + }, + "output": { + "target": "com.amazonaws.workmail#ListMailDomainsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the mail domains in a given Amazon WorkMail organization.
", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.workmail#ListMailDomainsRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "The Amazon WorkMail organization for which to list domains.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.workmail#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in a single call.
" + } + }, + "NextToken": { + "target": "com.amazonaws.workmail#NextToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. The first call does not require a token.
" + } + } + } + }, + "com.amazonaws.workmail#ListMailDomainsResponse": { + "type": "structure", + "members": { + "MailDomains": { + "target": "com.amazonaws.workmail#MailDomains", + "traits": { + "smithy.api#documentation": "The list of mail domain summaries, specifying domains that exist in the specified Amazon WorkMail organization, along with the information about whether the domain is or isn't the default.
" + } + }, + "NextToken": { + "target": "com.amazonaws.workmail#NextToken", + "traits": { + "smithy.api#documentation": "The token to use to retrieve the next page of results. The value becomes null when there are no more results to return.
The domain you're trying to change is in use by another user or organization in your account. See the error message for details.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.workmail#MailDomainNotFoundException": { "type": "structure", "members": { @@ -4010,7 +4289,7 @@ } }, "traits": { - "smithy.api#documentation": "For an email or alias to be created in Amazon WorkMail, the included domain must be defined\n in the organization.
", + "smithy.api#documentation": "The domain specified is not found in your organization.
", "smithy.api#error": "client" } }, @@ -4026,6 +4305,32 @@ "smithy.api#error": "client" } }, + "com.amazonaws.workmail#MailDomainSummary": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.workmail#DomainName", + "traits": { + "smithy.api#documentation": "The domain name.
" + } + }, + "DefaultDomain": { + "target": "com.amazonaws.workmail#Boolean", + "traits": { + "smithy.api#documentation": "Whether the domain is default or not.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The data for a given domain.
" + } + }, + "com.amazonaws.workmail#MailDomains": { + "type": "list", + "member": { + "target": "com.amazonaws.workmail#MailDomainSummary" + } + }, "com.amazonaws.workmail#MailboxExportErrorInfo": { "type": "string", "traits": { @@ -5009,6 +5314,66 @@ "type": "structure", "members": {} }, + "com.amazonaws.workmail#RegisterMailDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#RegisterMailDomainRequest" + }, + "output": { + "target": "com.amazonaws.workmail#RegisterMailDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#LimitExceededException" + }, + { + "target": "com.amazonaws.workmail#MailDomainInUseException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "Registers a new domain in Amazon WorkMail and SES, and configures it for use by WorkMail. Emails received by SES for this domain are routed to the specified WorkMail organization, and WorkMail has \n permanent permission to use the specified domain for sending your users' emails.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#RegisterMailDomainRequest": { + "type": "structure", + "members": { + "ClientToken": { + "target": "com.amazonaws.workmail#IdempotencyClientToken", + "traits": { + "smithy.api#documentation": "Idempotency token used when retrying requests.
", + "smithy.api#idempotencyToken": {} + } + }, + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "The Amazon WorkMail organization under which you're creating the domain.
", + "smithy.api#required": {} + } + }, + "DomainName": { + "target": "com.amazonaws.workmail#WorkMailDomainName", + "traits": { + "smithy.api#documentation": "The name of the mail domain to create in Amazon WorkMail and SES.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#RegisterMailDomainResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.workmail#RegisterToWorkMail": { "type": "operation", "input": { @@ -5638,6 +6003,59 @@ "type": "structure", "members": {} }, + "com.amazonaws.workmail#UpdateDefaultMailDomain": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#UpdateDefaultMailDomainRequest" + }, + "output": { + "target": "com.amazonaws.workmail#UpdateDefaultMailDomainResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#MailDomainNotFoundException" + }, + { + "target": "com.amazonaws.workmail#MailDomainStateException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the default mail domain for an organization. The default mail domain is used by the WorkMail AWS Console to suggest an email address when enabling a mail user. You can only have one default domain.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#UpdateDefaultMailDomainRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "The Amazon WorkMail organization for which to list domains.
", + "smithy.api#required": {} + } + }, + "DomainName": { + "target": "com.amazonaws.workmail#WorkMailDomainName", + "traits": { + "smithy.api#documentation": "The domain name that will become the default domain.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#UpdateDefaultMailDomainResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.workmail#UpdateMailboxQuota": { "type": "operation", "input": { @@ -6076,6 +6494,16 @@ "target": "com.amazonaws.workmail#User" } }, + "com.amazonaws.workmail#WorkMailDomainName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 209 + }, + "smithy.api#pattern": "^[a-zA-Z0-9.-]+\\.[a-zA-Z-]{2,}$" + } + }, "com.amazonaws.workmail#WorkMailIdentifier": { "type": "string", "traits": { @@ -6149,6 +6577,9 @@ { "target": "com.amazonaws.workmail#DeregisterFromWorkMail" }, + { + "target": "com.amazonaws.workmail#DeregisterMailDomain" + }, { "target": "com.amazonaws.workmail#DescribeGroup" }, @@ -6182,6 +6613,9 @@ { "target": "com.amazonaws.workmail#GetMailboxDetails" }, + { + "target": "com.amazonaws.workmail#GetMailDomain" + }, { "target": "com.amazonaws.workmail#GetMobileDeviceAccessEffect" }, @@ -6206,6 +6640,9 @@ { "target": "com.amazonaws.workmail#ListMailboxPermissions" }, + { + "target": "com.amazonaws.workmail#ListMailDomains" + }, { "target": "com.amazonaws.workmail#ListMobileDeviceAccessOverrides" }, @@ -6242,6 +6679,9 @@ { "target": "com.amazonaws.workmail#PutRetentionPolicy" }, + { + "target": "com.amazonaws.workmail#RegisterMailDomain" + }, { "target": "com.amazonaws.workmail#RegisterToWorkMail" }, @@ -6257,6 +6697,9 @@ { "target": "com.amazonaws.workmail#UntagResource" }, + { + "target": "com.amazonaws.workmail#UpdateDefaultMailDomain" + }, { "target": "com.amazonaws.workmail#UpdateMailboxQuota" }, diff --git a/codegen/sdk/build.gradle.kts b/codegen/sdk/build.gradle.kts index a0089ad2068..6d1828550b1 100644 --- a/codegen/sdk/build.gradle.kts +++ b/codegen/sdk/build.gradle.kts @@ -10,6 +10,7 @@ import software.amazon.smithy.gradle.tasks.SmithyBuild import software.amazon.smithy.model.Model import software.amazon.smithy.model.shapes.ServiceShape import java.util.* +import java.nio.file.Paths import kotlin.streams.toList description = "AWS SDK codegen tasks" @@ -56,13 +57,45 @@ fun getProperty(name: String): String? { // Represents information needed to generate a smithy projection JSON stanza data class AwsService( + /** + * The service shape ID name + */ val name: String, + /** + * The package name to use for the service when generating smithy-build.json + */ val packageName: String, + + /** + * The package version (this should match the sdk version of the project) + */ val packageVersion: String, + + /** + * The path to the model file in aws-sdk-kotlin + */ val modelFile: File, + + /** + * The name of the projection to generate + */ val projectionName: String, + + /** + * The sdkId value from the service trait + */ val sdkId: String, - val description: String? = null + + /** + * The model version from the service shape + */ + val version: String, + + /** + * A description of the service (taken from the title trait) + */ + val description: String? = null, + ) @@ -146,14 +179,19 @@ val discoveredServices: List