@aws-sdk/client-datazone 3.908.0 → 3.911.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.
@@ -1,4 +1,119 @@
1
- import { AccountInfo, AccountPoolSummary, AccountSource, ActionParameters, AssetFilterSummary, AssetListing, AssetRevision, AssetScope, AssetTargetNameMap, AssetTypesForRule, ConfigurableEnvironmentAction, ConnectionCredentials, ConnectionPropertiesOutput, ConnectionSummary, ConnectionType, CustomParameter, DataProductItem, DataProductStatus, DataSourceConfigurationInput, DataSourceConfigurationOutput, DataSourceErrorMessage, DataSourceRunStatus, DataSourceStatus, DataZoneEntityType, Deployment, DeploymentProperties, DetailedGlossaryTerm, DomainStatus, DomainUnitOwnerProperties, DomainVersion, EnableSetting, EnvironmentConfiguration, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, EnvironmentStatus, FilterStatus, FormInput, FormOutput, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GlossaryUsageRestriction, GovernedEntityType, GroupProfileStatus, ListingStatus, ManagedPolicyType, MatchRationaleItem, Member, Model, PhysicalEndpoint, PolicyGrantDetail, PolicyGrantPrincipal, ProjectDeletionError, ProjectStatus, ProvisioningProperties, RecommendationConfiguration, ResolutionStrategy, Resource, RuleScopeSelectionMode, ScheduleConfiguration, SingleSignOn, Status, SubscribedListing, SubscribedPrincipal, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, TermRelations, TimeSeriesDataPointSummaryFormOutput, UserDesignation } from "./models_0";
1
+ import { AccountInfo, AccountPoolSummary, AccountSource, ActionParameters, AssetFilterSummary, AssetListing, AssetRevision, AssetScope, AssetTargetNameMap, AssetTypesForRule, AwsAccount, ConfigurableEnvironmentAction, ConnectionCredentials, ConnectionPropertiesOutput, ConnectionScope, ConnectionSummary, ConnectionType, CustomParameter, DataProductItem, DataProductStatus, DataSourceConfigurationInput, DataSourceConfigurationOutput, DataSourceErrorMessage, DataSourceRunStatus, DataSourceStatus, DataZoneEntityType, Deployment, DeploymentProperties, DetailedGlossaryTerm, DomainStatus, DomainUnitOwnerProperties, DomainVersion, EnableSetting, EnvironmentConfigurationParametersDetails, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, EnvironmentStatus, FilterStatus, FormInput, FormOutput, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GlossaryUsageRestriction, GovernedEntityType, GroupProfileStatus, ListingStatus, ManagedPolicyType, MatchRationaleItem, Member, Model, PhysicalEndpoint, PolicyGrantDetail, PolicyGrantPrincipal, ProjectDeletionError, ProjectStatus, ProvisioningProperties, RecommendationConfiguration, Region, ResolutionStrategy, Resource, RuleScopeSelectionMode, ScheduleConfiguration, SingleSignOn, SubscribedListing, SubscribedPrincipal, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, TermRelations, UserDesignation } from "./models_0";
2
+ /**
3
+ * @public
4
+ * @enum
5
+ */
6
+ export declare const DeploymentMode: {
7
+ readonly ON_CREATE: "ON_CREATE";
8
+ readonly ON_DEMAND: "ON_DEMAND";
9
+ };
10
+ /**
11
+ * @public
12
+ */
13
+ export type DeploymentMode = (typeof DeploymentMode)[keyof typeof DeploymentMode];
14
+ /**
15
+ * <p>The configuration of an environment.</p>
16
+ * @public
17
+ */
18
+ export interface EnvironmentConfiguration {
19
+ /**
20
+ * <p>The environment name.</p>
21
+ * @public
22
+ */
23
+ name: string | undefined;
24
+ /**
25
+ * <p>The environment ID.</p>
26
+ * @public
27
+ */
28
+ id?: string | undefined;
29
+ /**
30
+ * <p>The environment blueprint ID.</p>
31
+ * @public
32
+ */
33
+ environmentBlueprintId: string | undefined;
34
+ /**
35
+ * <p>The environment description.</p>
36
+ * @public
37
+ */
38
+ description?: string | undefined;
39
+ /**
40
+ * <p>The deployment mode of the environment.</p>
41
+ * @public
42
+ */
43
+ deploymentMode?: DeploymentMode | undefined;
44
+ /**
45
+ * <p>The configuration parameters of the environment.</p>
46
+ * @public
47
+ */
48
+ configurationParameters?: EnvironmentConfigurationParametersDetails | undefined;
49
+ /**
50
+ * <p>The Amazon Web Services account of the environment.</p>
51
+ * @public
52
+ */
53
+ awsAccount?: AwsAccount | undefined;
54
+ /**
55
+ * <p>The account pools used by a custom project profile.</p>
56
+ * @public
57
+ */
58
+ accountPools?: string[] | undefined;
59
+ /**
60
+ * <p>The Amazon Web Services Region of the environment.</p>
61
+ * @public
62
+ */
63
+ awsRegion?: Region | undefined;
64
+ /**
65
+ * <p>The deployment order of the environment.</p>
66
+ * @public
67
+ */
68
+ deploymentOrder?: number | undefined;
69
+ }
70
+ /**
71
+ * @public
72
+ * @enum
73
+ */
74
+ export declare const Status: {
75
+ readonly DISABLED: "DISABLED";
76
+ readonly ENABLED: "ENABLED";
77
+ };
78
+ /**
79
+ * @public
80
+ */
81
+ export type Status = (typeof Status)[keyof typeof Status];
82
+ /**
83
+ * @public
84
+ */
85
+ export interface CreateProjectProfileInput {
86
+ /**
87
+ * <p>A domain ID of the project profile.</p>
88
+ * @public
89
+ */
90
+ domainIdentifier: string | undefined;
91
+ /**
92
+ * <p>Project profile name.</p>
93
+ * @public
94
+ */
95
+ name: string | undefined;
96
+ /**
97
+ * <p>A description of a project profile.</p>
98
+ * @public
99
+ */
100
+ description?: string | undefined;
101
+ /**
102
+ * <p>Project profile status.</p>
103
+ * @public
104
+ */
105
+ status?: Status | undefined;
106
+ /**
107
+ * <p>Environment configurations of the project profile.</p>
108
+ * @public
109
+ */
110
+ environmentConfigurations?: EnvironmentConfiguration[] | undefined;
111
+ /**
112
+ * <p>A domain unit ID of the project profile.</p>
113
+ * @public
114
+ */
115
+ domainUnitIdentifier?: string | undefined;
116
+ }
2
117
  /**
3
118
  * @public
4
119
  */
