Skip to content

Commit 0d4dc7f

Browse files
Add IncludeRoot parameters to GetCatalogs API to return root catalog.
1 parent 1e34416 commit 0d4dc7f

File tree

7 files changed

+72
-17
lines changed

7 files changed

+72
-17
lines changed

generator/ServiceModels/glue/glue-2017-03-31.api.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9054,7 +9054,8 @@
90549054
"ParentCatalogId":{"shape":"CatalogIdString"},
90559055
"NextToken":{"shape":"Token"},
90569056
"MaxResults":{"shape":"PageSize"},
9057-
"Recursive":{"shape":"Boolean"}
9057+
"Recursive":{"shape":"Boolean"},
9058+
"IncludeRoot":{"shape":"NullableBoolean"}
90589059
}
90599060
},
90609061
"GetCatalogsResponse":{

generator/ServiceModels/glue/glue-2017-03-31.docs.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1003,7 +1003,7 @@
10031003
"CrawlerMetrics$StillEstimating": "<p>True if the crawler is still estimating how long it will take to complete this run.</p>",
10041004
"DataLakeAccessProperties$DataLakeAccess": "<p>Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog from any non-Redshift engine, such as Amazon Athena, Amazon EMR, or Glue ETL.</p>",
10051005
"DataLakeAccessPropertiesOutput$DataLakeAccess": "<p>Turns on or off data lake access for Apache Spark applications that access Amazon Redshift databases in the Data Catalog.</p>",
1006-
"GetCatalogsRequest$Recursive": "<p>When specified as true, iterates through the account and returns all catalog resources (including top-level resources and child resources)</p>",
1006+
"GetCatalogsRequest$Recursive": "<p>Whether to list all catalogs across the catalog hierarchy, starting from the <code>ParentCatalogId</code>. Defaults to <code>false</code> . When <code>true</code>, all catalog objects in the <code>ParentCatalogID</code> hierarchy are enumerated in the response.</p>",
10071007
"GetConnectionRequest$HidePassword": "<p>Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.</p>",
10081008
"GetConnectionsRequest$HidePassword": "<p>Allows you to retrieve the connection metadata without returning the password. For instance, the Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.</p>",
10091009
"GetUnfilteredPartitionMetadataResponse$IsRegisteredWithLakeFormation": "<p>A Boolean value that indicates whether the partition location is registered with Lake Formation.</p>",
@@ -7565,6 +7565,7 @@
75657565
"FindMatchesParameters$EnforceProvidedLabels": "<p>The value to switch on or off to force the output to match the provided labels from users. If the value is <code>True</code>, the <code>find matches</code> transform forces the output to match the provided labels. The results override the normal conflation results. If the value is <code>False</code>, the <code>find matches</code> transform does not ensure all the labels provided are respected, and the results rely on the trained model.</p> <p>Note that setting this value to true may increase the conflation execution time.</p>",
75667566
"GetBlueprintRequest$IncludeBlueprint": "<p>Specifies whether or not to include the blueprint in the response.</p>",
75677567
"GetBlueprintRequest$IncludeParameterSpec": "<p>Specifies whether or not to include the parameter specification.</p>",
7568+
"GetCatalogsRequest$IncludeRoot": "<p>Whether to list the default catalog in the account and region in the response. Defaults to <code>false</code>. When <code>true</code> and <code>ParentCatalogId = NULL | Amazon Web Services Account ID</code>, all catalogs and the default catalog are enumerated in the response.</p> <p>When the <code>ParentCatalogId</code> is not equal to null, and this attribute is passed as <code>false</code> or <code>true</code>, an <code>InvalidInputException</code> is thrown.</p>",
75687569
"GetWorkflowRequest$IncludeGraph": "<p>Specifies whether to include a graph when returning the workflow resource metadata.</p>",
75697570
"GetWorkflowRunRequest$IncludeGraph": "<p>Specifies whether to include the workflow graph in response or not.</p>",
75707571
"GetWorkflowRunsRequest$IncludeGraph": "<p>Specifies whether to include the workflow graph in response or not.</p>",
@@ -10352,12 +10353,12 @@
1035210353
"GetDataQualityRulesetEvaluationRunResponse$Timeout": "<p>The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p>",
1035310354
"GetMLTransformResponse$Timeout": "<p>The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p>",
1035410355
"Job$Timeout": "<p>The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours) for batch jobs.</p> <p>Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.</p>",
10355-
"JobRun$Timeout": "<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job.</p> <p>Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.</p>",
10356+
"JobRun$Timeout": "<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job.</p> <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p> <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p> <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>",
1035610357
"JobUpdate$Timeout": "<p>The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours) for batch jobs.</p> <p>Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.</p>",
1035710358
"MLTransform$Timeout": "<p>The timeout in minutes of the machine learning transform.</p>",
1035810359
"StartDataQualityRuleRecommendationRunRequest$Timeout": "<p>The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p>",
1035910360
"StartDataQualityRulesetEvaluationRunRequest$Timeout": "<p>The timeout for a run in minutes. This is the maximum time that a run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p>",
10360-
"StartJobRunRequest$Timeout": "<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job. </p> <p>Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.</p>",
10361+
"StartJobRunRequest$Timeout": "<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job. </p> <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p> <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p> <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>",
1036110362
"UpdateMLTransformRequest$Timeout": "<p>The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters <code>TIMEOUT</code> status. The default is 2,880 minutes (48 hours).</p>"
1036210363
}
1036310364
},

