aws-sdk-datazone 1.50.0 → 1.51.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-datazone/client.rb +708 -2
- data/lib/aws-sdk-datazone/client_api.rb +100 -0
- data/lib/aws-sdk-datazone/types.rb +219 -1
- data/lib/aws-sdk-datazone.rb +1 -1
- data/sig/client.rbs +82 -0
- data/sig/types.rbs +54 -0
- metadata +1 -1
@@ -899,6 +899,15 @@ module Aws::DataZone
|
|
899
899
|
|
900
900
|
# Cancels the metadata generation run.
|
901
901
|
#
|
902
|
+
# Prerequisites:
|
903
|
+
#
|
904
|
+
# * The run must exist and be in a cancelable status (e.g., SUBMITTED,
|
905
|
+
# IN\_PROGRESS).
|
906
|
+
#
|
907
|
+
# * Runs in SUCCEEDED status cannot be cancelled.
|
908
|
+
#
|
909
|
+
# * User must have access to the run and cancel permissions.
|
910
|
+
#
|
902
911
|
# @option params [required, String] :domain_identifier
|
903
912
|
# The ID of the Amazon DataZone domain in which the metadata generation
|
904
913
|
# run is to be cancelled.
|
@@ -1093,6 +1102,42 @@ module Aws::DataZone
|
|
1093
1102
|
|
1094
1103
|
# Creates an asset in Amazon DataZone catalog.
|
1095
1104
|
#
|
1105
|
+
# Before creating assets, make sure that the following requirements are
|
1106
|
+
# met:
|
1107
|
+
#
|
1108
|
+
# * `--domain-identifier` must refer to an existing domain.
|
1109
|
+
#
|
1110
|
+
# * `--owning-project-identifier` must be a valid project within the
|
1111
|
+
# domain.
|
1112
|
+
#
|
1113
|
+
# * Asset type must be created beforehand using `create-asset-type`, or
|
1114
|
+
# be a supported system-defined type. For more information, see
|
1115
|
+
# [create-asset-type][1].
|
1116
|
+
#
|
1117
|
+
# * `--type-revision` (if used) must match a valid revision of the asset
|
1118
|
+
# type.
|
1119
|
+
#
|
1120
|
+
# * Form type must exist and be associated with the asset type. Use
|
1121
|
+
# `create-form-type` to define. For more information, see
|
1122
|
+
# [create-form-type][2].
|
1123
|
+
#
|
1124
|
+
# * Form content must include all required fields as per the form schema
|
1125
|
+
# (e.g., `bucketArn`).
|
1126
|
+
#
|
1127
|
+
# You must invoke the following pre-requisite commands before invoking
|
1128
|
+
# this API:
|
1129
|
+
#
|
1130
|
+
# * [CreateFormType][3]
|
1131
|
+
#
|
1132
|
+
# * [CreateAssetType][4]
|
1133
|
+
#
|
1134
|
+
#
|
1135
|
+
#
|
1136
|
+
# [1]: https://docs.aws.amazon.com/cli/latest/reference/datazone/create-asset-type.html
|
1137
|
+
# [2]: https://docs.aws.amazon.com/cli/latest/reference/datazone/create-form-type.html
|
1138
|
+
# [3]: https://docs.aws.amazon.com/datazone/latest/APIReference/API_CreateFormType.html
|
1139
|
+
# [4]: https://docs.aws.amazon.com/datazone/latest/APIReference/API_CreateAssetType.html
|
1140
|
+
#
|
1096
1141
|
# @option params [String] :client_token
|
1097
1142
|
# A unique, case-sensitive identifier that is provided to ensure the
|
1098
1143
|
# idempotency of the request.
|
@@ -1235,6 +1280,28 @@ module Aws::DataZone
|
|
1235
1280
|
|
1236
1281
|
# Creates a data asset filter.
|
1237
1282
|
#
|
1283
|
+
# Asset filters provide a sophisticated way to create controlled views
|
1284
|
+
# of data assets by selecting specific columns or applying row-level
|
1285
|
+
# filters. This capability is crucial for organizations that need to
|
1286
|
+
# share data while maintaining security and privacy controls. For
|
1287
|
+
# example, your database might be filtered to show only non-PII fields
|
1288
|
+
# to certain users, or sales data might be filtered by region for
|
1289
|
+
# different regional teams. Asset filters enable fine-grained access
|
1290
|
+
# control while maintaining a single source of truth.
|
1291
|
+
#
|
1292
|
+
# Prerequisites:
|
1293
|
+
#
|
1294
|
+
# * A valid domain (`--domain-identifier`) must exist.
|
1295
|
+
#
|
1296
|
+
# * A data asset (`--asset-identifier`) must already be created under
|
1297
|
+
# that domain.
|
1298
|
+
#
|
1299
|
+
# * The asset must have the referenced columns available in its schema
|
1300
|
+
# for column-based filtering.
|
1301
|
+
#
|
1302
|
+
# * You cannot specify both (`columnConfiguration`,
|
1303
|
+
# `rowConfiguration`)at the same time.
|
1304
|
+
#
|
1238
1305
|
# @option params [required, String] :asset_identifier
|
1239
1306
|
# The ID of the data asset.
|
1240
1307
|
#
|
@@ -1405,6 +1472,28 @@ module Aws::DataZone
|
|
1405
1472
|
|
1406
1473
|
# Creates a revision of the asset.
|
1407
1474
|
#
|
1475
|
+
# Asset revisions represent new versions of existing assets, capturing
|
1476
|
+
# changes to either the underlying data or its metadata. They maintain a
|
1477
|
+
# historical record of how assets evolve over time, who made changes,
|
1478
|
+
# and when those changes occurred. This versioning capability is crucial
|
1479
|
+
# for governance and compliance, allowing organizations to track
|
1480
|
+
# changes, understand their impact, and roll back if necessary.
|
1481
|
+
#
|
1482
|
+
# Prerequisites:
|
1483
|
+
#
|
1484
|
+
# * Asset must already exist in the domain with identifier.
|
1485
|
+
#
|
1486
|
+
# * The form type with correct revision must be registered in the same
|
1487
|
+
# domain.
|
1488
|
+
#
|
1489
|
+
# * The form content must include all required fields (e.g., `bucketArn`
|
1490
|
+
# for `S3ObjectCollectionForm`).
|
1491
|
+
#
|
1492
|
+
# * The owning project of the original asset must still exist and be
|
1493
|
+
# active.
|
1494
|
+
#
|
1495
|
+
# * User must have write access to the project and domain.
|
1496
|
+
#
|
1408
1497
|
# @option params [String] :client_token
|
1409
1498
|
# A unique, case-sensitive identifier that is provided to ensure the
|
1410
1499
|
# idempotency of the request.
|
@@ -1538,6 +1627,22 @@ module Aws::DataZone
|
|
1538
1627
|
|
1539
1628
|
# Creates a custom asset type.
|
1540
1629
|
#
|
1630
|
+
# Prerequisites:
|
1631
|
+
#
|
1632
|
+
# * The form type with `typeIdentifier` and `typeRevision` must exist
|
1633
|
+
# and be published.
|
1634
|
+
#
|
1635
|
+
# * You must have `CreateAssetType` permissions.
|
1636
|
+
#
|
1637
|
+
# * The domain-identifier and owning-project-identifier must be valid
|
1638
|
+
# and active.
|
1639
|
+
#
|
1640
|
+
# * The name of the asset type must be unique within the domain —
|
1641
|
+
# duplicate names will cause failure.
|
1642
|
+
#
|
1643
|
+
# * JSON input must be valid — incorrect formatting causes Invalid JSON
|
1644
|
+
# errors.
|
1645
|
+
#
|
1541
1646
|
# @option params [String] :description
|
1542
1647
|
# The descripton of the custom asset type.
|
1543
1648
|
#
|
@@ -1910,6 +2015,27 @@ module Aws::DataZone
|
|
1910
2015
|
|
1911
2016
|
# Creates a data product.
|
1912
2017
|
#
|
2018
|
+
# A data product is a comprehensive package that combines data assets
|
2019
|
+
# with their associated metadata, documentation, and access controls.
|
2020
|
+
# It's designed to serve specific business needs or use cases, making
|
2021
|
+
# it easier for users to find and consume data appropriately. Data
|
2022
|
+
# products include important information about data quality, freshness,
|
2023
|
+
# and usage guidelines, effectively bridging the gap between data
|
2024
|
+
# producers and consumers while ensuring proper governance.
|
2025
|
+
#
|
2026
|
+
# Prerequisites:
|
2027
|
+
#
|
2028
|
+
# * The domain must exist and be accessible.
|
2029
|
+
#
|
2030
|
+
# * The owning project must be valid and active.
|
2031
|
+
#
|
2032
|
+
# * The name must be unique within the domain (no existing data product
|
2033
|
+
# with the same name).
|
2034
|
+
#
|
2035
|
+
# * User must have create permissions for data products in the project.
|
2036
|
+
#
|
2037
|
+
# * The domain must have Amazon DataZone publishing enabled.
|
2038
|
+
#
|
1913
2039
|
# @option params [String] :client_token
|
1914
2040
|
# A unique, case-sensitive identifier that is provided to ensure the
|
1915
2041
|
# idempotency of the request.
|
@@ -2020,6 +2146,17 @@ module Aws::DataZone
|
|
2020
2146
|
|
2021
2147
|
# Creates a data product revision.
|
2022
2148
|
#
|
2149
|
+
# Prerequisites:
|
2150
|
+
#
|
2151
|
+
# * The original data product must exist in the given domain.
|
2152
|
+
#
|
2153
|
+
# * User must have permissions on the data product.
|
2154
|
+
#
|
2155
|
+
# * The domain must be valid and accessible.
|
2156
|
+
#
|
2157
|
+
# * The new revision name must comply with naming constraints (if
|
2158
|
+
# required).
|
2159
|
+
#
|
2023
2160
|
# @option params [String] :client_token
|
2024
2161
|
# A unique, case-sensitive identifier that is provided to ensure the
|
2025
2162
|
# idempotency of the request.
|
@@ -2661,6 +2798,7 @@ module Aws::DataZone
|
|
2661
2798
|
# resp.user_parameters[0].field_type #=> String
|
2662
2799
|
# resp.user_parameters[0].is_editable #=> Boolean
|
2663
2800
|
# resp.user_parameters[0].is_optional #=> Boolean
|
2801
|
+
# resp.user_parameters[0].is_update_supported #=> Boolean
|
2664
2802
|
# resp.user_parameters[0].key_name #=> String
|
2665
2803
|
#
|
2666
2804
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CreateEnvironment AWS API Documentation
|
@@ -2733,6 +2871,91 @@ module Aws::DataZone
|
|
2733
2871
|
req.send_request(options)
|
2734
2872
|
end
|
2735
2873
|
|
2874
|
+
# Creates a Amazon DataZone blueprint.
|
2875
|
+
#
|
2876
|
+
# @option params [String] :description
|
2877
|
+
# The description of the Amazon DataZone blueprint.
|
2878
|
+
#
|
2879
|
+
# @option params [required, String] :domain_identifier
|
2880
|
+
# The identifier of the domain in which this blueprint is created.
|
2881
|
+
#
|
2882
|
+
# @option params [required, String] :name
|
2883
|
+
# The name of this Amazon DataZone blueprint.
|
2884
|
+
#
|
2885
|
+
# @option params [required, Types::ProvisioningProperties] :provisioning_properties
|
2886
|
+
# The provisioning properties of this Amazon DataZone blueprint.
|
2887
|
+
#
|
2888
|
+
# @option params [Array<Types::CustomParameter>] :user_parameters
|
2889
|
+
# The user parameters of this Amazon DataZone blueprint.
|
2890
|
+
#
|
2891
|
+
# @return [Types::CreateEnvironmentBlueprintOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2892
|
+
#
|
2893
|
+
# * {Types::CreateEnvironmentBlueprintOutput#created_at #created_at} => Time
|
2894
|
+
# * {Types::CreateEnvironmentBlueprintOutput#deployment_properties #deployment_properties} => Types::DeploymentProperties
|
2895
|
+
# * {Types::CreateEnvironmentBlueprintOutput#description #description} => String
|
2896
|
+
# * {Types::CreateEnvironmentBlueprintOutput#glossary_terms #glossary_terms} => Array<String>
|
2897
|
+
# * {Types::CreateEnvironmentBlueprintOutput#id #id} => String
|
2898
|
+
# * {Types::CreateEnvironmentBlueprintOutput#name #name} => String
|
2899
|
+
# * {Types::CreateEnvironmentBlueprintOutput#provider #provider} => String
|
2900
|
+
# * {Types::CreateEnvironmentBlueprintOutput#provisioning_properties #provisioning_properties} => Types::ProvisioningProperties
|
2901
|
+
# * {Types::CreateEnvironmentBlueprintOutput#updated_at #updated_at} => Time
|
2902
|
+
# * {Types::CreateEnvironmentBlueprintOutput#user_parameters #user_parameters} => Array<Types::CustomParameter>
|
2903
|
+
#
|
2904
|
+
# @example Request syntax with placeholder values
|
2905
|
+
#
|
2906
|
+
# resp = client.create_environment_blueprint({
|
2907
|
+
# description: "Description",
|
2908
|
+
# domain_identifier: "DomainId", # required
|
2909
|
+
# name: "EnvironmentBlueprintName", # required
|
2910
|
+
# provisioning_properties: { # required
|
2911
|
+
# cloud_formation: {
|
2912
|
+
# template_url: "String", # required
|
2913
|
+
# },
|
2914
|
+
# },
|
2915
|
+
# user_parameters: [
|
2916
|
+
# {
|
2917
|
+
# default_value: "String",
|
2918
|
+
# description: "Description",
|
2919
|
+
# field_type: "String", # required
|
2920
|
+
# is_editable: false,
|
2921
|
+
# is_optional: false,
|
2922
|
+
# is_update_supported: false,
|
2923
|
+
# key_name: "CustomParameterKeyNameString", # required
|
2924
|
+
# },
|
2925
|
+
# ],
|
2926
|
+
# })
|
2927
|
+
#
|
2928
|
+
# @example Response structure
|
2929
|
+
#
|
2930
|
+
# resp.created_at #=> Time
|
2931
|
+
# resp.deployment_properties.end_timeout_minutes #=> Integer
|
2932
|
+
# resp.deployment_properties.start_timeout_minutes #=> Integer
|
2933
|
+
# resp.description #=> String
|
2934
|
+
# resp.glossary_terms #=> Array
|
2935
|
+
# resp.glossary_terms[0] #=> String
|
2936
|
+
# resp.id #=> String
|
2937
|
+
# resp.name #=> String
|
2938
|
+
# resp.provider #=> String
|
2939
|
+
# resp.provisioning_properties.cloud_formation.template_url #=> String
|
2940
|
+
# resp.updated_at #=> Time
|
2941
|
+
# resp.user_parameters #=> Array
|
2942
|
+
# resp.user_parameters[0].default_value #=> String
|
2943
|
+
# resp.user_parameters[0].description #=> String
|
2944
|
+
# resp.user_parameters[0].field_type #=> String
|
2945
|
+
# resp.user_parameters[0].is_editable #=> Boolean
|
2946
|
+
# resp.user_parameters[0].is_optional #=> Boolean
|
2947
|
+
# resp.user_parameters[0].is_update_supported #=> Boolean
|
2948
|
+
# resp.user_parameters[0].key_name #=> String
|
2949
|
+
#
|
2950
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CreateEnvironmentBlueprint AWS API Documentation
|
2951
|
+
#
|
2952
|
+
# @overload create_environment_blueprint(params = {})
|
2953
|
+
# @param [Hash] params ({})
|
2954
|
+
def create_environment_blueprint(params = {}, options = {})
|
2955
|
+
req = build_request(:create_environment_blueprint, params)
|
2956
|
+
req.send_request(options)
|
2957
|
+
end
|
2958
|
+
|
2736
2959
|
# Creates an Amazon DataZone environment profile.
|
2737
2960
|
#
|
2738
2961
|
# @option params [String] :aws_account_id
|
@@ -2816,6 +3039,7 @@ module Aws::DataZone
|
|
2816
3039
|
# resp.user_parameters[0].field_type #=> String
|
2817
3040
|
# resp.user_parameters[0].is_editable #=> Boolean
|
2818
3041
|
# resp.user_parameters[0].is_optional #=> Boolean
|
3042
|
+
# resp.user_parameters[0].is_update_supported #=> Boolean
|
2819
3043
|
# resp.user_parameters[0].key_name #=> String
|
2820
3044
|
#
|
2821
3045
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/CreateEnvironmentProfile AWS API Documentation
|
@@ -2829,6 +3053,14 @@ module Aws::DataZone
|
|
2829
3053
|
|
2830
3054
|
# Creates a metadata form type.
|
2831
3055
|
#
|
3056
|
+
# Prerequisites:
|
3057
|
+
#
|
3058
|
+
# * The domain must exist and be in an `ENABLED` state.
|
3059
|
+
#
|
3060
|
+
# * The owning project must exist and be accessible.
|
3061
|
+
#
|
3062
|
+
# * The name must be unique within the domain.
|
3063
|
+
#
|
2832
3064
|
# @option params [String] :description
|
2833
3065
|
# The description of this Amazon DataZone metadata form type.
|
2834
3066
|
#
|
@@ -2893,6 +3125,25 @@ module Aws::DataZone
|
|
2893
3125
|
|
2894
3126
|
# Creates an Amazon DataZone business glossary.
|
2895
3127
|
#
|
3128
|
+
# Specifies that this is a create glossary policy.
|
3129
|
+
#
|
3130
|
+
# A glossary serves as the central repository for business terminology
|
3131
|
+
# and definitions within an organization. It helps establish and
|
3132
|
+
# maintain a common language across different departments and teams,
|
3133
|
+
# reducing miscommunication and ensuring consistent interpretation of
|
3134
|
+
# business concepts. Glossaries can include hierarchical relationships
|
3135
|
+
# between terms, cross-references, and links to actual data assets,
|
3136
|
+
# making them invaluable for both business users and technical teams
|
3137
|
+
# trying to understand and use data correctly.
|
3138
|
+
#
|
3139
|
+
# Prerequisites:
|
3140
|
+
#
|
3141
|
+
# * Domain must exist and be in an active state.
|
3142
|
+
#
|
3143
|
+
# * Owning project must exist and be accessible by the caller.
|
3144
|
+
#
|
3145
|
+
# * The glossary name must be unique within the domain.
|
3146
|
+
#
|
2896
3147
|
# @option params [String] :client_token
|
2897
3148
|
# A unique, case-sensitive identifier that is provided to ensure the
|
2898
3149
|
# idempotency of the request.
|
@@ -2963,6 +3214,27 @@ module Aws::DataZone
|
|
2963
3214
|
|
2964
3215
|
# Creates a business glossary term.
|
2965
3216
|
#
|
3217
|
+
# A glossary term represents an individual entry within the Amazon
|
3218
|
+
# DataZone glossary, serving as a standardized definition for a specific
|
3219
|
+
# business concept or data element. Each term can include rich metadata
|
3220
|
+
# such as detailed definitions, synonyms, related terms, and usage
|
3221
|
+
# examples. Glossary terms can be linked directly to data assets,
|
3222
|
+
# providing business context to technical data elements. This linking
|
3223
|
+
# capability helps users understand the business meaning of data fields
|
3224
|
+
# and ensures consistent interpretation across different systems and
|
3225
|
+
# teams. Terms can also have relationships with other terms, creating a
|
3226
|
+
# semantic network that reflects the complexity of business concepts.
|
3227
|
+
#
|
3228
|
+
# Prerequisites:
|
3229
|
+
#
|
3230
|
+
# * Domain must exist.
|
3231
|
+
#
|
3232
|
+
# * Glossary must exist and be in an ENABLED state.
|
3233
|
+
#
|
3234
|
+
# * The term name must be unique within the glossary.
|
3235
|
+
#
|
3236
|
+
# * Ensure term does not conflict with existing terms in hierarchy.
|
3237
|
+
#
|
2966
3238
|
# @option params [String] :client_token
|
2967
3239
|
# A unique, case-sensitive identifier that is provided to ensure the
|
2968
3240
|
# idempotency of the request.
|
@@ -3960,6 +4232,17 @@ module Aws::DataZone
|
|
3960
4232
|
|
3961
4233
|
# Deletes an asset in Amazon DataZone.
|
3962
4234
|
#
|
4235
|
+
# * --domain-identifier must refer to a valid and existing domain.
|
4236
|
+
#
|
4237
|
+
# * --identifier must refer to an existing asset in the specified
|
4238
|
+
# domain.
|
4239
|
+
#
|
4240
|
+
# * Asset must not be referenced in any existing asset filters.
|
4241
|
+
#
|
4242
|
+
# * Asset must not be linked to any draft or published data product.
|
4243
|
+
#
|
4244
|
+
# * User must have delete permissions for the domain and project.
|
4245
|
+
#
|
3963
4246
|
# @option params [required, String] :domain_identifier
|
3964
4247
|
# The ID of the Amazon DataZone domain in which the asset is deleted.
|
3965
4248
|
#
|
@@ -3986,6 +4269,14 @@ module Aws::DataZone
|
|
3986
4269
|
|
3987
4270
|
# Deletes an asset filter.
|
3988
4271
|
#
|
4272
|
+
# Prerequisites:
|
4273
|
+
#
|
4274
|
+
# * The asset filter must exist.
|
4275
|
+
#
|
4276
|
+
# * The domain and asset must not have been deleted.
|
4277
|
+
#
|
4278
|
+
# * Ensure the --identifier refers to a valid filter ID.
|
4279
|
+
#
|
3989
4280
|
# @option params [required, String] :asset_identifier
|
3990
4281
|
# The ID of the data asset.
|
3991
4282
|
#
|
@@ -4016,6 +4307,18 @@ module Aws::DataZone
|
|
4016
4307
|
|
4017
4308
|
# Deletes an asset type in Amazon DataZone.
|
4018
4309
|
#
|
4310
|
+
# Prerequisites:
|
4311
|
+
#
|
4312
|
+
# * The asset type must exist in the domain.
|
4313
|
+
#
|
4314
|
+
# * You must have DeleteAssetType permission.
|
4315
|
+
#
|
4316
|
+
# * The asset type must not be in use (e.g., assigned to any asset). If
|
4317
|
+
# used, deletion will fail.
|
4318
|
+
#
|
4319
|
+
# * You should retrieve the asset type using get-asset-type to confirm
|
4320
|
+
# its presence before deletion.
|
4321
|
+
#
|
4019
4322
|
# @option params [required, String] :domain_identifier
|
4020
4323
|
# The ID of the Amazon DataZone domain in which the asset type is
|
4021
4324
|
# deleted.
|
@@ -4077,6 +4380,17 @@ module Aws::DataZone
|
|
4077
4380
|
|
4078
4381
|
# Deletes a data product in Amazon DataZone.
|
4079
4382
|
#
|
4383
|
+
# Prerequisites:
|
4384
|
+
#
|
4385
|
+
# * The data product must exist and not be deleted or archived.
|
4386
|
+
#
|
4387
|
+
# * The user must have delete permissions for the data product.
|
4388
|
+
#
|
4389
|
+
# * Ensure there are no active dependencies (e.g., published links,
|
4390
|
+
# assets using the product).
|
4391
|
+
#
|
4392
|
+
# * Domain and project must be active.
|
4393
|
+
#
|
4080
4394
|
# @option params [required, String] :domain_identifier
|
4081
4395
|
# The ID of the Amazon DataZone domain in which the data product is
|
4082
4396
|
# deleted.
|
@@ -4360,6 +4674,33 @@ module Aws::DataZone
|
|
4360
4674
|
req.send_request(options)
|
4361
4675
|
end
|
4362
4676
|
|
4677
|
+
# Deletes a blueprint in Amazon DataZone.
|
4678
|
+
#
|
4679
|
+
# @option params [required, String] :domain_identifier
|
4680
|
+
# The ID of the Amazon DataZone domain in which the blueprint is
|
4681
|
+
# deleted.
|
4682
|
+
#
|
4683
|
+
# @option params [required, String] :identifier
|
4684
|
+
# The ID of the blueprint that is deleted.
|
4685
|
+
#
|
4686
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4687
|
+
#
|
4688
|
+
# @example Request syntax with placeholder values
|
4689
|
+
#
|
4690
|
+
# resp = client.delete_environment_blueprint({
|
4691
|
+
# domain_identifier: "DomainId", # required
|
4692
|
+
# identifier: "EnvironmentBlueprintId", # required
|
4693
|
+
# })
|
4694
|
+
#
|
4695
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/DeleteEnvironmentBlueprint AWS API Documentation
|
4696
|
+
#
|
4697
|
+
# @overload delete_environment_blueprint(params = {})
|
4698
|
+
# @param [Hash] params ({})
|
4699
|
+
def delete_environment_blueprint(params = {}, options = {})
|
4700
|
+
req = build_request(:delete_environment_blueprint, params)
|
4701
|
+
req.send_request(options)
|
4702
|
+
end
|
4703
|
+
|
4363
4704
|
# Deletes the blueprint configuration in Amazon DataZone.
|
4364
4705
|
#
|
4365
4706
|
# @option params [required, String] :domain_identifier
|
@@ -4414,7 +4755,19 @@ module Aws::DataZone
|
|
4414
4755
|
req.send_request(options)
|
4415
4756
|
end
|
4416
4757
|
|
4417
|
-
#
|
4758
|
+
# Deletes and metadata form type in Amazon DataZone.
|
4759
|
+
#
|
4760
|
+
# Prerequisites:
|
4761
|
+
#
|
4762
|
+
# * The form type must exist in the domain.
|
4763
|
+
#
|
4764
|
+
# * The form type must not be in use by any asset types or assets.
|
4765
|
+
#
|
4766
|
+
# * The domain must be valid and accessible.
|
4767
|
+
#
|
4768
|
+
# * User must have delete permissions on the form type.
|
4769
|
+
#
|
4770
|
+
# * Any dependencies (such as linked asset types) must be removed first.
|
4418
4771
|
#
|
4419
4772
|
# @option params [required, String] :domain_identifier
|
4420
4773
|
# The ID of the Amazon DataZone domain in which the metadata form type
|
@@ -4443,6 +4796,19 @@ module Aws::DataZone
|
|
4443
4796
|
|
4444
4797
|
# Deletes a business glossary in Amazon DataZone.
|
4445
4798
|
#
|
4799
|
+
# Prerequisites:
|
4800
|
+
#
|
4801
|
+
# * The glossary must be in DISABLED state.
|
4802
|
+
#
|
4803
|
+
# * The glossary must not have any glossary terms associated with it.
|
4804
|
+
#
|
4805
|
+
# * The glossary must exist in the specified domain.
|
4806
|
+
#
|
4807
|
+
# * The caller must have the `datazone:DeleteGlossary` permission in the
|
4808
|
+
# domain and glossary.
|
4809
|
+
#
|
4810
|
+
# * There should be no active assets or metadata linked to the glossary.
|
4811
|
+
#
|
4446
4812
|
# @option params [required, String] :domain_identifier
|
4447
4813
|
# The ID of the Amazon DataZone domain in which the business glossary is
|
4448
4814
|
# deleted.
|
@@ -4470,6 +4836,17 @@ module Aws::DataZone
|
|
4470
4836
|
|
4471
4837
|
# Deletes a business glossary term in Amazon DataZone.
|
4472
4838
|
#
|
4839
|
+
# Prerequisites:
|
4840
|
+
#
|
4841
|
+
# * Glossary term must exist and be active.
|
4842
|
+
#
|
4843
|
+
# * The term must not be linked to other assets or child terms.
|
4844
|
+
#
|
4845
|
+
# * Caller must have delete permissions in the domain/glossary.
|
4846
|
+
#
|
4847
|
+
# * Ensure all associations (such as to assets or parent terms) are
|
4848
|
+
# removed before deletion.
|
4849
|
+
#
|
4473
4850
|
# @option params [required, String] :domain_identifier
|
4474
4851
|
# The ID of the Amazon DataZone domain in which the business glossary
|
4475
4852
|
# term is deleted.
|
@@ -4945,6 +5322,24 @@ module Aws::DataZone
|
|
4945
5322
|
|
4946
5323
|
# Gets an Amazon DataZone asset.
|
4947
5324
|
#
|
5325
|
+
# An asset is the fundamental building block in Amazon DataZone,
|
5326
|
+
# representing any data resource that needs to be cataloged and managed.
|
5327
|
+
# It can take many forms, from Amazon S3 buckets and database tables to
|
5328
|
+
# dashboards and machine learning models. Each asset contains
|
5329
|
+
# comprehensive metadata about the resource, including its location,
|
5330
|
+
# schema, ownership, and lineage information. Assets are essential for
|
5331
|
+
# organizing and managing data resources across an organization, making
|
5332
|
+
# them discoverable and usable while maintaining proper governance.
|
5333
|
+
#
|
5334
|
+
# Before using the Amazon DataZone GetAsset command, ensure the
|
5335
|
+
# following prerequisites are met:
|
5336
|
+
#
|
5337
|
+
# * Domain identifier must exist and be valid
|
5338
|
+
#
|
5339
|
+
# * Asset identifier must exist
|
5340
|
+
#
|
5341
|
+
# * User must have the required permissions to perform the action
|
5342
|
+
#
|
4948
5343
|
# @option params [required, String] :domain_identifier
|
4949
5344
|
# The ID of the Amazon DataZone domain to which the asset belongs.
|
4950
5345
|
#
|
@@ -5039,6 +5434,15 @@ module Aws::DataZone
|
|
5039
5434
|
|
5040
5435
|
# Gets an asset filter.
|
5041
5436
|
#
|
5437
|
+
# Prerequisites:
|
5438
|
+
#
|
5439
|
+
# * Domain (`--domain-identifier`), asset (`--asset-identifier`), and
|
5440
|
+
# filter (`--identifier`) must all exist.
|
5441
|
+
#
|
5442
|
+
# * The asset filter should not have been deleted.
|
5443
|
+
#
|
5444
|
+
# * The asset must still exist (since the filter is linked to it).
|
5445
|
+
#
|
5042
5446
|
# @option params [required, String] :asset_identifier
|
5043
5447
|
# The ID of the data asset.
|
5044
5448
|
#
|
@@ -5126,6 +5530,24 @@ module Aws::DataZone
|
|
5126
5530
|
|
5127
5531
|
# Gets an Amazon DataZone asset type.
|
5128
5532
|
#
|
5533
|
+
# Asset types define the categories and characteristics of different
|
5534
|
+
# kinds of data assets within Amazon DataZone.. They determine what
|
5535
|
+
# metadata fields are required, what operations are possible, and how
|
5536
|
+
# the asset integrates with other Amazon Web Services services. Asset
|
5537
|
+
# types can range from built-in types like Amazon S3 buckets and Amazon
|
5538
|
+
# Web Services Glue tables to custom types defined for specific
|
5539
|
+
# organizational needs. Understanding asset types is crucial for
|
5540
|
+
# properly organizing and managing different kinds of data resources.
|
5541
|
+
#
|
5542
|
+
# Prerequisites:
|
5543
|
+
#
|
5544
|
+
# * The asset type with identifier must exist in the domain.
|
5545
|
+
# ResourceNotFoundException.
|
5546
|
+
#
|
5547
|
+
# * You must have the GetAssetType permission.
|
5548
|
+
#
|
5549
|
+
# * Ensure the domain-identifier value is correct and accessible.
|
5550
|
+
#
|
5129
5551
|
# @option params [required, String] :domain_identifier
|
5130
5552
|
# The ID of the Amazon DataZone domain in which the asset type exists.
|
5131
5553
|
#
|
@@ -5346,6 +5768,14 @@ module Aws::DataZone
|
|
5346
5768
|
|
5347
5769
|
# Gets the data product.
|
5348
5770
|
#
|
5771
|
+
# Prerequisites:
|
5772
|
+
#
|
5773
|
+
# * The data product ID must exist.
|
5774
|
+
#
|
5775
|
+
# * The domain must be valid and accessible.
|
5776
|
+
#
|
5777
|
+
# * User must have read or discovery permissions for the data product.
|
5778
|
+
#
|
5349
5779
|
# @option params [required, String] :domain_identifier
|
5350
5780
|
# The ID of the domain where the data product lives.
|
5351
5781
|
#
|
@@ -5796,6 +6226,7 @@ module Aws::DataZone
|
|
5796
6226
|
# resp.user_parameters[0].field_type #=> String
|
5797
6227
|
# resp.user_parameters[0].is_editable #=> Boolean
|
5798
6228
|
# resp.user_parameters[0].is_optional #=> Boolean
|
6229
|
+
# resp.user_parameters[0].is_update_supported #=> Boolean
|
5799
6230
|
# resp.user_parameters[0].key_name #=> String
|
5800
6231
|
#
|
5801
6232
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/GetEnvironment AWS API Documentation
|
@@ -5901,6 +6332,7 @@ module Aws::DataZone
|
|
5901
6332
|
# resp.user_parameters[0].field_type #=> String
|
5902
6333
|
# resp.user_parameters[0].is_editable #=> Boolean
|
5903
6334
|
# resp.user_parameters[0].is_optional #=> Boolean
|
6335
|
+
# resp.user_parameters[0].is_update_supported #=> Boolean
|
5904
6336
|
# resp.user_parameters[0].key_name #=> String
|
5905
6337
|
#
|
5906
6338
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/GetEnvironmentBlueprint AWS API Documentation
|
@@ -6057,6 +6489,7 @@ module Aws::DataZone
|
|
6057
6489
|
# resp.user_parameters[0].field_type #=> String
|
6058
6490
|
# resp.user_parameters[0].is_editable #=> Boolean
|
6059
6491
|
# resp.user_parameters[0].is_optional #=> Boolean
|
6492
|
+
# resp.user_parameters[0].is_update_supported #=> Boolean
|
6060
6493
|
# resp.user_parameters[0].key_name #=> String
|
6061
6494
|
#
|
6062
6495
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/GetEnvironmentProfile AWS API Documentation
|
@@ -6070,6 +6503,23 @@ module Aws::DataZone
|
|
6070
6503
|
|
6071
6504
|
# Gets a metadata form type in Amazon DataZone.
|
6072
6505
|
#
|
6506
|
+
# Form types define the structure and validation rules for collecting
|
6507
|
+
# metadata about assets in Amazon DataZone. They act as templates that
|
6508
|
+
# ensure consistent metadata capture across similar types of assets,
|
6509
|
+
# while allowing for customization to meet specific organizational
|
6510
|
+
# needs. Form types can include required fields, validation rules, and
|
6511
|
+
# dependencies, helping maintain high-quality metadata that makes data
|
6512
|
+
# assets more discoverable and usable.
|
6513
|
+
#
|
6514
|
+
# * The form type with the specified identifier must exist in the given
|
6515
|
+
# domain.
|
6516
|
+
#
|
6517
|
+
# * The domain must be valid and active.
|
6518
|
+
#
|
6519
|
+
# * User must have permission on the form type.
|
6520
|
+
#
|
6521
|
+
# * The form type should not be deleted or in an invalid state.
|
6522
|
+
#
|
6073
6523
|
# @option params [required, String] :domain_identifier
|
6074
6524
|
# The ID of the Amazon DataZone domain in which this metadata form type
|
6075
6525
|
# exists.
|
@@ -6131,6 +6581,14 @@ module Aws::DataZone
|
|
6131
6581
|
|
6132
6582
|
# Gets a business glossary in Amazon DataZone.
|
6133
6583
|
#
|
6584
|
+
# Prerequisites:
|
6585
|
+
#
|
6586
|
+
# * The specified glossary ID must exist and be associated with the
|
6587
|
+
# given domain.
|
6588
|
+
#
|
6589
|
+
# * The caller must have the `datazone:GetGlossary` permission on the
|
6590
|
+
# domain.
|
6591
|
+
#
|
6134
6592
|
# @option params [required, String] :domain_identifier
|
6135
6593
|
# The ID of the Amazon DataZone domain in which this business glossary
|
6136
6594
|
# exists.
|
@@ -6185,6 +6643,14 @@ module Aws::DataZone
|
|
6185
6643
|
|
6186
6644
|
# Gets a business glossary term in Amazon DataZone.
|
6187
6645
|
#
|
6646
|
+
# Prerequisites:
|
6647
|
+
#
|
6648
|
+
# * Glossary term with identifier must exist in the domain.
|
6649
|
+
#
|
6650
|
+
# * User must have permission on the glossary term.
|
6651
|
+
#
|
6652
|
+
# * Domain must be accessible and active.
|
6653
|
+
#
|
6188
6654
|
# @option params [required, String] :domain_identifier
|
6189
6655
|
# The ID of the Amazon DataZone domain in which this business glossary
|
6190
6656
|
# term exists.
|
@@ -6587,6 +7053,14 @@ module Aws::DataZone
|
|
6587
7053
|
|
6588
7054
|
# Gets a metadata generation run in Amazon DataZone.
|
6589
7055
|
#
|
7056
|
+
# Prerequisites:
|
7057
|
+
#
|
7058
|
+
# * Valid domain and run identifier.
|
7059
|
+
#
|
7060
|
+
# * The metadata generation run must exist.
|
7061
|
+
#
|
7062
|
+
# * User must have read access to the metadata run.
|
7063
|
+
#
|
6590
7064
|
# @option params [required, String] :domain_identifier
|
6591
7065
|
# The ID of the Amazon DataZone domain the metadata generation run of
|
6592
7066
|
# which you want to get.
|
@@ -7404,6 +7878,12 @@ module Aws::DataZone
|
|
7404
7878
|
|
7405
7879
|
# Lists asset filters.
|
7406
7880
|
#
|
7881
|
+
# Prerequisites:
|
7882
|
+
#
|
7883
|
+
# * A valid domain and asset must exist.
|
7884
|
+
#
|
7885
|
+
# * The asset must have at least one filter created to return results.
|
7886
|
+
#
|
7407
7887
|
# @option params [required, String] :asset_identifier
|
7408
7888
|
# The ID of the data asset.
|
7409
7889
|
#
|
@@ -7472,6 +7952,17 @@ module Aws::DataZone
|
|
7472
7952
|
|
7473
7953
|
# Lists the revisions for the asset.
|
7474
7954
|
#
|
7955
|
+
# Prerequisites:
|
7956
|
+
#
|
7957
|
+
# * The asset must exist in the domain.
|
7958
|
+
#
|
7959
|
+
# * There must be at least one revision of the asset (which happens
|
7960
|
+
# automatically after creation).
|
7961
|
+
#
|
7962
|
+
# * The domain must be valid and active.
|
7963
|
+
#
|
7964
|
+
# * User must have permissions on the asset and domain.
|
7965
|
+
#
|
7475
7966
|
# @option params [required, String] :domain_identifier
|
7476
7967
|
# The identifier of the domain.
|
7477
7968
|
#
|
@@ -7710,6 +8201,14 @@ module Aws::DataZone
|
|
7710
8201
|
|
7711
8202
|
# Lists data product revisions.
|
7712
8203
|
#
|
8204
|
+
# Prerequisites:
|
8205
|
+
#
|
8206
|
+
# * The data product ID must exist within the domain.
|
8207
|
+
#
|
8208
|
+
# * User must have view permissions on the data product.
|
8209
|
+
#
|
8210
|
+
# * The domain must be in a valid and accessible state.
|
8211
|
+
#
|
7713
8212
|
# @option params [required, String] :domain_identifier
|
7714
8213
|
# The ID of the domain of the data product revisions that you want to
|
7715
8214
|
# list.
|
@@ -8797,6 +9296,20 @@ module Aws::DataZone
|
|
8797
9296
|
|
8798
9297
|
# Lists all metadata generation runs.
|
8799
9298
|
#
|
9299
|
+
# Metadata generation runs represent automated processes that leverage
|
9300
|
+
# AI/ML capabilities to create or enhance asset metadata at scale. This
|
9301
|
+
# feature helps organizations maintain comprehensive and consistent
|
9302
|
+
# metadata across large numbers of assets without manual intervention.
|
9303
|
+
# It can automatically generate business descriptions, tags, and other
|
9304
|
+
# metadata elements, significantly reducing the time and effort required
|
9305
|
+
# for metadata management while improving consistency and completeness.
|
9306
|
+
#
|
9307
|
+
# Prerequisites:
|
9308
|
+
#
|
9309
|
+
# * Valid domain identifier.
|
9310
|
+
#
|
9311
|
+
# * User must have access to metadata generation runs in the domain.
|
9312
|
+
#
|
8800
9313
|
# @option params [required, String] :domain_identifier
|
8801
9314
|
# The ID of the Amazon DataZone domain where you want to list metadata
|
8802
9315
|
# generation runs.
|
@@ -10020,6 +10533,9 @@ module Aws::DataZone
|
|
10020
10533
|
# @option params [String] :environment_role_permission_boundary
|
10021
10534
|
# The environment role permissions boundary.
|
10022
10535
|
#
|
10536
|
+
# @option params [Hash<String,String>] :global_parameters
|
10537
|
+
# Region-agnostic environment blueprint parameters.
|
10538
|
+
#
|
10023
10539
|
# @option params [String] :manage_access_role_arn
|
10024
10540
|
# The ARN of the manage access role.
|
10025
10541
|
#
|
@@ -10052,6 +10568,9 @@ module Aws::DataZone
|
|
10052
10568
|
# enabled_regions: ["RegionName"], # required
|
10053
10569
|
# environment_blueprint_identifier: "EnvironmentBlueprintId", # required
|
10054
10570
|
# environment_role_permission_boundary: "PolicyArn",
|
10571
|
+
# global_parameters: {
|
10572
|
+
# "String" => "String",
|
10573
|
+
# },
|
10055
10574
|
# manage_access_role_arn: "RoleArn",
|
10056
10575
|
# provisioning_configurations: [
|
10057
10576
|
# {
|
@@ -10479,6 +10998,39 @@ module Aws::DataZone
|
|
10479
10998
|
|
10480
10999
|
# Searches for assets in Amazon DataZone.
|
10481
11000
|
#
|
11001
|
+
# Search in Amazon DataZone is a powerful capability that enables users
|
11002
|
+
# to discover and explore data assets, glossary terms, and data products
|
11003
|
+
# across their organization. It provides both basic and advanced search
|
11004
|
+
# functionality, allowing users to find resources based on names,
|
11005
|
+
# descriptions, metadata, and other attributes. Search can be scoped to
|
11006
|
+
# specific types of resources (like assets, glossary terms, or data
|
11007
|
+
# products) and can be filtered using various criteria such as creation
|
11008
|
+
# date, owner, or status. The search functionality is essential for
|
11009
|
+
# making the wealth of data resources in an organization discoverable
|
11010
|
+
# and usable, helping users find the right data for their needs quickly
|
11011
|
+
# and efficiently.
|
11012
|
+
#
|
11013
|
+
# Many search commands in Amazon DataZone are paginated, including
|
11014
|
+
# `search` and `search-types`. When the result set is large, Amazon
|
11015
|
+
# DataZone returns a `nextToken` in the response. This token can be used
|
11016
|
+
# to retrieve the next page of results.
|
11017
|
+
#
|
11018
|
+
# Prerequisites:
|
11019
|
+
#
|
11020
|
+
# * The --domain-identifier must refer to an existing Amazon DataZone
|
11021
|
+
# domain.
|
11022
|
+
#
|
11023
|
+
# * --search-scope must be one of: ASSET, GLOSSARY\_TERM, DATA\_PRODUCT,
|
11024
|
+
# or GLOSSARY.
|
11025
|
+
#
|
11026
|
+
# * The user must have search permissions in the specified domain.
|
11027
|
+
#
|
11028
|
+
# * If using --filters, ensure that the JSON is well-formed and that
|
11029
|
+
# each filter includes valid attribute and value keys.
|
11030
|
+
#
|
11031
|
+
# * For paginated results, be prepared to use --next-token to fetch
|
11032
|
+
# additional pages.
|
11033
|
+
#
|
10482
11034
|
# @option params [Array<String>] :additional_attributes
|
10483
11035
|
# Specifies additional attributes for the `Search` action.
|
10484
11036
|
#
|
@@ -10913,6 +11465,23 @@ module Aws::DataZone
|
|
10913
11465
|
|
10914
11466
|
# Searches for types in Amazon DataZone.
|
10915
11467
|
#
|
11468
|
+
# Prerequisites:
|
11469
|
+
#
|
11470
|
+
# * The --domain-identifier must refer to an existing Amazon DataZone
|
11471
|
+
# domain.
|
11472
|
+
#
|
11473
|
+
# * --search-scope must be one of the valid values including:
|
11474
|
+
# ASSET\_TYPE, GLOSSARY\_TERM\_TYPE, DATA\_PRODUCT\_TYPE.
|
11475
|
+
#
|
11476
|
+
# * The --managed flag must be present without a value.
|
11477
|
+
#
|
11478
|
+
# * The user must have permissions for form or asset types in the
|
11479
|
+
# domain.
|
11480
|
+
#
|
11481
|
+
# * If using --filters, ensure that the JSON is valid.
|
11482
|
+
#
|
11483
|
+
# * Filters contain correct structure (attribute, value, operator).
|
11484
|
+
#
|
10916
11485
|
# @option params [required, String] :domain_identifier
|
10917
11486
|
# The identifier of the Amazon DataZone domain in which to invoke the
|
10918
11487
|
# `SearchTypes` action.
|
@@ -11188,6 +11757,21 @@ module Aws::DataZone
|
|
11188
11757
|
|
11189
11758
|
# Starts the metadata generation run.
|
11190
11759
|
#
|
11760
|
+
# Prerequisites:
|
11761
|
+
#
|
11762
|
+
# * Asset must be created and belong to the specified domain and
|
11763
|
+
# project.
|
11764
|
+
#
|
11765
|
+
# * Asset type must be supported for metadata generation (e.g., Amazon
|
11766
|
+
# Web Services Glue table).
|
11767
|
+
#
|
11768
|
+
# * Asset must have a structured schema with valid rows and columns.
|
11769
|
+
#
|
11770
|
+
# * Valid values for --type: BUSINESS\_DESCRIPTIONS, BUSINESS\_NAMES.
|
11771
|
+
#
|
11772
|
+
# * The user must have permission to run metadata generation in the
|
11773
|
+
# domain/project.
|
11774
|
+
#
|
11191
11775
|
# @option params [String] :client_token
|
11192
11776
|
# A unique, case-sensitive identifier to ensure idempotency of the
|
11193
11777
|
# request. This field is automatically populated if not provided.
|
@@ -11397,6 +11981,15 @@ module Aws::DataZone
|
|
11397
11981
|
|
11398
11982
|
# Updates an asset filter.
|
11399
11983
|
#
|
11984
|
+
# Prerequisites:
|
11985
|
+
#
|
11986
|
+
# * The domain, asset, and asset filter identifier must all exist.
|
11987
|
+
#
|
11988
|
+
# * The asset must contain the columns being referenced in the update.
|
11989
|
+
#
|
11990
|
+
# * If applying a row filter, ensure the column referenced in the
|
11991
|
+
# expression exists in the asset schema.
|
11992
|
+
#
|
11400
11993
|
# @option params [required, String] :asset_identifier
|
11401
11994
|
# The ID of the data asset.
|
11402
11995
|
#
|
@@ -12260,6 +12853,7 @@ module Aws::DataZone
|
|
12260
12853
|
# resp.user_parameters[0].field_type #=> String
|
12261
12854
|
# resp.user_parameters[0].is_editable #=> Boolean
|
12262
12855
|
# resp.user_parameters[0].is_optional #=> Boolean
|
12856
|
+
# resp.user_parameters[0].is_update_supported #=> Boolean
|
12263
12857
|
# resp.user_parameters[0].key_name #=> String
|
12264
12858
|
#
|
12265
12859
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/UpdateEnvironment AWS API Documentation
|
@@ -12333,6 +12927,95 @@ module Aws::DataZone
|
|
12333
12927
|
req.send_request(options)
|
12334
12928
|
end
|
12335
12929
|
|
12930
|
+
# Updates an environment blueprint in Amazon DataZone.
|
12931
|
+
#
|
12932
|
+
# @option params [String] :description
|
12933
|
+
# The description to be updated as part of the
|
12934
|
+
# `UpdateEnvironmentBlueprint` action.
|
12935
|
+
#
|
12936
|
+
# @option params [required, String] :domain_identifier
|
12937
|
+
# The identifier of the Amazon DataZone domain in which an environment
|
12938
|
+
# blueprint is to be updated.
|
12939
|
+
#
|
12940
|
+
# @option params [required, String] :identifier
|
12941
|
+
# The identifier of the environment blueprint to be updated.
|
12942
|
+
#
|
12943
|
+
# @option params [Types::ProvisioningProperties] :provisioning_properties
|
12944
|
+
# The provisioning properties to be updated as part of the
|
12945
|
+
# `UpdateEnvironmentBlueprint` action.
|
12946
|
+
#
|
12947
|
+
# @option params [Array<Types::CustomParameter>] :user_parameters
|
12948
|
+
# The user parameters to be updated as part of the
|
12949
|
+
# `UpdateEnvironmentBlueprint` action.
|
12950
|
+
#
|
12951
|
+
# @return [Types::UpdateEnvironmentBlueprintOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12952
|
+
#
|
12953
|
+
# * {Types::UpdateEnvironmentBlueprintOutput#created_at #created_at} => Time
|
12954
|
+
# * {Types::UpdateEnvironmentBlueprintOutput#deployment_properties #deployment_properties} => Types::DeploymentProperties
|
12955
|
+
# * {Types::UpdateEnvironmentBlueprintOutput#description #description} => String
|
12956
|
+
# * {Types::UpdateEnvironmentBlueprintOutput#glossary_terms #glossary_terms} => Array<String>
|
12957
|
+
# * {Types::UpdateEnvironmentBlueprintOutput#id #id} => String
|
12958
|
+
# * {Types::UpdateEnvironmentBlueprintOutput#name #name} => String
|
12959
|
+
# * {Types::UpdateEnvironmentBlueprintOutput#provider #provider} => String
|
12960
|
+
# * {Types::UpdateEnvironmentBlueprintOutput#provisioning_properties #provisioning_properties} => Types::ProvisioningProperties
|
12961
|
+
# * {Types::UpdateEnvironmentBlueprintOutput#updated_at #updated_at} => Time
|
12962
|
+
# * {Types::UpdateEnvironmentBlueprintOutput#user_parameters #user_parameters} => Array<Types::CustomParameter>
|
12963
|
+
#
|
12964
|
+
# @example Request syntax with placeholder values
|
12965
|
+
#
|
12966
|
+
# resp = client.update_environment_blueprint({
|
12967
|
+
# description: "String",
|
12968
|
+
# domain_identifier: "DomainId", # required
|
12969
|
+
# identifier: "EnvironmentBlueprintId", # required
|
12970
|
+
# provisioning_properties: {
|
12971
|
+
# cloud_formation: {
|
12972
|
+
# template_url: "String", # required
|
12973
|
+
# },
|
12974
|
+
# },
|
12975
|
+
# user_parameters: [
|
12976
|
+
# {
|
12977
|
+
# default_value: "String",
|
12978
|
+
# description: "Description",
|
12979
|
+
# field_type: "String", # required
|
12980
|
+
# is_editable: false,
|
12981
|
+
# is_optional: false,
|
12982
|
+
# is_update_supported: false,
|
12983
|
+
# key_name: "CustomParameterKeyNameString", # required
|
12984
|
+
# },
|
12985
|
+
# ],
|
12986
|
+
# })
|
12987
|
+
#
|
12988
|
+
# @example Response structure
|
12989
|
+
#
|
12990
|
+
# resp.created_at #=> Time
|
12991
|
+
# resp.deployment_properties.end_timeout_minutes #=> Integer
|
12992
|
+
# resp.deployment_properties.start_timeout_minutes #=> Integer
|
12993
|
+
# resp.description #=> String
|
12994
|
+
# resp.glossary_terms #=> Array
|
12995
|
+
# resp.glossary_terms[0] #=> String
|
12996
|
+
# resp.id #=> String
|
12997
|
+
# resp.name #=> String
|
12998
|
+
# resp.provider #=> String
|
12999
|
+
# resp.provisioning_properties.cloud_formation.template_url #=> String
|
13000
|
+
# resp.updated_at #=> Time
|
13001
|
+
# resp.user_parameters #=> Array
|
13002
|
+
# resp.user_parameters[0].default_value #=> String
|
13003
|
+
# resp.user_parameters[0].description #=> String
|
13004
|
+
# resp.user_parameters[0].field_type #=> String
|
13005
|
+
# resp.user_parameters[0].is_editable #=> Boolean
|
13006
|
+
# resp.user_parameters[0].is_optional #=> Boolean
|
13007
|
+
# resp.user_parameters[0].is_update_supported #=> Boolean
|
13008
|
+
# resp.user_parameters[0].key_name #=> String
|
13009
|
+
#
|
13010
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/UpdateEnvironmentBlueprint AWS API Documentation
|
13011
|
+
#
|
13012
|
+
# @overload update_environment_blueprint(params = {})
|
13013
|
+
# @param [Hash] params ({})
|
13014
|
+
def update_environment_blueprint(params = {}, options = {})
|
13015
|
+
req = build_request(:update_environment_blueprint, params)
|
13016
|
+
req.send_request(options)
|
13017
|
+
end
|
13018
|
+
|
12336
13019
|
# Updates the specified environment profile in Amazon DataZone.
|
12337
13020
|
#
|
12338
13021
|
# @option params [String] :aws_account_id
|
@@ -12413,6 +13096,7 @@ module Aws::DataZone
|
|
12413
13096
|
# resp.user_parameters[0].field_type #=> String
|
12414
13097
|
# resp.user_parameters[0].is_editable #=> Boolean
|
12415
13098
|
# resp.user_parameters[0].is_optional #=> Boolean
|
13099
|
+
# resp.user_parameters[0].is_update_supported #=> Boolean
|
12416
13100
|
# resp.user_parameters[0].key_name #=> String
|
12417
13101
|
#
|
12418
13102
|
# @see http://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/UpdateEnvironmentProfile AWS API Documentation
|
@@ -12426,6 +13110,18 @@ module Aws::DataZone
|
|
12426
13110
|
|
12427
13111
|
# Updates the business glossary in Amazon DataZone.
|
12428
13112
|
#
|
13113
|
+
# Prerequisites:
|
13114
|
+
#
|
13115
|
+
# * The glossary must exist in the given domain.
|
13116
|
+
#
|
13117
|
+
# * The caller must have the `datazone:UpdateGlossary` permission to
|
13118
|
+
# update it.
|
13119
|
+
#
|
13120
|
+
# * When updating the name, the new name must be unique within the
|
13121
|
+
# domain.
|
13122
|
+
#
|
13123
|
+
# * The glossary must not be deleted or in a terminal state.
|
13124
|
+
#
|
12429
13125
|
# @option params [String] :client_token
|
12430
13126
|
# A unique, case-sensitive identifier that is provided to ensure the
|
12431
13127
|
# idempotency of the request.
|
@@ -12492,6 +13188,16 @@ module Aws::DataZone
|
|
12492
13188
|
|
12493
13189
|
# Updates a business glossary term in Amazon DataZone.
|
12494
13190
|
#
|
13191
|
+
# Prerequisites:
|
13192
|
+
#
|
13193
|
+
# * Glossary term must exist in the specified domain.
|
13194
|
+
#
|
13195
|
+
# * New name must not conflict with existing terms in the same glossary.
|
13196
|
+
#
|
13197
|
+
# * User must have permissions on the term.
|
13198
|
+
#
|
13199
|
+
# * The term must not be in DELETED status.
|
13200
|
+
#
|
12495
13201
|
# @option params [required, String] :domain_identifier
|
12496
13202
|
# The identifier of the Amazon DataZone domain in which a business
|
12497
13203
|
# glossary term is to be updated.
|
@@ -13348,7 +14054,7 @@ module Aws::DataZone
|
|
13348
14054
|
tracer: tracer
|
13349
14055
|
)
|
13350
14056
|
context[:gem_name] = 'aws-sdk-datazone'
|
13351
|
-
context[:gem_version] = '1.
|
14057
|
+
context[:gem_version] = '1.51.0'
|
13352
14058
|
Seahorse::Client::Request.new(handlers, context)
|
13353
14059
|
end
|
13354
14060
|
|