|
1468 | 1468 | ], |
1469 | 1469 | "documentation":"<p>Gets a connection. In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.</p>" |
1470 | 1470 | }, |
| 1471 | + "GetDataExportConfiguration":{ |
| 1472 | + "name":"GetDataExportConfiguration", |
| 1473 | + "http":{ |
| 1474 | + "method":"GET", |
| 1475 | + "requestUri":"/v2/domains/{domainIdentifier}/data-export-configuration", |
| 1476 | + "responseCode":200 |
| 1477 | + }, |
| 1478 | + "input":{"shape":"GetDataExportConfigurationInput"}, |
| 1479 | + "output":{"shape":"GetDataExportConfigurationOutput"}, |
| 1480 | + "errors":[ |
| 1481 | + {"shape":"InternalServerException"}, |
| 1482 | + {"shape":"ResourceNotFoundException"}, |
| 1483 | + {"shape":"AccessDeniedException"}, |
| 1484 | + {"shape":"ThrottlingException"}, |
| 1485 | + {"shape":"ValidationException"}, |
| 1486 | + {"shape":"UnauthorizedException"} |
| 1487 | + ], |
| 1488 | + "documentation":"<p>Gets data export configuration details.</p>" |
| 1489 | + }, |
1471 | 1490 | "GetDataProduct":{ |
1472 | 1491 | "name":"GetDataProduct", |
1473 | 1492 | "http":{ |
|
2712 | 2731 | "documentation":"<p>Posts time series data points to Amazon DataZone for the specified asset.</p>", |
2713 | 2732 | "idempotent":true |
2714 | 2733 | }, |
| 2734 | + "PutDataExportConfiguration":{ |
| 2735 | + "name":"PutDataExportConfiguration", |
| 2736 | + "http":{ |
| 2737 | + "method":"PUT", |
| 2738 | + "requestUri":"/v2/domains/{domainIdentifier}/data-export-configuration", |
| 2739 | + "responseCode":200 |
| 2740 | + }, |
| 2741 | + "input":{"shape":"PutDataExportConfigurationInput"}, |
| 2742 | + "output":{"shape":"PutDataExportConfigurationOutput"}, |
| 2743 | + "errors":[ |
| 2744 | + {"shape":"InternalServerException"}, |
| 2745 | + {"shape":"ResourceNotFoundException"}, |
| 2746 | + {"shape":"AccessDeniedException"}, |
| 2747 | + {"shape":"ThrottlingException"}, |
| 2748 | + {"shape":"ServiceQuotaExceededException"}, |
| 2749 | + {"shape":"ConflictException"}, |
| 2750 | + {"shape":"ValidationException"}, |
| 2751 | + {"shape":"UnauthorizedException"} |
| 2752 | + ], |
| 2753 | + "documentation":"<p>Creates data export configuration details.</p> <p>In the current release, you can enable exporting asset metadata only for one domain per Amazon Web Services account per region. If you disable exporting asset metadata feature for a domain where it's already enabled, you cannot enable this feature for another domain in the same Amazon Web Services account and region.</p>", |
| 2754 | + "idempotent":true |
| 2755 | + }, |
2715 | 2756 | "PutEnvironmentBlueprintConfiguration":{ |
2716 | 2757 | "name":"PutEnvironmentBlueprintConfiguration", |
2717 | 2758 | "http":{ |
|
2968 | 3009 | {"shape":"ValidationException"}, |
2969 | 3010 | {"shape":"UnauthorizedException"} |
2970 | 3011 | ], |
2971 | | - "documentation":"<p>Starts the metadata generation run.</p> <p>Prerequisites:</p> <ul> <li> <p>Asset must be created and belong to the specified domain and project. </p> </li> <li> <p>Asset type must be supported for metadata generation (e.g., Amazon Web Services Glue table).</p> </li> <li> <p>Asset must have a structured schema with valid rows and columns.</p> </li> <li> <p>Valid values for --type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES.</p> </li> <li> <p>The user must have permission to run metadata generation in the domain/project.</p> </li> </ul>", |
| 3012 | + "documentation":"<p>Starts the metadata generation run.</p> <p>Prerequisites:</p> <ul> <li> <p>Asset must be created and belong to the specified domain and project. </p> </li> <li> <p>Asset type must be supported for metadata generation (e.g., Amazon Web Services Glue table).</p> </li> <li> <p>Asset must have a structured schema with valid rows and columns.</p> </li> <li> <p>Valid values for --type: BUSINESS_DESCRIPTIONS, BUSINESS_NAMES, BUSINESS_GLOSSARY_ASSOCIATIONS.</p> </li> <li> <p>The user must have permission to run metadata generation in the domain/project.</p> </li> </ul>", |
2972 | 3013 | "idempotent":true |
2973 | 3014 | }, |
2974 | 3015 | "TagResource":{ |
|
5435 | 5476 | }, |
5436 | 5477 | "documentation":"<p>The configurable action of a Amazon DataZone environment.</p>" |
5437 | 5478 | }, |
| 5479 | + "ConfigurationStatus":{ |
| 5480 | + "type":"string", |
| 5481 | + "enum":[ |
| 5482 | + "COMPLETED", |
| 5483 | + "FAILED" |
| 5484 | + ] |
| 5485 | + }, |
5438 | 5486 | "ConflictException":{ |
5439 | 5487 | "type":"structure", |
5440 | 5488 | "required":["message"], |
|
10667 | 10715 | "member":{"shape":"RegionName"}, |
10668 | 10716 | "min":0 |
10669 | 10717 | }, |
| 10718 | + "EncryptionConfiguration":{ |
| 10719 | + "type":"structure", |
| 10720 | + "members":{ |
| 10721 | + "kmsKeyArn":{ |
| 10722 | + "shape":"String", |
| 10723 | + "documentation":"<p>The Amazon Resource Name (ARN) of the KMS key to use for encryption. This field is required only when <code>sseAlgorithm</code> is set to <code>aws:kms</code>.</p>" |
| 10724 | + }, |
| 10725 | + "sseAlgorithm":{ |
| 10726 | + "shape":"String", |
| 10727 | + "documentation":"<p>The server-side encryption algorithm to use. Valid values are AES256 for S3-managed encryption keys, or aws:kms for Amazon Web Services KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html\">Permissions requirements for S3 Tables SSE-KMS encryption</a>.</p>" |
| 10728 | + } |
| 10729 | + }, |
| 10730 | + "documentation":"<p>The encryption configuration details.</p>" |
| 10731 | + }, |
10670 | 10732 | "EntityId":{ |
10671 | 10733 | "type":"string", |
10672 | 10734 | "pattern":"^[a-zA-Z0-9_-]{1,36}$" |
|
12064 | 12126 | } |
12065 | 12127 | } |
12066 | 12128 | }, |
| 12129 | + "GetDataExportConfigurationInput":{ |
| 12130 | + "type":"structure", |
| 12131 | + "required":["domainIdentifier"], |
| 12132 | + "members":{ |
| 12133 | + "domainIdentifier":{ |
| 12134 | + "shape":"DomainId", |
| 12135 | + "documentation":"<p>The ID of the domain where you want to get the data export configuration details.</p>", |
| 12136 | + "location":"uri", |
| 12137 | + "locationName":"domainIdentifier" |
| 12138 | + } |
| 12139 | + } |
| 12140 | + }, |
| 12141 | + "GetDataExportConfigurationOutput":{ |
| 12142 | + "type":"structure", |
| 12143 | + "members":{ |
| 12144 | + "createdAt":{ |
| 12145 | + "shape":"CreatedAt", |
| 12146 | + "documentation":"<p>The timestamp at which the data export configuration report was created.</p>" |
| 12147 | + }, |
| 12148 | + "encryptionConfiguration":{ |
| 12149 | + "shape":"EncryptionConfiguration", |
| 12150 | + "documentation":"<p>The encryption configuration as part of the data export configuration details.</p>" |
| 12151 | + }, |
| 12152 | + "isExportEnabled":{ |
| 12153 | + "shape":"Boolean", |
| 12154 | + "documentation":"<p>Specifies whether the export is enabled.</p>" |
| 12155 | + }, |
| 12156 | + "s3TableBucketArn":{ |
| 12157 | + "shape":"String", |
| 12158 | + "documentation":"<p>The Amazon S3 table bucket ARN as part of the data export configuration details.</p>" |
| 12159 | + }, |
| 12160 | + "status":{ |
| 12161 | + "shape":"ConfigurationStatus", |
| 12162 | + "documentation":"<p>The status of the data export configuration.</p>" |
| 12163 | + }, |
| 12164 | + "updatedAt":{ |
| 12165 | + "shape":"UpdatedAt", |
| 12166 | + "documentation":"<p>The timestamp at which the data export configuration report was updated.</p>" |
| 12167 | + } |
| 12168 | + } |
| 12169 | + }, |
12067 | 12170 | "GetDataProductInput":{ |
12068 | 12171 | "type":"structure", |
12069 | 12172 | "required":[ |
|
13634 | 13737 | "documentation":"<p>The identifier of the metadata generation run.</p>", |
13635 | 13738 | "location":"uri", |
13636 | 13739 | "locationName":"identifier" |
| 13740 | + }, |
| 13741 | + "type":{ |
| 13742 | + "shape":"MetadataGenerationRunType", |
| 13743 | + "documentation":"<p>The type of the metadata generation run.</p>", |
| 13744 | + "location":"querystring", |
| 13745 | + "locationName":"type" |
13637 | 13746 | } |
13638 | 13747 | } |
13639 | 13748 | }, |
|
13675 | 13784 | }, |
13676 | 13785 | "type":{ |
13677 | 13786 | "shape":"MetadataGenerationRunType", |
13678 | | - "documentation":"<p>The type of metadata generation run.</p>" |
| 13787 | + "documentation":"<p>The type of metadata generation run.</p>", |
| 13788 | + "deprecated":true, |
| 13789 | + "deprecatedMessage":"This field is going to be deprecated, please use the 'types' field to provide the MetadataGenerationRun types" |
| 13790 | + }, |
| 13791 | + "typeStats":{ |
| 13792 | + "shape":"MetadataGenerationRunTypeStats", |
| 13793 | + "documentation":"<p>The type stats included in the metadata generation run output details.</p>" |
| 13794 | + }, |
| 13795 | + "types":{ |
| 13796 | + "shape":"MetadataGenerationRunTypes", |
| 13797 | + "documentation":"<p>The types of the metadata generation run.</p>" |
13679 | 13798 | } |
13680 | 13799 | } |
13681 | 13800 | }, |
|
17019 | 17138 | "location":"querystring", |
17020 | 17139 | "locationName":"status" |
17021 | 17140 | }, |
| 17141 | + "targetIdentifier":{ |
| 17142 | + "shape":"EntityId", |
| 17143 | + "documentation":"<p>The target ID for which you want to list metadata generation runs.</p>", |
| 17144 | + "location":"querystring", |
| 17145 | + "locationName":"targetIdentifier" |
| 17146 | + }, |
17022 | 17147 | "type":{ |
17023 | 17148 | "shape":"MetadataGenerationRunType", |
17024 | 17149 | "documentation":"<p>The type of the metadata generation runs.</p>", |
|
18212 | 18337 | }, |
18213 | 18338 | "type":{ |
18214 | 18339 | "shape":"MetadataGenerationRunType", |
18215 | | - "documentation":"<p>The type of the metadata generation run.</p>" |
| 18340 | + "documentation":"<p>The type of the metadata generation run.</p>", |
| 18341 | + "deprecated":true, |
| 18342 | + "deprecatedMessage":"This field is going to be deprecated, please use the 'types' field to provide the MetadataGenerationRun types" |
| 18343 | + }, |
| 18344 | + "types":{ |
| 18345 | + "shape":"MetadataGenerationRunTypes", |
| 18346 | + "documentation":"<p>The types of the metadata generation run.</p>" |
18216 | 18347 | } |
18217 | 18348 | }, |
18218 | 18349 | "documentation":"<p>The metadata generation run.</p>" |
|
18224 | 18355 | "IN_PROGRESS", |
18225 | 18356 | "CANCELED", |
18226 | 18357 | "SUCCEEDED", |
18227 | | - "FAILED" |
| 18358 | + "FAILED", |
| 18359 | + "PARTIALLY_SUCCEEDED" |
18228 | 18360 | ] |
18229 | 18361 | }, |
18230 | 18362 | "MetadataGenerationRunTarget":{ |
|
18251 | 18383 | }, |
18252 | 18384 | "MetadataGenerationRunType":{ |
18253 | 18385 | "type":"string", |
18254 | | - "enum":["BUSINESS_DESCRIPTIONS"] |
| 18386 | + "enum":[ |
| 18387 | + "BUSINESS_DESCRIPTIONS", |
| 18388 | + "BUSINESS_NAMES", |
| 18389 | + "BUSINESS_GLOSSARY_ASSOCIATIONS" |
| 18390 | + ] |
| 18391 | + }, |
| 18392 | + "MetadataGenerationRunTypeStat":{ |
| 18393 | + "type":"structure", |
| 18394 | + "required":[ |
| 18395 | + "status", |
| 18396 | + "type" |
| 18397 | + ], |
| 18398 | + "members":{ |
| 18399 | + "errorMessage":{ |
| 18400 | + "shape":"String", |
| 18401 | + "documentation":"<p>The error message displayed if the action fails to run.</p>" |
| 18402 | + }, |
| 18403 | + "status":{ |
| 18404 | + "shape":"MetadataGenerationRunStatus", |
| 18405 | + "documentation":"<p>The status of the metadata generation run type statistics.</p>" |
| 18406 | + }, |
| 18407 | + "type":{ |
| 18408 | + "shape":"MetadataGenerationRunType", |
| 18409 | + "documentation":"<p>The type of the metadata generation run type statistics.</p>" |
| 18410 | + } |
| 18411 | + }, |
| 18412 | + "documentation":"<p>The statistics of the metadata generation run type.</p>" |
| 18413 | + }, |
| 18414 | + "MetadataGenerationRunTypeStats":{ |
| 18415 | + "type":"list", |
| 18416 | + "member":{"shape":"MetadataGenerationRunTypeStat"} |
| 18417 | + }, |
| 18418 | + "MetadataGenerationRunTypes":{ |
| 18419 | + "type":"list", |
| 18420 | + "member":{"shape":"MetadataGenerationRunType"}, |
| 18421 | + "max":2, |
| 18422 | + "min":1 |
18255 | 18423 | }, |
18256 | 18424 | "MetadataGenerationRuns":{ |
18257 | 18425 | "type":"list", |
|
19330 | 19498 | "documentation":"<p>The provisioning properties of an environment blueprint.</p>", |
19331 | 19499 | "union":true |
19332 | 19500 | }, |
| 19501 | + "PutDataExportConfigurationInput":{ |
| 19502 | + "type":"structure", |
| 19503 | + "required":[ |
| 19504 | + "domainIdentifier", |
| 19505 | + "enableExport" |
| 19506 | + ], |
| 19507 | + "members":{ |
| 19508 | + "clientToken":{ |
| 19509 | + "shape":"ClientToken", |
| 19510 | + "documentation":"<p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p>", |
| 19511 | + "idempotencyToken":true |
| 19512 | + }, |
| 19513 | + "domainIdentifier":{ |
| 19514 | + "shape":"DomainId", |
| 19515 | + "documentation":"<p>The domain ID where you want to create data export configuration details.</p>", |
| 19516 | + "location":"uri", |
| 19517 | + "locationName":"domainIdentifier" |
| 19518 | + }, |
| 19519 | + "enableExport":{ |
| 19520 | + "shape":"Boolean", |
| 19521 | + "documentation":"<p>Specifies that the export is to be enabled as part of creating data export configuration details.</p>" |
| 19522 | + }, |
| 19523 | + "encryptionConfiguration":{ |
| 19524 | + "shape":"EncryptionConfiguration", |
| 19525 | + "documentation":"<p>The encryption configuration as part of creating data export configuration details.</p> <p>The KMS key provided here as part of encryptionConfiguration must have the required permissions as described in <a href=\"https://docs.aws.amazon.com/sagemaker-unified-studio/latest/adminguide/sagemaker-unified-studio-export-asset-metadata-kms-permissions.html\">KMS permissions for exporting asset metadata in Amazon SageMaker Unified Studio</a>.</p>" |
| 19526 | + } |
| 19527 | + } |
| 19528 | + }, |
| 19529 | + "PutDataExportConfigurationOutput":{ |
| 19530 | + "type":"structure", |
| 19531 | + "members":{} |
| 19532 | + }, |
19333 | 19533 | "PutEnvironmentBlueprintConfigurationInput":{ |
19334 | 19534 | "type":"structure", |
19335 | 19535 | "required":[ |
|
21792 | 21992 | "required":[ |
21793 | 21993 | "domainIdentifier", |
21794 | 21994 | "owningProjectIdentifier", |
21795 | | - "target", |
21796 | | - "type" |
| 21995 | + "target" |
21797 | 21996 | ], |
21798 | 21997 | "members":{ |
21799 | 21998 | "clientToken":{ |
|
21817 | 22016 | }, |
21818 | 22017 | "type":{ |
21819 | 22018 | "shape":"MetadataGenerationRunType", |
21820 | | - "documentation":"<p>The type of the metadata generation run.</p>" |
| 22019 | + "documentation":"<p>The type of the metadata generation run.</p>", |
| 22020 | + "deprecated":true, |
| 22021 | + "deprecatedMessage":"This field is going to be deprecated, please use the 'types' field to provide the MetadataGenerationRun types" |
| 22022 | + }, |
| 22023 | + "types":{ |
| 22024 | + "shape":"MetadataGenerationRunTypes", |
| 22025 | + "documentation":"<p>The types of the metadata generation run.</p>" |
21821 | 22026 | } |
21822 | 22027 | } |
21823 | 22028 | }, |
|
21854 | 22059 | }, |
21855 | 22060 | "type":{ |
21856 | 22061 | "shape":"MetadataGenerationRunType", |
21857 | | - "documentation":"<p>The type of the metadata generation run.</p>" |
| 22062 | + "documentation":"<p>The type of the metadata generation run.</p>", |
| 22063 | + "deprecated":true, |
| 22064 | + "deprecatedMessage":"This field is going to be deprecated, please use the 'types' field to provide the MetadataGenerationRun types" |
| 22065 | + }, |
| 22066 | + "types":{ |
| 22067 | + "shape":"MetadataGenerationRunTypes", |
| 22068 | + "documentation":"<p>The types of the metadata generation run.</p>" |
21858 | 22069 | } |
21859 | 22070 | } |
21860 | 22071 | }, |
|
0 commit comments