generator/ServiceModels/glue/glue-2017-03-31.normal.json

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13402,7 +13402,11 @@
1340213402
},
1340313403
"Recursive":{
1340413404
"shape":"Boolean",
13405-
"documentation":"<p>When specified as true, iterates through the account and returns all catalog resources (including top-level resources and child resources)</p>"
13405+
"documentation":"<p>Whether to list all catalogs across the catalog hierarchy, starting from the <code>ParentCatalogId</code>. Defaults to <code>false</code> . When <code>true</code>, all catalog objects in the <code>ParentCatalogID</code> hierarchy are enumerated in the response.</p>"
13406+
},
13407+
"IncludeRoot":{
13408+
"shape":"NullableBoolean",
13409+
"documentation":"<p>Whether to list the default catalog in the account and region in the response. Defaults to <code>false</code>. When <code>true</code> and <code>ParentCatalogId = NULL | Amazon Web Services Account ID</code>, all catalogs and the default catalog are enumerated in the response.</p> <p>When the <code>ParentCatalogId</code> is not equal to null, and this attribute is passed as <code>false</code> or <code>true</code>, an <code>InvalidInputException</code> is thrown.</p>"
1340613410
}
1340713411
}
1340813412
},
@@ -17476,7 +17480,7 @@
1747617480
},
1747717481
"Timeout":{
1747817482
"shape":"Timeout",
17479-
"documentation":"<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job.</p> <p>Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.</p>"
17483+
"documentation":"<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job.</p> <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p> <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p> <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>"
1748017484
},
1748117485
"MaxCapacity":{
1748217486
"shape":"NullableDouble",
@@ -23714,7 +23718,7 @@
2371423718
},
2371523719
"Timeout":{
2371623720
"shape":"Timeout",
23717-
"documentation":"<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job. </p> <p>Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.</p>"
23721+
"documentation":"<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. This value overrides the timeout value set in the parent job. </p> <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p> <p>When the value is left blank, the timeout is defaulted to 2880 minutes.</p> <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p>"
2371823722
},
2371923723
"MaxCapacity":{
2372023724
"shape":"NullableDouble",

sdk/src/Services/Glue/Generated/Model/GetCatalogsRequest.cs

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,37 @@ namespace Amazon.Glue.Model
3737
/// </summary>
3838
public partial class GetCatalogsRequest : AmazonGlueRequest
3939
{
40+
private bool? _includeRoot;
4041
private int? _maxResults;
4142
private string _nextToken;
4243
private string _parentCatalogId;
4344
private bool? _recursive;
4445

46+
/// <summary>
47+
/// Gets and sets the property IncludeRoot.
48+
/// <para>
49+
/// Whether to list the default catalog in the account and region in the response. Defaults
50+
/// to <c>false</c>. When <c>true</c> and <c>ParentCatalogId = NULL | Amazon Web Services
51+
/// Account ID</c>, all catalogs and the default catalog are enumerated in the response.
52+
/// </para>
53+
///
54+
/// <para>
55+
/// When the <c>ParentCatalogId</c> is not equal to null, and this attribute is passed
56+
/// as <c>false</c> or <c>true</c>, an <c>InvalidInputException</c> is thrown.
57+
/// </para>
58+
/// </summary>
59+
public bool IncludeRoot
60+
{
61+
get { return this._includeRoot.GetValueOrDefault(); }
62+
set { this._includeRoot = value; }
63+
}
64+
65+
// Check to see if IncludeRoot property is set
66+
internal bool IsSetIncludeRoot()
67+
{
68+
return this._includeRoot.HasValue;
69+
}
70+
4571
/// <summary>
4672
/// Gets and sets the property MaxResults.
4773
/// <para>
@@ -102,8 +128,9 @@ internal bool IsSetParentCatalogId()
102128
/// <summary>
103129
/// Gets and sets the property Recursive.
104130
/// <para>
105-
/// When specified as true, iterates through the account and returns all catalog resources
106-
/// (including top-level resources and child resources)
131+
/// Whether to list all catalogs across the catalog hierarchy, starting from the <c>ParentCatalogId</c>.
132+
/// Defaults to <c>false</c> . When <c>true</c>, all catalog objects in the <c>ParentCatalogID</c>
133+
/// hierarchy are enumerated in the response.
107134
/// </para>
108135
/// </summary>
109136
public bool Recursive

sdk/src/Services/Glue/Generated/Model/Internal/MarshallTransformations/GetCatalogsRequestMarshaller.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@ public IRequest Marshall(GetCatalogsRequest publicRequest)
6969
writer.Validate = false;
7070
writer.WriteObjectStart();
7171
var context = new JsonMarshallerContext(request, writer);
72+
if(publicRequest.IsSetIncludeRoot())
73+
{
74+
context.Writer.WritePropertyName("IncludeRoot");
75+
context.Writer.Write(publicRequest.IncludeRoot);
76+
}
77+
7278
if(publicRequest.IsSetMaxResults())
7379
{
7480
context.Writer.WritePropertyName("MaxResults");

sdk/src/Services/Glue/Generated/Model/JobRun.cs

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -700,10 +700,18 @@ internal bool IsSetStateDetail()
700700
/// </para>
701701
///
702702
/// <para>
703-
/// Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the
704-
/// value is left blank, the job will be restarted after 7 days based if you have not
705-
/// setup a maintenance window. If you have setup maintenance window, it will be restarted
706-
/// during the maintenance window after 7 days.
703+
/// Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs
704+
/// will throw an exception.
705+
/// </para>
706+
///
707+
/// <para>
708+
/// When the value is left blank, the timeout is defaulted to 2880 minutes.
709+
/// </para>
710+
///
711+
/// <para>
712+
/// Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted
713+
/// to 7 days. For instance if you have specified a timeout of 20 days for a batch job,
714+
/// it will be stopped on the 7th day.
707715
/// </para>
708716
/// </summary>
709717
[AWSProperty(Min=1)]

sdk/src/Services/Glue/Generated/Model/StartJobRunRequest.cs

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -330,10 +330,18 @@ internal bool IsSetSecurityConfiguration()
330330
/// </para>
331331
///
332332
/// <para>
333-
/// Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the
334-
/// value is left blank, the job will be restarted after 7 days based if you have not
335-
/// setup a maintenance window. If you have setup maintenance window, it will be restarted
336-
/// during the maintenance window after 7 days.
333+
/// Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs
334+
/// will throw an exception.
335+
/// </para>
336+
///
337+
/// <para>
338+
/// When the value is left blank, the timeout is defaulted to 2880 minutes.
339+
/// </para>
340+
///
341+
/// <para>
342+
/// Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted
343+
/// to 7 days. For instance if you have specified a timeout of 20 days for a batch job,
344+
/// it will be stopped on the 7th day.
337345
/// </para>
338346
/// </summary>
339347
[AWSProperty(Min=1)]

0 commit comments

Comments
 (0)