@@ -609,7 +724,7 @@ export interface CreateSubscriptionGrantOutput {
609
724
  /**
610
725
  * <p>The identifier of the subscription grant.</p>
611
726
  *
612
- * @deprecated
727
+ * @deprecated Multiple subscriptions can exist for a single grant
613
728
  * @public
614
729
  */
615
730
  subscriptionId?: string | undefined;
@@ -1523,7 +1638,7 @@ export interface DeleteDataSourceInput {
1523
1638
  /**
1524
1639
  * <p>A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>
1525
1640
  *
1526
- * @deprecated
1641
+ * @deprecated This field is no longer required for idempotency.
1527
1642
  * @public
1528
1643
  */
1529
1644
  clientToken?: string | undefined;
@@ -2948,7 +3063,7 @@ export interface DeleteSubscriptionGrantOutput {
2948
3063
  /**
2949
3064
  * <p>The identifier of the subsctiption whose subscription grant is to be deleted.</p>
2950
3065
  *
2951
- * @deprecated
3066
+ * @deprecated Multiple subscriptions can exist for a single grant
2952
3067
  * @public
2953
3068
  */
2954
3069
  subscriptionId?: string | undefined;
@@ -4244,6 +4359,11 @@ export interface GetConnectionOutput {
4244
4359
  * @public
4245
4360
  */
4246
4361
  type: ConnectionType | undefined;
4362
+ /**
4363
+ * <p>The scope of the connection.</p>
4364
+ * @public
4365
+ */
4366
+ scope?: ConnectionScope | undefined;
4247
4367
  }
4248
4368
  /**
4249
4369
  * @public
@@ -5367,7 +5487,7 @@ export interface GetSubscriptionGrantOutput {
5367
5487
  /**
5368
5488
  * <p>The identifier of the subscription.</p>
5369
5489
  *
5370
- * @deprecated
5490
+ * @deprecated Multiple subscriptions can exist for a single grant
5371
5491
  * @public
5372
5492
  */
5373
5493
  subscriptionId?: string | undefined;
@@ -6330,12 +6450,17 @@ export interface ListConnectionsInput {
6330
6450
  * <p>The ID of the project where you want to list connections.</p>
6331
6451
  * @public
6332
6452
  */
6333
- projectIdentifier: string | undefined;
6453
+ projectIdentifier?: string | undefined;
6334
6454
  /**
6335
6455
  * <p>The type of connection.</p>
6336
6456
  * @public
6337
6457
  */
6338
6458
  type?: ConnectionType | undefined;
6459
+ /**
6460
+ * <p>The scope of the connection.</p>
6461
+ * @public
6462
+ */
6463
+ scope?: ConnectionScope | undefined;
6339
6464
  }
6340
6465
  /**
6341
6466
  * @public
@@ -8327,7 +8452,7 @@ export interface SubscriptionGrantSummary {
8327
8452
  /**
8328
8453
  * <p>The ID of the subscription.</p>
8329
8454
  *
8330
- * @deprecated
8455
+ * @deprecated Multiple subscriptions can exist for a single grant
8331
8456
  * @public
8332
8457
  */
8333
8458
  subscriptionId?: string | undefined;
@@ -8792,95 +8917,13 @@ export interface ListTagsForResourceResponse {
8792
8917
  tags?: Record<string, string> | undefined;
8793
8918
  }
8794
8919
  /**
8795
- * @public
8796
- */
8797
- export interface ListTimeSeriesDataPointsInput {
8798
- /**
8799
- * <p>The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points.</p>
8800
- * @public
8801
- */
8802
- domainIdentifier: string | undefined;
8803
- /**
8804
- * <p>The ID of the asset for which you want to list data points.</p>
8805
- * @public
8806
- */
8807
- entityIdentifier: string | undefined;
8808
- /**
8809
- * <p>The type of the asset for which you want to list data points.</p>
8810
- * @public
8811
- */
8812
- entityType: TimeSeriesEntityType | undefined;
8813
- /**
8814
- * <p>The name of the time series data points form.</p>
8815
- * @public
8816
- */
8817
- formName: string | undefined;
8818
- /**
8819
- * <p>The timestamp at which the data points that you want to list started.</p>
8820
- * @public
8821
- */
8822
- startedAt?: Date | undefined;
8823
- /**
8824
- * <p>The timestamp at which the data points that you wanted to list ended.</p>
8825
- * @public
8826
- */
8827
- endedAt?: Date | undefined;
8828
- /**
8829
- * <p>When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.</p>
8830
- * @public
8831
- */
8832
- nextToken?: string | undefined;
8833
- /**
8834
- * <p>The maximum number of data points to return in a single call to ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.</p>
8835
- * @public
8836
- */
8837
- maxResults?: number | undefined;
8838
- }
8839
- /**
8840
- * @public
8841
- */
8842
- export interface ListTimeSeriesDataPointsOutput {
8843
- /**
8844
- * <p>The results of the ListTimeSeriesDataPoints action. </p>
8845
- * @public
8846
- */
8847
- items?: TimeSeriesDataPointSummaryFormOutput[] | undefined;
8848
- /**
8849
- * <p>When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.</p>
8850
- * @public
8851
- */
8852
- nextToken?: string | undefined;
8853
- }
8854
- /**
8855
- * @public
8856
- */
8857
- export interface GetMetadataGenerationRunInput {
8858
- /**
8859
- * <p>The ID of the Amazon DataZone domain the metadata generation run of which you want to get.</p>
8860
- * @public
8861
- */
8862
- domainIdentifier: string | undefined;
8863
- /**
8864
- * <p>The identifier of the metadata generation run.</p>
8865
- * @public
8866
- */
8867
- identifier: string | undefined;
8868
- }
8869
- /**
8870
- * @public
8871
- * @enum
8920
+ * @internal
8872
8921
  */
8873
- export declare const MetadataGenerationRunStatus: {
8874
- readonly CANCELED: "CANCELED";
8875
- readonly FAILED: "FAILED";
8876
- readonly IN_PROGRESS: "IN_PROGRESS";
8877
- readonly SUBMITTED: "SUBMITTED";
8878
- readonly SUCCEEDED: "SUCCEEDED";
8879
- };
8922
+ export declare const EnvironmentConfigurationFilterSensitiveLog: (obj: EnvironmentConfiguration) => any;
8880
8923
  /**
8881
- * @public
8924
+ * @internal
8882
8925
  */
8883
- export type MetadataGenerationRunStatus = (typeof MetadataGenerationRunStatus)[keyof typeof MetadataGenerationRunStatus];
8926
+ export declare const CreateProjectProfileInputFilterSensitiveLog: (obj: CreateProjectProfileInput) => any;
8884
8927
  /**
8885
8928
  * @internal
8886
8929
  */
@@ -1,5 +1,95 @@
1
- import { AccountSource, ActionParameters, AggregationListItem, AggregationOutput, AssetItem, AssetListingItem, AssetTypeItem, AwsLocation, ColumnFilterConfiguration, ConfigurableEnvironmentAction, ConnectionPropertiesOutput, ConnectionPropertiesPatch, ConnectionType, CustomParameter, DataZoneEntityType, Deployment, DeploymentProperties, EnvironmentConfiguration, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, EnvironmentParameter, EnvironmentStatus, FilterStatus, FormEntryOutput, FormOutput, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GlossaryUsageRestriction, GroupProfileStatus, ManagedPolicyType, MatchRationaleItem, Model, OwnerProperties, PhysicalEndpoint, PolicyGrantPrincipal, ProjectDeletionError, ProjectStatus, ProvisioningProperties, ResolutionStrategy, Resource, RowFilterExpression, Status, SubscribedListing, SubscribedPrincipal, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, TermRelations } from "./models_0";
2
- import { DataProductListingItem, DataProductResultItem, FailureCause, GrantedEntity, Import, MetadataGenerationRunStatus, RuleAction, RuleDetail, RuleScope, RuleTarget, RuleTargetType, RuleType, SortOrder, SubscribedAsset, SubscriptionGrantOverallStatus, SubscriptionGrantStatus, SubscriptionTargetForm, TimeSeriesDataPointFormOutput, TimeSeriesEntityType, UserProfileDetails, UserProfileStatus, UserProfileType } from "./models_1";
1
+ import { AccountSource, ActionParameters, AggregationListItem, AggregationOutput, AssetItem, AssetListingItem, AssetTypeItem, AwsLocation, ColumnFilterConfiguration, ConfigurableEnvironmentAction, ConnectionPropertiesOutput, ConnectionPropertiesPatch, ConnectionScope, ConnectionType, CustomParameter, DataZoneEntityType, Deployment, DeploymentProperties, EnvironmentConfigurationUserParameter, EnvironmentDeploymentDetails, EnvironmentParameter, EnvironmentStatus, FilterStatus, FormEntryOutput, FormOutput, FormTypeStatus, GlossaryStatus, GlossaryTermStatus, GlossaryUsageRestriction, GroupProfileStatus, ManagedPolicyType, MatchRationaleItem, Model, OwnerProperties, PhysicalEndpoint, PolicyGrantPrincipal, ProjectDeletionError, ProjectStatus, ProvisioningProperties, ResolutionStrategy, Resource, RowFilterExpression, SubscribedListing, SubscribedPrincipal, SubscriptionRequestStatus, SubscriptionStatus, TargetEntityType, TermRelations, TimeSeriesDataPointSummaryFormOutput } from "./models_0";
2
+ import { DataProductListingItem, DataProductResultItem, EnvironmentConfiguration, FailureCause, GrantedEntity, Import, RuleAction, RuleDetail, RuleScope, RuleTarget, RuleTargetType, RuleType, SortOrder, Status, SubscribedAsset, SubscriptionGrantOverallStatus, SubscriptionGrantStatus, SubscriptionTargetForm, TimeSeriesDataPointFormOutput, TimeSeriesEntityType, UserProfileDetails, UserProfileStatus, UserProfileType } from "./models_1";
3
+ /**
4
+ * @public
5
+ */
6
+ export interface ListTimeSeriesDataPointsInput {
7
+ /**
8
+ * <p>The ID of the Amazon DataZone domain that houses the assets for which you want to list time series data points.</p>
9
+ * @public
10
+ */
11
+ domainIdentifier: string | undefined;
12
+ /**
13
+ * <p>The ID of the asset for which you want to list data points.</p>
14
+ * @public
15
+ */
16
+ entityIdentifier: string | undefined;
17
+ /**
18
+ * <p>The type of the asset for which you want to list data points.</p>
19
+ * @public
20
+ */
21
+ entityType: TimeSeriesEntityType | undefined;
22
+ /**
23
+ * <p>The name of the time series data points form.</p>
24
+ * @public
25
+ */
26
+ formName: string | undefined;
27
+ /**
28
+ * <p>The timestamp at which the data points that you want to list started.</p>
29
+ * @public
30
+ */
31
+ startedAt?: Date | undefined;
32
+ /**
33
+ * <p>The timestamp at which the data points that you wanted to list ended.</p>
34
+ * @public
35
+ */
36
+ endedAt?: Date | undefined;
37
+ /**
38
+ * <p>When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.</p>
39
+ * @public
40
+ */
41
+ nextToken?: string | undefined;
42
+ /**
43
+ * <p>The maximum number of data points to return in a single call to ListTimeSeriesDataPoints. When the number of data points to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.</p>
44
+ * @public
45
+ */
46
+ maxResults?: number | undefined;
47
+ }
48
+ /**
49
+ * @public
50
+ */
51
+ export interface ListTimeSeriesDataPointsOutput {
52
+ /**
53
+ * <p>The results of the ListTimeSeriesDataPoints action. </p>
54
+ * @public
55
+ */
56
+ items?: TimeSeriesDataPointSummaryFormOutput[] | undefined;
57
+ /**
58
+ * <p>When the number of data points is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of data points, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListTimeSeriesDataPoints to list the next set of data points.</p>
59
+ * @public
60
+ */
61
+ nextToken?: string | undefined;
62
+ }
63
+ /**
64
+ * @public
65
+ */
66
+ export interface GetMetadataGenerationRunInput {
67
+ /**
68
+ * <p>The ID of the Amazon DataZone domain the metadata generation run of which you want to get.</p>
69
+ * @public
70
+ */
71
+ domainIdentifier: string | undefined;
72
+ /**
73
+ * <p>The identifier of the metadata generation run.</p>
74
+ * @public
75
+ */
76
+ identifier: string | undefined;
77
+ }
78
+ /**
79
+ * @public
80
+ * @enum
81
+ */
82
+ export declare const MetadataGenerationRunStatus: {
83
+ readonly CANCELED: "CANCELED";
84
+ readonly FAILED: "FAILED";
85
+ readonly IN_PROGRESS: "IN_PROGRESS";
86
+ readonly SUBMITTED: "SUBMITTED";
87
+ readonly SUCCEEDED: "SUCCEEDED";
88
+ };
89
+ /**
90
+ * @public
91
+ */
92
+ export type MetadataGenerationRunStatus = (typeof MetadataGenerationRunStatus)[keyof typeof MetadataGenerationRunStatus];
3
93
  /**
4
94
  * @public
5
95
  * @enum
@@ -2071,6 +2161,11 @@ export interface UpdateConnectionOutput {
2071
2161
  * @public
2072
2162
  */
2073
2163
  type: ConnectionType | undefined;
2164
+ /**
2165
+ * <p>The scope of the connection.</p>
2166
+ * @public
2167
+ */
2168
+ scope?: ConnectionScope | undefined;
2074
2169
  }
2075
2170
  /**
2076
2171
  * @public
@@ -2844,7 +2939,7 @@ export interface UpdateSubscriptionGrantStatusOutput {
2844
2939
  /**
2845
2940
  * <p>The identifier of the subscription.</p>
2846
2941
  *
2847
- * @deprecated
2942
+ * @deprecated Multiple subscriptions can exist for a single grant
2848
2943
  * @public
2849
2944
  */
2850
2945
  subscriptionId?: string | undefined;
@@ -5,8 +5,10 @@ import {
5
5
  ServiceInputTypes,
6
6
  ServiceOutputTypes,
7
7
  } from "../DataZoneClient";
8
- import { CreateProjectProfileInput } from "../models/models_0";
9
- import { CreateProjectProfileOutput } from "../models/models_1";
8
+ import {
9
+ CreateProjectProfileInput,
10
+ CreateProjectProfileOutput,
11
+ } from "../models/models_1";
10
12
  export { __MetadataBearer };
11
13
  export { $Command };
12
14
  export interface CreateProjectProfileCommandInput
@@ -5,8 +5,10 @@ import {
5
5
  ServiceInputTypes,
6
6
  ServiceOutputTypes,
7
7
  } from "../DataZoneClient";
8
- import { GetMetadataGenerationRunInput } from "../models/models_1";
9
- import { GetMetadataGenerationRunOutput } from "../models/models_2";
8
+ import {
9
+ GetMetadataGenerationRunInput,
10
+ GetMetadataGenerationRunOutput,
11
+ } from "../models/models_2";
10
12
  export { __MetadataBearer };
11
13
  export { $Command };
12
14
  export interface GetMetadataGenerationRunCommandInput
@@ -8,7 +8,7 @@ import {
8
8
  import {
9
9
  ListTimeSeriesDataPointsInput,
10
10
  ListTimeSeriesDataPointsOutput,
11
- } from "../models/models_1";
11
+ } from "../models/models_2";
12
12
  export { __MetadataBearer };
13
13
  export { $Command };
14
14
  export interface ListTimeSeriesDataPointsCommandInput