From 923f54ea6016e1c70ad45ba0854e7361a72c3ba6 Mon Sep 17 00:00:00 2001 From: AWS SDK for Go v2 automation user Date: Wed, 26 Jun 2024 18:06:35 +0000 Subject: [PATCH] Update API model --- .../sdk-codegen/aws-models/controltower.json | 270 ++++++++-- codegen/sdk-codegen/aws-models/eks.json | 6 + .../sdk-codegen/aws-models/ivs-realtime.json | 448 +++++++++++++++- .../aws-models/kinesis-analytics-v2.json | 495 +++++++++++++++++- .../sdk-codegen/aws-models/opensearch.json | 167 ++++++ 5 files changed, 1317 insertions(+), 69 deletions(-) diff --git a/codegen/sdk-codegen/aws-models/controltower.json b/codegen/sdk-codegen/aws-models/controltower.json index c0b7fb60cde..996779814b1 100644 --- a/codegen/sdk-codegen/aws-models/controltower.json +++ b/codegen/sdk-codegen/aws-models/controltower.json @@ -10,6 +10,9 @@ } ], "resources": [ + { + "target": "com.amazonaws.controltower#BaselineOperationResource" + }, { "target": "com.amazonaws.controltower#BaselineResource" }, @@ -22,6 +25,9 @@ { "target": "com.amazonaws.controltower#EnabledControlResource" }, + { + "target": "com.amazonaws.controltower#LandingZoneOperationResource" + }, { "target": "com.amazonaws.controltower#LandingZoneResource" }, @@ -61,7 +67,7 @@ "x-amzn-trace-id" ] }, - "smithy.api#documentation": "

Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:

\n \n

For more information about these types of resources, see the \n Amazon Web Services Control Tower User Guide\n .

\n

\n About control APIs\n

\n

These interfaces allow you to apply the Amazon Web Services library of pre-defined\n controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.

\n

To call these APIs, you'll need to know:

\n \n

\n To get the controlIdentifier for your Amazon Web Services Control Tower\n control:\n

\n

The controlIdentifier is an ARN that is specified for each\n control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.

\n

The controlIdentifier is unique in each Amazon Web Services Region for each control. You can\n find the controlIdentifier for each Region and control in the Tables of control metadata or the Control availability by Region tables in the Amazon Web Services Control Tower User Guide.\n

\n

A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and\n Elective controls is given in Resource identifiers for\n APIs and controls in the Controls reference guide section\n of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls\n cannot be added or removed.

\n \n

\n ARN format:\n arn:aws:controltower:{REGION}::control/{CONTROL_NAME}\n

\n

\n Example:\n

\n

\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n

\n \n

\n To get the targetIdentifier:\n

\n

The targetIdentifier is the ARN for an OU.

\n

In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.

\n \n

\n OU ARN format:\n

\n

\n arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n

\n \n

\n About landing zone APIs\n

\n

You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs.

\n

For an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs. The individual API operations for landing zones are detailed in this document, the API reference manual, in the \"Actions\" section.

\n

\n About baseline APIs\n

\n

You can apply the AWSControlTowerBaseline baseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines.

\n

You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.

\n

The individual API operations for baselines are detailed in this document, the API reference manual, in the \"Actions\" section. For usage examples, see Baseline API input and output examples with CLI.

\n

\n Details and examples\n

\n \n

To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n

\n

\n Recording API Requests\n

\n

Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by\n CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made\n the request and when, and so on. For more about Amazon Web Services Control Tower and its support for\n CloudTrail, see Logging Amazon Web Services Control Tower\n Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about\n CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User\n Guide.

", + "smithy.api#documentation": "

Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:

\n \n

For more information about these types of resources, see the \n Amazon Web Services Control Tower User Guide\n .

\n

\n About control APIs\n

\n

These interfaces allow you to apply the Amazon Web Services library of pre-defined\n controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.

\n

To call these APIs, you'll need to know:

\n \n

\n To get the controlIdentifier for your Amazon Web Services Control Tower\n control:\n

\n

The controlIdentifier is an ARN that is specified for each\n control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.

\n

The controlIdentifier is unique in each Amazon Web Services Region for each control. You can\n find the controlIdentifier for each Region and control in the Tables of control metadata or the Control availability by Region tables in the Amazon Web Services Control Tower Controls Reference Guide.

\n

A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and\n Elective controls is given in Resource identifiers for\n APIs and controls in the \n Amazon Web Services Control Tower Controls Reference Guide\n . Remember that Mandatory controls cannot be added or removed.

\n \n

\n ARN format:\n arn:aws:controltower:{REGION}::control/{CONTROL_NAME}\n

\n

\n Example:\n

\n

\n arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED\n

\n \n

\n To get the targetIdentifier:\n

\n

The targetIdentifier is the ARN for an OU.

\n

In the Amazon Web Services Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.

\n \n

\n OU ARN format:\n

\n

\n arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}\n

\n \n

\n About landing zone APIs\n

\n

You can configure and launch an Amazon Web Services Control Tower landing zone with APIs. For an introduction and steps, see Getting started with Amazon Web Services Control Tower using APIs.

\n

For an overview of landing zone API operations, see Amazon Web Services Control Tower supports landing zone APIs. The individual API operations for landing zones are detailed in this document, the API reference manual, in the \"Actions\" section.

\n

\n About baseline APIs\n

\n

You can apply the AWSControlTowerBaseline baseline to an organizational unit (OU) as a way to register the OU with Amazon Web Services Control Tower, programmatically. For a general overview of this capability, see Amazon Web Services Control Tower supports APIs for OU registration and configuration with baselines.

\n

You can call the baseline API operations to view the baselines that Amazon Web Services Control Tower enables for your landing zone, on your behalf, when setting up the landing zone. These baselines are read-only baselines.

\n

The individual API operations for baselines are detailed in this document, the API reference manual, in the \"Actions\" section. For usage examples, see Baseline API input and output examples with CLI.

\n

\n Details and examples\n

\n \n

To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower\n

\n

\n Recording API Requests\n

\n

Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your\n Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by\n CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made\n the request and when, and so on. For more about Amazon Web Services Control Tower and its support for\n CloudTrail, see Logging Amazon Web Services Control Tower\n Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about\n CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User\n Guide.

", "smithy.api#title": "AWS Control Tower", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -990,6 +996,17 @@ "smithy.api#documentation": "

An object of shape BaselineOperation, returning details about the specified Baseline operation ID.

" } }, + "com.amazonaws.controltower#BaselineOperationResource": { + "type": "resource", + "identifiers": { + "operationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier" + } + }, + "read": { + "target": "com.amazonaws.controltower#GetBaselineOperation" + } + }, "com.amazonaws.controltower#BaselineOperationStatus": { "type": "enum", "members": { @@ -1237,7 +1254,7 @@ } }, "traits": { - "smithy.api#documentation": "

A filter object that lets you call ListCOntrolOperations with a specific filter.

" + "smithy.api#documentation": "

A filter object that lets you call ListControlOperations with a specific filter.

" } }, "com.amazonaws.controltower#ControlOperationResource": { @@ -1650,7 +1667,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API call turns off a control. It starts an asynchronous operation that deletes AWS\n resources on the specified organizational unit and the accounts it contains. The resources\n will vary according to the control that you specify. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .

", + "smithy.api#documentation": "

This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services\n resources on the specified organizational unit and the accounts it contains. The resources\n will vary according to the control that you specify. For usage examples, see the \n Controls Reference Guide\n .

", "smithy.api#http": { "code": 200, "method": "POST", @@ -1885,7 +1902,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services\n resources on the specified organizational unit and the accounts it contains. The resources\n created will vary according to the control that you specify. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .

", + "smithy.api#documentation": "

This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services\n resources on the specified organizational unit and the accounts it contains. The resources\n created will vary according to the control that you specify. For usage examples, see the \n Controls Reference Guide\n .

", "smithy.api#http": { "code": 200, "method": "POST", @@ -2113,11 +2130,6 @@ "target": "com.amazonaws.controltower#ResetEnabledBaseline" } ], - "collectionOperations": [ - { - "target": "com.amazonaws.controltower#GetBaselineOperation" - } - ], "traits": { "aws.api#arn": { "template": "enabledbaseline/{enabledBaselineIdentifier}" @@ -2420,18 +2432,18 @@ "status": { "target": "com.amazonaws.controltower#EnablementStatus", "traits": { - "smithy.api#documentation": "

The deployment status of the enabled control.

\n

Valid values:

\n " + "smithy.api#documentation": "

The deployment status of the enabled resource.

\n

Valid values:

\n " } }, "lastOperationIdentifier": { "target": "com.amazonaws.controltower#OperationIdentifier", "traits": { - "smithy.api#documentation": "

The last operation identifier for the enabled control.

" + "smithy.api#documentation": "

The last operation identifier for the enabled resource.

" } } }, "traits": { - "smithy.api#documentation": "

The deployment summary of the enabled control.

" + "smithy.api#documentation": "

The deployment summary of an EnabledControl or EnabledBaseline resource.

" } }, "com.amazonaws.controltower#EnablementStatuses": { @@ -2527,7 +2539,8 @@ "code": 200, "method": "POST", "uri": "/get-baseline-operation" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.controltower#GetBaselineOperationInput": { @@ -2614,7 +2627,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the status of a particular EnableControl or\n DisableControl operation. Displays a message in case of error. Details for an\n operation are available for 90 days. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .

", + "smithy.api#documentation": "

Returns the status of a particular EnableControl or\n DisableControl operation. Displays a message in case of error. Details for an\n operation are available for 90 days. For usage examples, see the \n Controls Reference Guide\n .

", "smithy.api#http": { "code": 200, "method": "POST", @@ -2743,7 +2756,7 @@ } ], "traits": { - "smithy.api#documentation": "

Retrieves details about an enabled control. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .

", + "smithy.api#documentation": "

Retrieves details about an enabled control. For usage examples, see the \n Controls Reference Guide\n .

", "smithy.api#http": { "code": 200, "method": "POST", @@ -3015,6 +3028,18 @@ "smithy.api#documentation": "

The landing zone operation type.

\n

Valid values:

\n " } }, + "operationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier", + "traits": { + "smithy.api#documentation": "

The operationIdentifier of the landing zone operation.

" + } + }, + "status": { + "target": "com.amazonaws.controltower#LandingZoneOperationStatus", + "traits": { + "smithy.api#documentation": "

Valid values:

\n " + } + }, "startTime": { "target": "com.amazonaws.controltower#Timestamp", "traits": { @@ -3027,12 +3052,6 @@ "smithy.api#documentation": "

The landing zone operation end time.

" } }, - "status": { - "target": "com.amazonaws.controltower#LandingZoneOperationStatus", - "traits": { - "smithy.api#documentation": "

Valid values:

\n " - } - }, "statusMessage": { "target": "smithy.api#String", "traits": { @@ -3044,6 +3063,40 @@ "smithy.api#documentation": "

Information about a landing zone operation.

" } }, + "com.amazonaws.controltower#LandingZoneOperationFilter": { + "type": "structure", + "members": { + "types": { + "target": "com.amazonaws.controltower#LandingZoneOperationTypes", + "traits": { + "smithy.api#documentation": "

The set of landing zone operation types selected by the filter.

" + } + }, + "statuses": { + "target": "com.amazonaws.controltower#LandingZoneOperationStatuses", + "traits": { + "smithy.api#documentation": "

The statuses of the set of landing zone operations selected by the filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter object that lets you call ListLandingZoneOperations with a specific filter.

" + } + }, + "com.amazonaws.controltower#LandingZoneOperationResource": { + "type": "resource", + "identifiers": { + "operationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier" + } + }, + "read": { + "target": "com.amazonaws.controltower#GetLandingZoneOperation" + }, + "list": { + "target": "com.amazonaws.controltower#ListLandingZoneOperations" + } + }, "com.amazonaws.controltower#LandingZoneOperationStatus": { "type": "enum", "members": { @@ -3067,6 +3120,44 @@ } } }, + "com.amazonaws.controltower#LandingZoneOperationStatuses": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#LandingZoneOperationStatus" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.controltower#LandingZoneOperationSummary": { + "type": "structure", + "members": { + "operationType": { + "target": "com.amazonaws.controltower#LandingZoneOperationType", + "traits": { + "smithy.api#documentation": "

The type of the landing zone operation.

" + } + }, + "operationIdentifier": { + "target": "com.amazonaws.controltower#OperationIdentifier", + "traits": { + "smithy.api#documentation": "

The operationIdentifier of the landing zone operation.

" + } + }, + "status": { + "target": "com.amazonaws.controltower#LandingZoneOperationStatus", + "traits": { + "smithy.api#documentation": "

The status of the landing zone operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Returns a summary of information about a landing zone operation.

" + } + }, "com.amazonaws.controltower#LandingZoneOperationType": { "type": "enum", "members": { @@ -3096,6 +3187,24 @@ } } }, + "com.amazonaws.controltower#LandingZoneOperationTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#LandingZoneOperationType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.controltower#LandingZoneOperations": { + "type": "list", + "member": { + "target": "com.amazonaws.controltower#LandingZoneOperationSummary" + } + }, "com.amazonaws.controltower#LandingZoneResource": { "type": "resource", "identifiers": { @@ -3123,11 +3232,6 @@ "target": "com.amazonaws.controltower#ResetLandingZone" } ], - "collectionOperations": [ - { - "target": "com.amazonaws.controltower#GetLandingZoneOperation" - } - ], "traits": { "aws.cloudformation#cfnResource": { "name": "LandingZone" @@ -3298,7 +3402,7 @@ } ], "traits": { - "smithy.api#documentation": "

Provides a list of operations in progress or queued.

", + "smithy.api#documentation": "

Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -3360,7 +3464,7 @@ "controlOperations": { "target": "com.amazonaws.controltower#ControlOperations", "traits": { - "smithy.api#documentation": "

Returns a list of output from control operations. PLACEHOLDER

", + "smithy.api#documentation": "

Returns a list of output from control operations.

", "smithy.api#required": {} } }, @@ -3501,7 +3605,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and\n the accounts it contains. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .

", + "smithy.api#documentation": "

Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and\n the accounts it contains. For usage examples, see the \n Controls Reference Guide\n .

", "smithy.api#http": { "code": 200, "method": "POST", @@ -3541,7 +3645,7 @@ "filter": { "target": "com.amazonaws.controltower#EnabledControlFilter", "traits": { - "smithy.api#documentation": "

An input filter for the ListCEnabledControls API that lets you select the types of control operations to view.

" + "smithy.api#documentation": "

An input filter for the ListEnabledControls API that lets you select the types of control operations to view.

" } } }, @@ -3570,6 +3674,100 @@ "smithy.api#output": {} } }, + "com.amazonaws.controltower#ListLandingZoneOperations": { + "type": "operation", + "input": { + "target": "com.amazonaws.controltower#ListLandingZoneOperationsInput" + }, + "output": { + "target": "com.amazonaws.controltower#ListLandingZoneOperationsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.controltower#AccessDeniedException" + }, + { + "target": "com.amazonaws.controltower#InternalServerException" + }, + { + "target": "com.amazonaws.controltower#ThrottlingException" + }, + { + "target": "com.amazonaws.controltower#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.

", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/list-landingzone-operations" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "landingZoneOperations" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.controltower#ListLandingZoneOperationsInput": { + "type": "structure", + "members": { + "filter": { + "target": "com.amazonaws.controltower#LandingZoneOperationFilter", + "traits": { + "smithy.api#documentation": "

An input filter for the ListLandingZoneOperations API that lets you select the types of landing zone operations to view.

" + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

The token to continue the list from a previous API call with the same parameters.

" + } + }, + "maxResults": { + "target": "com.amazonaws.controltower#ListLandingZoneOperationsMaxResults", + "traits": { + "smithy.api#documentation": "

How many results to return per API call.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.controltower#ListLandingZoneOperationsMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.controltower#ListLandingZoneOperationsOutput": { + "type": "structure", + "members": { + "landingZoneOperations": { + "target": "com.amazonaws.controltower#LandingZoneOperations", + "traits": { + "smithy.api#documentation": "

Lists landing zone operations.

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "

Retrieves the next page of results. If the string is empty, the response is the end of the results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.controltower#ListLandingZones": { "type": "operation", "input": { @@ -3682,7 +3880,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of tags associated with the resource. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .

", + "smithy.api#documentation": "

Returns a list of tags associated with the resource. For usage examples, see the \n Controls Reference Guide\n .

", "smithy.api#http": { "code": 200, "method": "GET", @@ -3866,7 +4064,7 @@ } ], "traits": { - "smithy.api#documentation": "

This API call resets a landing zone. It starts an asynchronous operation that resets the \n landing zone to the parameters specified in its original configuration.

", + "smithy.api#documentation": "

This API call resets a landing zone. It starts an asynchronous operation that resets the\n landing zone to the parameters specified in the original configuration, which you specified\n in the manifest file. Nothing in the manifest file's original landing zone configuration is changed\n during the reset process, by default. This API is not the same as a rollback of a landing\n zone version, which is not a supported operation.

", "smithy.api#http": { "code": 200, "method": "POST", @@ -3992,7 +4190,7 @@ } ], "traits": { - "smithy.api#documentation": "

Applies tags to a resource. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .

", + "smithy.api#documentation": "

Applies tags to a resource. For usage examples, see the \n Controls Reference Guide\n .

", "smithy.api#http": { "code": 204, "method": "POST", @@ -4150,7 +4348,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes tags from a resource. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n .

", + "smithy.api#documentation": "

Removes tags from a resource. For usage examples, see the \n Controls Reference Guide\n .

", "smithy.api#http": { "code": 204, "method": "DELETE", @@ -4304,7 +4502,7 @@ } ], "traits": { - "smithy.api#documentation": "

\n Updates the configuration of an already enabled control.

\n

If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.

\n

If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower will update the control to match any valid parameters that you supply.

\n

If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling DisableControl and again calling EnableControl, or you can run an extending governance operation. For usage examples, see \n the Amazon Web Services Control Tower User Guide\n \n

", + "smithy.api#documentation": "

\n Updates the configuration of an already enabled control.

\n

If the enabled control shows an EnablementStatus of SUCCEEDED, supply parameters that are different from the currently configured parameters. Otherwise, Amazon Web Services Control Tower will not accept the request.

\n

If the enabled control shows an EnablementStatus of FAILED, Amazon Web Services Control Tower updates the control to match any valid parameters that you supply.

\n

If the DriftSummary status for the control shows as DRIFTED, you cannot call this API. Instead, you can update the control by calling DisableControl and again calling EnableControl, or you can run an extending governance operation. For usage examples, see the \n Controls Reference Guide\n .\n

", "smithy.api#http": { "code": 200, "method": "POST", @@ -4399,7 +4597,7 @@ "manifest": { "target": "com.amazonaws.controltower#Manifest", "traits": { - "smithy.api#documentation": "

The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review \n Launch your landing zone.

", + "smithy.api#documentation": "

The manifest file (JSON) is a text file that describes your Amazon Web Services resources. For an example, review \n Launch your landing zone. The example manifest file contains each of the available parameters. The schema for the landing zone's JSON manifest file is not published, by design.

", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/eks.json b/codegen/sdk-codegen/aws-models/eks.json index d6d88b29fdd..d6916f4981d 100644 --- a/codegen/sdk-codegen/aws-models/eks.json +++ b/codegen/sdk-codegen/aws-models/eks.json @@ -3319,6 +3319,12 @@ "traits": { "smithy.api#documentation": "

The access configuration for the cluster.

" } + }, + "bootstrapSelfManagedAddons": { + "target": "com.amazonaws.eks#BoxedBoolean", + "traits": { + "smithy.api#documentation": "

If you set this value to False when creating a cluster, the default networking add-ons will not be installed.

\n

The default networking addons include vpc-cni, coredns, and kube-proxy.

\n

Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.

" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/ivs-realtime.json b/codegen/sdk-codegen/aws-models/ivs-realtime.json index 973ea1e9265..234a738b0e9 100644 --- a/codegen/sdk-codegen/aws-models/ivs-realtime.json +++ b/codegen/sdk-codegen/aws-models/ivs-realtime.json @@ -36,6 +36,9 @@ { "target": "com.amazonaws.ivsrealtime#DeleteEncoderConfiguration" }, + { + "target": "com.amazonaws.ivsrealtime#DeletePublicKey" + }, { "target": "com.amazonaws.ivsrealtime#DeleteStage" }, @@ -54,6 +57,9 @@ { "target": "com.amazonaws.ivsrealtime#GetParticipant" }, + { + "target": "com.amazonaws.ivsrealtime#GetPublicKey" + }, { "target": "com.amazonaws.ivsrealtime#GetStage" }, @@ -63,6 +69,9 @@ { "target": "com.amazonaws.ivsrealtime#GetStorageConfiguration" }, + { + "target": "com.amazonaws.ivsrealtime#ImportPublicKey" + }, { "target": "com.amazonaws.ivsrealtime#ListCompositions" }, @@ -75,6 +84,9 @@ { "target": "com.amazonaws.ivsrealtime#ListParticipants" }, + { + "target": "com.amazonaws.ivsrealtime#ListPublicKeys" + }, { "target": "com.amazonaws.ivsrealtime#ListStages" }, @@ -134,7 +146,7 @@ "date" ] }, - "smithy.api#documentation": "

\n Introduction\n

\n

The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP \n\t API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, \n\t including errors.\n

\n

Terminology:

\n \n

\n Resources\n

\n

The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):

\n \n

\n Tagging\n

\n

A tag is a metadata label that you assign to an AWS resource. A tag\n comprises a key and a value, both set by you. For\n example, you might set a tag as topic:nature to label a particular video\n category. See Tagging AWS Resources for more information, including restrictions that apply to\n tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific\n constraints beyond what is documented there.

\n

Tags can help you identify and organize your AWS resources. For example, you can use the\n same tag for different resources to indicate that they are related. You can also use tags to\n manage access (see Access Tags).

\n

The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and\n ListTagsForResource. The following resource supports tagging: Stage.

\n

At most 50 tags can be applied to a resource.

\n

\n Stages Endpoints\n

\n \n

\n Composition Endpoints\n

\n \n

\n EncoderConfiguration Endpoints\n

\n \n

\n StorageConfiguration Endpoints\n

\n \n

\n Tags Endpoints\n

\n ", + "smithy.api#documentation": "

The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP \n\t API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, \n\t including errors.\n

\n

\n Key Concepts\n

\n \n

For server-side composition:

\n \n

For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.

\n

\n Tagging\n

\n

A tag is a metadata label that you assign to an AWS resource. A tag\n comprises a key and a value, both set by you. For\n example, you might set a tag as topic:nature to label a particular video\n category. See Tagging AWS Resources for more information, including restrictions that apply to\n tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific\n constraints beyond what is documented there.

\n

Tags can help you identify and organize your AWS resources. For example, you can use the\n same tag for different resources to indicate that they are related. You can also use tags to\n manage access (see Access Tags).

\n

The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and\n ListTagsForResource. The following resource supports tagging: Stage.

\n

At most 50 tags can be applied to a resource.

", "smithy.api#title": "Amazon Interactive Video Service RealTime", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -818,7 +830,7 @@ "storageConfigurationArn": { "target": "com.amazonaws.ivsrealtime#AutoParticipantRecordingStorageConfigurationArn", "traits": { - "smithy.api#documentation": "

ARN of the StorageConfiguration resource to use for auto participant recording. Default: \"\" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.

", + "smithy.api#documentation": "

ARN of the StorageConfiguration resource to use for individual participant recording. Default: \"\" (empty string, no storage configuration is specified). Individual participant recording cannot be started unless a storage configuration is specified, when a Stage is created or updated.

", "smithy.api#required": {} } }, @@ -830,7 +842,7 @@ } }, "traits": { - "smithy.api#documentation": "

Object specifying an auto-participant-recording configuration.

" + "smithy.api#documentation": "

Object specifying a configuration for individual participant recording.

" } }, "com.amazonaws.ivsrealtime#AutoParticipantRecordingStorageConfigurationArn": { @@ -1280,7 +1292,7 @@ "autoParticipantRecordingConfiguration": { "target": "com.amazonaws.ivsrealtime#AutoParticipantRecordingConfiguration", "traits": { - "smithy.api#documentation": "

Auto participant recording configuration object attached to the stage.

" + "smithy.api#documentation": "

Configuration object for individual participant recording, to attach to the new stage.

" } } } @@ -1440,6 +1452,61 @@ "smithy.api#output": {} } }, + "com.amazonaws.ivsrealtime#DeletePublicKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivsrealtime#DeletePublicKeyRequest" + }, + "output": { + "target": "com.amazonaws.ivsrealtime#DeletePublicKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivsrealtime#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivsrealtime#ConflictException" + }, + { + "target": "com.amazonaws.ivsrealtime#PendingVerification" + }, + { + "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivsrealtime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the specified public key used to sign stage participant tokens. \n\t This invalidates future participant tokens generated using the key pair’s private key.\n

", + "smithy.api#http": { + "method": "POST", + "uri": "/DeletePublicKey" + } + } + }, + "com.amazonaws.ivsrealtime#DeletePublicKeyRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#PublicKeyArn", + "traits": { + "smithy.api#documentation": "

ARN of the public key to be deleted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ivsrealtime#DeletePublicKeyResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ivsrealtime#DeleteStage": { "type": "operation", "input": { @@ -2232,6 +2299,63 @@ "smithy.api#output": {} } }, + "com.amazonaws.ivsrealtime#GetPublicKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivsrealtime#GetPublicKeyRequest" + }, + "output": { + "target": "com.amazonaws.ivsrealtime#GetPublicKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivsrealtime#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivsrealtime#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.ivsrealtime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets information for the specified public key.

", + "smithy.api#http": { + "method": "POST", + "uri": "/GetPublicKey" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ivsrealtime#GetPublicKeyRequest": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#PublicKeyArn", + "traits": { + "smithy.api#documentation": "

ARN of the public key for which the information is to be retrieved.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ivsrealtime#GetPublicKeyResponse": { + "type": "structure", + "members": { + "publicKey": { + "target": "com.amazonaws.ivsrealtime#PublicKey", + "traits": { + "smithy.api#documentation": "

The public key that is returned.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ivsrealtime#GetStage": { "type": "operation", "input": { @@ -2419,7 +2543,7 @@ "featuredParticipantAttribute": { "target": "com.amazonaws.ivsrealtime#AttributeKey", "traits": { - "smithy.api#documentation": "

This attribute name identifies the featured slot. A participant with this attribute set\n to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the featured\n slot.

" + "smithy.api#documentation": "

This attribute name identifies the featured slot. A participant with this attribute set\n to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the featured\n slot. Default: \"\" (no featured participant).

" } }, "omitStoppedVideo": { @@ -2432,13 +2556,13 @@ "videoAspectRatio": { "target": "com.amazonaws.ivsrealtime#VideoAspectRatio", "traits": { - "smithy.api#documentation": "

Sets the non-featured participant display mode. Default: VIDEO.

" + "smithy.api#documentation": "

Sets the non-featured participant display mode, to control the aspect ratio of video tiles. VIDEO is 16:9, SQUARE is 1:1, and PORTRAIT is 3:4. Default: VIDEO.

" } }, "videoFillMode": { "target": "com.amazonaws.ivsrealtime#VideoFillMode", "traits": { - "smithy.api#documentation": "

Defines how video fits within the participant tile. When not set, \n\t videoFillMode defaults to COVER fill mode for participants in the grid \n\t and to CONTAIN fill mode for featured participants.

" + "smithy.api#documentation": "

Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped),\n or CONTAIN (letterboxed). When not set, \n videoFillMode defaults to COVER fill mode for participants in the grid \n and to CONTAIN fill mode for featured participants.

" } }, "gridGap": { @@ -2471,6 +2595,81 @@ } } }, + "com.amazonaws.ivsrealtime#ImportPublicKey": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivsrealtime#ImportPublicKeyRequest" + }, + "output": { + "target": "com.amazonaws.ivsrealtime#ImportPublicKeyResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivsrealtime#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivsrealtime#ConflictException" + }, + { + "target": "com.amazonaws.ivsrealtime#PendingVerification" + }, + { + "target": "com.amazonaws.ivsrealtime#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.ivsrealtime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Import a public key to be used for signing stage participant tokens.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ImportPublicKey" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ivsrealtime#ImportPublicKeyRequest": { + "type": "structure", + "members": { + "publicKeyMaterial": { + "target": "com.amazonaws.ivsrealtime#PublicKeyMaterial", + "traits": { + "smithy.api#documentation": "

The content of the public key to be imported.

", + "smithy.api#required": {} + } + }, + "name": { + "target": "com.amazonaws.ivsrealtime#PublicKeyName", + "traits": { + "smithy.api#documentation": "

Name of the public key to be imported.

" + } + }, + "tags": { + "target": "com.amazonaws.ivsrealtime#Tags", + "traits": { + "smithy.api#documentation": "

Tags attached to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented\n there.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ivsrealtime#ImportPublicKeyResponse": { + "type": "structure", + "members": { + "publicKey": { + "target": "com.amazonaws.ivsrealtime#PublicKey", + "traits": { + "smithy.api#documentation": "

The public key that was imported.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ivsrealtime#InternalServerException": { "type": "structure", "members": { @@ -2881,6 +3080,78 @@ "smithy.api#output": {} } }, + "com.amazonaws.ivsrealtime#ListPublicKeys": { + "type": "operation", + "input": { + "target": "com.amazonaws.ivsrealtime#ListPublicKeysRequest" + }, + "output": { + "target": "com.amazonaws.ivsrealtime#ListPublicKeysResponse" + }, + "errors": [ + { + "target": "com.amazonaws.ivsrealtime#AccessDeniedException" + }, + { + "target": "com.amazonaws.ivsrealtime#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "

Gets summary information about all public keys in your account, in the AWS region where the API request is processed.

", + "smithy.api#http": { + "method": "POST", + "uri": "/ListPublicKeys" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "publicKeys" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.ivsrealtime#ListPublicKeysRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.ivsrealtime#PaginationToken", + "traits": { + "smithy.api#documentation": "

The first public key to retrieve. This is used for pagination; see the nextToken response field.

" + } + }, + "maxResults": { + "target": "com.amazonaws.ivsrealtime#MaxPublicKeyResults", + "traits": { + "smithy.api#documentation": "

Maximum number of results to return. Default: 50.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.ivsrealtime#ListPublicKeysResponse": { + "type": "structure", + "members": { + "publicKeys": { + "target": "com.amazonaws.ivsrealtime#PublicKeyList", + "traits": { + "smithy.api#documentation": "

List of the matching public keys (summary information only).

", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.ivsrealtime#PaginationToken", + "traits": { + "smithy.api#documentation": "

If there are more public keys than maxResults, use nextToken in the request to get the next set.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.ivsrealtime#ListStageSessions": { "type": "operation", "input": { @@ -3196,6 +3467,15 @@ } } }, + "com.amazonaws.ivsrealtime#MaxPublicKeyResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.ivsrealtime#MaxStageResults": { "type": "integer", "traits": { @@ -3318,19 +3598,19 @@ "recordingS3BucketName": { "target": "com.amazonaws.ivsrealtime#ParticipantRecordingS3BucketName", "traits": { - "smithy.api#documentation": "

Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or \"\" (empty string), if recording is not enabled.

" + "smithy.api#documentation": "

Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or \"\" (empty string), if recording is not enabled.

" } }, "recordingS3Prefix": { "target": "com.amazonaws.ivsrealtime#ParticipantRecordingS3Prefix", "traits": { - "smithy.api#documentation": "

S3 prefix of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or \"\" (empty string), if recording is not enabled.

" + "smithy.api#documentation": "

S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or \"\" (empty string), if recording is not enabled.

" } }, "recordingState": { "target": "com.amazonaws.ivsrealtime#ParticipantRecordingState", "traits": { - "smithy.api#documentation": "

Participant’s recording state.

" + "smithy.api#documentation": "

The participant’s recording state.

" } } }, @@ -3530,7 +3810,7 @@ "recordingState": { "target": "com.amazonaws.ivsrealtime#ParticipantRecordingState", "traits": { - "smithy.api#documentation": "

Participant’s recording state.

" + "smithy.api#documentation": "

The participant’s recording state.

" } } }, @@ -3746,7 +4026,7 @@ "featuredParticipantAttribute": { "target": "com.amazonaws.ivsrealtime#AttributeKey", "traits": { - "smithy.api#documentation": "

This attribute name identifies the featured slot. A participant with this attribute set\n to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the featured\n slot.

" + "smithy.api#documentation": "

This attribute name identifies the featured slot. A participant with this attribute set\n to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the featured\n slot. Default: \"\" (no featured participant).

" } }, "omitStoppedVideo": { @@ -3759,7 +4039,7 @@ "videoFillMode": { "target": "com.amazonaws.ivsrealtime#VideoFillMode", "traits": { - "smithy.api#documentation": "

Defines how video fits within the participant tile. Default: COVER.\n

" + "smithy.api#documentation": "

Defines how video content fits within the participant tile: FILL (stretched), \n\t COVER (cropped), or CONTAIN (letterboxed). Default: COVER.

" } }, "gridGap": { @@ -3772,13 +4052,13 @@ "pipParticipantAttribute": { "target": "com.amazonaws.ivsrealtime#AttributeKey", "traits": { - "smithy.api#documentation": "

Identifies the PiP slot. A participant with this attribute set\n to \"true\" (as a string value) in ParticipantTokenConfiguration \n\t\t is placed in the PiP slot.

" + "smithy.api#documentation": "

Specifies the participant for the PiP window. A participant with this attribute set\n to \"true\" (as a string value) in ParticipantTokenConfiguration \n\t is placed in the PiP slot. Default: \"\" (no PiP participant).

" } }, "pipBehavior": { "target": "com.amazonaws.ivsrealtime#PipBehavior", "traits": { - "smithy.api#documentation": "

Defines PiP behavior when all participants have left. Default: STATIC.

" + "smithy.api#documentation": "

Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.

" } }, "pipOffset": { @@ -3865,6 +4145,105 @@ } } }, + "com.amazonaws.ivsrealtime#PublicKey": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#PublicKeyArn", + "traits": { + "smithy.api#documentation": "

Public key ARN.

" + } + }, + "name": { + "target": "com.amazonaws.ivsrealtime#PublicKeyName", + "traits": { + "smithy.api#documentation": "

Public key name.

" + } + }, + "publicKeyMaterial": { + "target": "com.amazonaws.ivsrealtime#PublicKeyMaterial", + "traits": { + "smithy.api#documentation": "

Public key material.

" + } + }, + "fingerprint": { + "target": "com.amazonaws.ivsrealtime#PublicKeyFingerprint", + "traits": { + "smithy.api#documentation": "

The public key fingerprint, a short string used to identify or verify the full public key.

" + } + }, + "tags": { + "target": "com.amazonaws.ivsrealtime#Tags", + "traits": { + "smithy.api#documentation": "

Tags attached to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented\n there.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Object specifying a public key used to sign stage participant tokens.

" + } + }, + "com.amazonaws.ivsrealtime#PublicKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:public-key/[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.ivsrealtime#PublicKeyFingerprint": { + "type": "string" + }, + "com.amazonaws.ivsrealtime#PublicKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.ivsrealtime#PublicKeySummary" + } + }, + "com.amazonaws.ivsrealtime#PublicKeyMaterial": { + "type": "string", + "traits": { + "smithy.api#pattern": "-----BEGIN PUBLIC KEY-----\\r?\\n([a-zA-Z0-9+/=\\r\\n]+)\\r?\\n-----END PUBLIC KEY-----(\\r?\\n)?" + } + }, + "com.amazonaws.ivsrealtime#PublicKeyName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]*$" + } + }, + "com.amazonaws.ivsrealtime#PublicKeySummary": { + "type": "structure", + "members": { + "arn": { + "target": "com.amazonaws.ivsrealtime#PublicKeyArn", + "traits": { + "smithy.api#documentation": "

Public key ARN.

" + } + }, + "name": { + "target": "com.amazonaws.ivsrealtime#PublicKeyName", + "traits": { + "smithy.api#documentation": "

Public key name.

" + } + }, + "tags": { + "target": "com.amazonaws.ivsrealtime#Tags", + "traits": { + "smithy.api#documentation": "

Tags attached to the resource. Array of maps, each of the form string:string\n (key:value). See Tagging AWS\n Resources for details, including restrictions that apply to tags and \"Tag naming\n limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented\n there.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about a public key.

" + } + }, "com.amazonaws.ivsrealtime#Published": { "type": "boolean", "traits": { @@ -4037,7 +4416,13 @@ "autoParticipantRecordingConfiguration": { "target": "com.amazonaws.ivsrealtime#AutoParticipantRecordingConfiguration", "traits": { - "smithy.api#documentation": "

Auto-participant-recording configuration object attached to the stage.

" + "smithy.api#documentation": "

Configuration object for individual participant recording, attached to the stage.

" + } + }, + "endpoints": { + "target": "com.amazonaws.ivsrealtime#StageEndpoints", + "traits": { + "smithy.api#documentation": "

Summary information about various endpoints for a stage.

" } } }, @@ -4055,6 +4440,35 @@ "smithy.api#pattern": "^arn:aws:ivs:[a-z0-9-]+:[0-9]+:stage/[a-zA-Z0-9-]+$" } }, + "com.amazonaws.ivsrealtime#StageEndpoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.ivsrealtime#StageEndpoints": { + "type": "structure", + "members": { + "events": { + "target": "com.amazonaws.ivsrealtime#StageEndpoint", + "traits": { + "smithy.api#documentation": "

Events endpoint.

" + } + }, + "whip": { + "target": "com.amazonaws.ivsrealtime#StageEndpoint", + "traits": { + "smithy.api#documentation": "

WHIP endpoint.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about various endpoints for a stage.

" + } + }, "com.amazonaws.ivsrealtime#StageName": { "type": "string", "traits": { @@ -4628,7 +5042,7 @@ "autoParticipantRecordingConfiguration": { "target": "com.amazonaws.ivsrealtime#AutoParticipantRecordingConfiguration", "traits": { - "smithy.api#documentation": "

Auto-participant-recording configuration object to attach to the stage.\n Auto-participant-recording configuration cannot be updated while recording is active.

" + "smithy.api#documentation": "

Configuration object for individual participant recording, to attach to the stage. Note that this cannot be updated while recording is active.

" } } } diff --git a/codegen/sdk-codegen/aws-models/kinesis-analytics-v2.json b/codegen/sdk-codegen/aws-models/kinesis-analytics-v2.json index 5c488f7aa7e..92689a0549b 100644 --- a/codegen/sdk-codegen/aws-models/kinesis-analytics-v2.json +++ b/codegen/sdk-codegen/aws-models/kinesis-analytics-v2.json @@ -115,6 +115,12 @@ "traits": { "smithy.api#documentation": "

The descriptions of the current CloudWatch logging options for the SQL-based Kinesis Data Analytics application.

" } + }, + "OperationId": { + "target": "com.amazonaws.kinesisanalyticsv2#OperationId", + "traits": { + "smithy.api#documentation": "Operation ID for tracking AddApplicationCloudWatchLoggingOption request" + } } }, "traits": { @@ -415,7 +421,7 @@ } ], "traits": { - "smithy.api#documentation": "

Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.

\n

Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an\n in-application table within your application. In the request, you provide the source (S3\n bucket name and object key name), name of the in-application table to create, and the\n necessary mapping information that describes how data in an Amazon S3 object maps to columns\n in the resulting in-application table.

" + "smithy.api#documentation": "

Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.

\n

Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an\n in-application table within your application. In the request, you provide the source (S3\n bucket name and object key name), name of the in-application table to create, and the\n necessary mapping information that describes how data in an Amazon S3 object maps to columns\n in the resulting in-application table.

" } }, "com.amazonaws.kinesisanalyticsv2#AddApplicationReferenceDataSourceRequest": { @@ -556,6 +562,12 @@ "traits": { "smithy.api#documentation": "

The parameters of the new VPC configuration.

" } + }, + "OperationId": { + "target": "com.amazonaws.kinesisanalyticsv2#OperationId", + "traits": { + "smithy.api#documentation": "Operation ID for tracking AddApplicationVpcConfiguration request" + } } }, "traits": { @@ -657,6 +669,9 @@ "smithy.api#documentation": "

Describes whether snapshots are enabled for a Managed Service for Apache Flink application.

" } }, + "ApplicationSystemRollbackConfiguration": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationSystemRollbackConfiguration" + }, "VpcConfigurations": { "target": "com.amazonaws.kinesisanalyticsv2#VpcConfigurations", "traits": { @@ -713,6 +728,9 @@ "smithy.api#documentation": "

Describes whether snapshots are enabled for a Managed Service for Apache Flink application.

" } }, + "ApplicationSystemRollbackConfigurationDescription": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationSystemRollbackConfigurationDescription" + }, "VpcConfigurationDescriptions": { "target": "com.amazonaws.kinesisanalyticsv2#VpcConfigurationDescriptions", "traits": { @@ -763,6 +781,9 @@ "smithy.api#documentation": "

Describes whether snapshots are enabled for a Managed Service for Apache Flink application.

" } }, + "ApplicationSystemRollbackConfigurationUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationSystemRollbackConfigurationUpdate" + }, "VpcConfigurationUpdates": { "target": "com.amazonaws.kinesisanalyticsv2#VpcConfigurationUpdates", "traits": { @@ -881,6 +902,12 @@ "smithy.api#documentation": "

If you reverted the application using RollbackApplication,\n the application version when RollbackApplication was called.

" } }, + "ApplicationVersionCreateTimestamp": { + "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The current timestamp when the application version was created." + } + }, "ConditionalToken": { "target": "com.amazonaws.kinesisanalyticsv2#ConditionalToken", "traits": { @@ -981,6 +1008,7 @@ "com.amazonaws.kinesisanalyticsv2#ApplicationName": { "type": "string", "traits": { + "smithy.api#documentation": "The name of the application", "smithy.api#length": { "min": 1, "max": 128 @@ -988,6 +1016,84 @@ "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" } }, + "com.amazonaws.kinesisanalyticsv2#ApplicationOperationInfo": { + "type": "structure", + "members": { + "Operation": { + "target": "com.amazonaws.kinesisanalyticsv2#Operation" + }, + "OperationId": { + "target": "com.amazonaws.kinesisanalyticsv2#OperationId" + }, + "StartTime": { + "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the operation was created" + } + }, + "EndTime": { + "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the operation finished for the application" + } + }, + "OperationStatus": { + "target": "com.amazonaws.kinesisanalyticsv2#OperationStatus" + } + }, + "traits": { + "smithy.api#documentation": "Provides a description of the operation, such as the type and status of operation" + } + }, + "com.amazonaws.kinesisanalyticsv2#ApplicationOperationInfoDetails": { + "type": "structure", + "members": { + "Operation": { + "target": "com.amazonaws.kinesisanalyticsv2#Operation", + "traits": { + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the operation was created", + "smithy.api#required": {} + } + }, + "EndTime": { + "target": "com.amazonaws.kinesisanalyticsv2#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp at which the operation finished for the application", + "smithy.api#required": {} + } + }, + "OperationStatus": { + "target": "com.amazonaws.kinesisanalyticsv2#OperationStatus", + "traits": { + "smithy.api#required": {} + } + }, + "ApplicationVersionChangeDetails": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionChangeDetails" + }, + "OperationFailureDetails": { + "target": "com.amazonaws.kinesisanalyticsv2#OperationFailureDetails" + } + }, + "traits": { + "smithy.api#documentation": "Provides a description of the operation, such as the operation-type and status" + } + }, + "com.amazonaws.kinesisanalyticsv2#ApplicationOperationInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationOperationInfo" + }, + "traits": { + "smithy.api#documentation": "List of ApplicationOperationInfo for an application" + } + }, "com.amazonaws.kinesisanalyticsv2#ApplicationRestoreConfiguration": { "type": "structure", "members": { @@ -1203,6 +1309,73 @@ "smithy.api#documentation": "

Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.

" } }, + "com.amazonaws.kinesisanalyticsv2#ApplicationSystemRollbackConfiguration": { + "type": "structure", + "members": { + "RollbackEnabled": { + "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", + "traits": { + "smithy.api#documentation": "Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes system rollback configuration for a Managed Service for Apache Flink application" + } + }, + "com.amazonaws.kinesisanalyticsv2#ApplicationSystemRollbackConfigurationDescription": { + "type": "structure", + "members": { + "RollbackEnabled": { + "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", + "traits": { + "smithy.api#documentation": "Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes system rollback configuration for a Managed Service for Apache Flink application" + } + }, + "com.amazonaws.kinesisanalyticsv2#ApplicationSystemRollbackConfigurationUpdate": { + "type": "structure", + "members": { + "RollbackEnabledUpdate": { + "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", + "traits": { + "smithy.api#documentation": "Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes system rollback configuration for a Managed Service for Apache Flink application" + } + }, + "com.amazonaws.kinesisanalyticsv2#ApplicationVersionChangeDetails": { + "type": "structure", + "members": { + "ApplicationVersionUpdatedFrom": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "traits": { + "smithy.api#documentation": "The operation was performed on this version of the application", + "smithy.api#required": {} + } + }, + "ApplicationVersionUpdatedTo": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId", + "traits": { + "smithy.api#documentation": "The operation execution resulted in the transition to the following version of the application", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about the application version changes due to an operation" + } + }, "com.amazonaws.kinesisanalyticsv2#ApplicationVersionId": { "type": "long", "traits": { @@ -1308,7 +1481,7 @@ } }, "traits": { - "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record\n format uses delimiters, such as CSV. For example, the following sample records use CSV format,\n where the records use the '\\n' as the row delimiter and a comma (\",\") as\n the column delimiter:

\n \n

\n \"name1\", \"address1\"\n

\n

\n \"name2\", \"address2\"\n

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record\n format uses delimiters, such as CSV. For example, the following sample records use CSV format,\n where the records use the '\\n' as the row delimiter and a comma (\",\") as\n the column delimiter:

\n

\n \"name1\", \"address1\"\n

\n

\n \"name2\", \"address2\"\n

" } }, "com.amazonaws.kinesisanalyticsv2#CatalogConfiguration": { @@ -1771,7 +1944,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates and returns a URL that you can use to connect to \n an application's extension.

\n

The IAM role or user used to call this API defines the permissions to access the\n extension. After the presigned URL is created, no additional permission is required to access\n this URL. IAM authorization policies for this API are also enforced for every HTTP request\n that attempts to connect to the extension.

\n

You control the amount of time that the URL will be valid using the SessionExpirationDurationInSeconds\n parameter. If you do not provide this parameter, the returned URL is valid for twelve hours.

\n \n

The URL that you get from a call to CreateApplicationPresignedUrl must be used within 3 minutes\n to be valid. \n If you first try to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden error.

\n " + "smithy.api#documentation": "

Creates and returns a URL that you can use to connect to \n an application's extension.

\n

The IAM role or user used to call this API defines the permissions to access the\n extension. After the presigned URL is created, no additional permission is required to access\n this URL. IAM authorization policies for this API are also enforced for every HTTP request\n that attempts to connect to the extension.

\n

You control the amount of time that the URL will be valid using the SessionExpirationDurationInSeconds\n parameter. If you do not provide this parameter, the returned URL is valid for twelve hours.

\n \n

The URL that you get from a call to CreateApplicationPresignedUrl must be used within 3 minutes\n to be valid. \n If you first try to use the URL after the 3-minute limit expires, the service returns an HTTP 403 Forbidden error.

\n " } }, "com.amazonaws.kinesisanalyticsv2#CreateApplicationPresignedUrlRequest": { @@ -2153,6 +2326,12 @@ "traits": { "smithy.api#documentation": "

The descriptions of the remaining CloudWatch logging options for the application.

" } + }, + "OperationId": { + "target": "com.amazonaws.kinesisanalyticsv2#OperationId", + "traits": { + "smithy.api#documentation": "Operation ID for tracking DeleteApplicationCloudWatchLoggingOption request" + } } }, "traits": { @@ -2567,6 +2746,12 @@ "traits": { "smithy.api#documentation": "

The updated version ID of the application.

" } + }, + "OperationId": { + "target": "com.amazonaws.kinesisanalyticsv2#OperationId", + "traits": { + "smithy.api#documentation": "Operation ID for tracking DeleteApplicationVpcConfiguration request" + } } }, "traits": { @@ -2640,6 +2825,62 @@ "smithy.api#documentation": "

Returns information about a specific Managed Service for Apache Flink application.

\n

If you want to retrieve a list of all applications in your account,\n use the ListApplications operation.

" } }, + "com.amazonaws.kinesisanalyticsv2#DescribeApplicationOperation": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisanalyticsv2#DescribeApplicationOperationRequest" + }, + "output": { + "target": "com.amazonaws.kinesisanalyticsv2#DescribeApplicationOperationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisanalyticsv2#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisanalyticsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kinesisanalyticsv2#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about a specific operation performed on a Managed Service for Apache Flink application" + } + }, + "com.amazonaws.kinesisanalyticsv2#DescribeApplicationOperationRequest": { + "type": "structure", + "members": { + "ApplicationName": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", + "traits": { + "smithy.api#required": {} + } + }, + "OperationId": { + "target": "com.amazonaws.kinesisanalyticsv2#OperationId", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request for information about a specific operation performed on a Managed Service for Apache Flink application", + "smithy.api#input": {} + } + }, + "com.amazonaws.kinesisanalyticsv2#DescribeApplicationOperationResponse": { + "type": "structure", + "members": { + "ApplicationOperationInfoDetails": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationOperationInfoDetails" + } + }, + "traits": { + "smithy.api#documentation": "Provides details of the operation corresponding to the operation-ID on a Managed Service for Apache Flink application", + "smithy.api#output": {} + } + }, "com.amazonaws.kinesisanalyticsv2#DescribeApplicationRequest": { "type": "structure", "members": { @@ -2954,9 +3195,30 @@ "smithy.api#documentation": "

Describes updates to the execution property groups for a Managed Service for Apache Flink application or a Studio notebook.

" } }, + "com.amazonaws.kinesisanalyticsv2#ErrorInfo": { + "type": "structure", + "members": { + "ErrorString": { + "target": "com.amazonaws.kinesisanalyticsv2#ErrorString" + } + }, + "traits": { + "smithy.api#documentation": "Provides a description of the operation failure error" + } + }, "com.amazonaws.kinesisanalyticsv2#ErrorMessage": { "type": "string" }, + "com.amazonaws.kinesisanalyticsv2#ErrorString": { + "type": "string", + "traits": { + "smithy.api#documentation": "Error message resulting in failure of the operation", + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, "com.amazonaws.kinesisanalyticsv2#FileKey": { "type": "string", "traits": { @@ -3446,7 +3708,7 @@ "InputStartingPosition": { "target": "com.amazonaws.kinesisanalyticsv2#InputStartingPosition", "traits": { - "smithy.api#documentation": "

The starting position on the stream.

\n " + "smithy.api#documentation": "

The starting position on the stream.

\n " } } }, @@ -3636,6 +3898,9 @@ { "target": "com.amazonaws.kinesisanalyticsv2#DescribeApplication" }, + { + "target": "com.amazonaws.kinesisanalyticsv2#DescribeApplicationOperation" + }, { "target": "com.amazonaws.kinesisanalyticsv2#DescribeApplicationSnapshot" }, @@ -3645,6 +3910,9 @@ { "target": "com.amazonaws.kinesisanalyticsv2#DiscoverInputSchema" }, + { + "target": "com.amazonaws.kinesisanalyticsv2#ListApplicationOperations" + }, { "target": "com.amazonaws.kinesisanalyticsv2#ListApplications" }, @@ -3684,7 +3952,7 @@ "sdkId": "Kinesis Analytics V2", "arnNamespace": "kinesisanalytics", "cloudFormationName": "KinesisAnalyticsV2", - "cloudTrailEventSource": "kinesisanalyticsv2.amazonaws.com", + "cloudTrailEventSource": "kinesisanalytics.amazonaws.com", "docId": "kinesisanalyticsv2-2018-05-23", "endpointPrefix": "kinesisanalytics" }, @@ -4880,6 +5148,87 @@ "smithy.api#error": "client" } }, + "com.amazonaws.kinesisanalyticsv2#ListApplicationOperations": { + "type": "operation", + "input": { + "target": "com.amazonaws.kinesisanalyticsv2#ListApplicationOperationsRequest" + }, + "output": { + "target": "com.amazonaws.kinesisanalyticsv2#ListApplicationOperationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.kinesisanalyticsv2#InvalidArgumentException" + }, + { + "target": "com.amazonaws.kinesisanalyticsv2#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.kinesisanalyticsv2#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists information about operations performed on a Managed Service for Apache Flink application", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ApplicationOperationInfoList", + "pageSize": "Limit" + } + } + }, + "com.amazonaws.kinesisanalyticsv2#ListApplicationOperationsInputLimit": { + "type": "integer", + "traits": { + "smithy.api#documentation": "Limit on the number of records returned in the response", + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.kinesisanalyticsv2#ListApplicationOperationsRequest": { + "type": "structure", + "members": { + "ApplicationName": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationName", + "traits": { + "smithy.api#required": {} + } + }, + "Limit": { + "target": "com.amazonaws.kinesisanalyticsv2#ListApplicationOperationsInputLimit" + }, + "NextToken": { + "target": "com.amazonaws.kinesisanalyticsv2#NextToken" + }, + "Operation": { + "target": "com.amazonaws.kinesisanalyticsv2#Operation" + }, + "OperationStatus": { + "target": "com.amazonaws.kinesisanalyticsv2#OperationStatus" + } + }, + "traits": { + "smithy.api#documentation": "Request to list operations performed on an application", + "smithy.api#input": {} + } + }, + "com.amazonaws.kinesisanalyticsv2#ListApplicationOperationsResponse": { + "type": "structure", + "members": { + "ApplicationOperationInfoList": { + "target": "com.amazonaws.kinesisanalyticsv2#ApplicationOperationInfoList" + }, + "NextToken": { + "target": "com.amazonaws.kinesisanalyticsv2#NextToken" + } + }, + "traits": { + "smithy.api#documentation": "Response with the list of operations for an application", + "smithy.api#output": {} + } + }, "com.amazonaws.kinesisanalyticsv2#ListApplicationSnapshots": { "type": "operation", "input": { @@ -4897,7 +5246,13 @@ } ], "traits": { - "smithy.api#documentation": "

Lists information about the current application snapshots.

" + "smithy.api#documentation": "

Lists information about the current application snapshots.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "SnapshotSummaries", + "pageSize": "Limit" + } } }, "com.amazonaws.kinesisanalyticsv2#ListApplicationSnapshotsRequest": { @@ -4967,7 +5322,13 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration \n associated with each version.

\n \n

To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.

\n \n

This operation is supported only for Managed Service for Apache Flink.

\n " + "smithy.api#documentation": "

Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration \n associated with each version.

\n

To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.

\n \n

This operation is supported only for Managed Service for Apache Flink.

\n ", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ApplicationVersionSummaries", + "pageSize": "Limit" + } } }, "com.amazonaws.kinesisanalyticsv2#ListApplicationVersionsInputLimit": { @@ -5040,7 +5401,13 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of Managed Service for Apache Flink applications in your account. For each\n application, the response includes the application name, Amazon Resource Name (ARN), and\n status.

\n

If you want detailed information about a specific application, use \n DescribeApplication.

" + "smithy.api#documentation": "

Returns a list of Managed Service for Apache Flink applications in your account. For each\n application, the response includes the application name, Amazon Resource Name (ARN), and\n status.

\n

If you want detailed information about a specific application, use \n DescribeApplication.

", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ApplicationSummaries", + "pageSize": "Limit" + } } }, "com.amazonaws.kinesisanalyticsv2#ListApplicationsInputLimit": { @@ -5391,6 +5758,7 @@ "com.amazonaws.kinesisanalyticsv2#NextToken": { "type": "string", "traits": { + "smithy.api#documentation": "If a previous command returned a pagination token, pass it into this value to retrieve the next set of results", "smithy.api#length": { "min": 1, "max": 512 @@ -5406,6 +5774,75 @@ } } }, + "com.amazonaws.kinesisanalyticsv2#Operation": { + "type": "string", + "traits": { + "smithy.api#documentation": "Type of operation performed on an application", + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.kinesisanalyticsv2#OperationFailureDetails": { + "type": "structure", + "members": { + "RollbackOperationId": { + "target": "com.amazonaws.kinesisanalyticsv2#OperationId", + "traits": { + "smithy.api#documentation": "Provides the operation ID of a system-rollback operation executed due to failure in the current operation" + } + }, + "ErrorInfo": { + "target": "com.amazonaws.kinesisanalyticsv2#ErrorInfo" + } + }, + "traits": { + "smithy.api#documentation": "Provides a description of the operation failure" + } + }, + "com.amazonaws.kinesisanalyticsv2#OperationId": { + "type": "string", + "traits": { + "smithy.api#documentation": "Identifier of the Operation", + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.kinesisanalyticsv2#OperationStatus": { + "type": "enum", + "members": { + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESSFUL" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + }, + "traits": { + "smithy.api#documentation": "Status of the operation performed on an application" + } + }, "com.amazonaws.kinesisanalyticsv2#Output": { "type": "structure", "members": { @@ -5443,7 +5880,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes a SQL-based Kinesis Data Analytics application's output configuration,\n in which you identify an in-application stream and a destination where you want the\n in-application stream data to be written. The destination can be a Kinesis data stream or a\n Kinesis Data Firehose delivery stream.

\n \n

" + "smithy.api#documentation": "

Describes a SQL-based Kinesis Data Analytics application's output configuration,\n in which you identify an in-application stream and a destination where you want the\n in-application stream data to be written. The destination can be a Kinesis data stream or a\n Kinesis Data Firehose delivery stream.

\n

" } }, "com.amazonaws.kinesisanalyticsv2#OutputDescription": { @@ -6115,7 +6552,7 @@ } ], "traits": { - "smithy.api#documentation": "

Reverts the application to the previous running version. You can\n roll back an application if you suspect it is stuck in a transient status.

\n

You can roll back an application only if it is in the UPDATING \n or AUTOSCALING status.

\n

When you rollback an application, it loads state data from the last successful snapshot.\n If the application has no snapshots, Managed Service for Apache Flink rejects the rollback request.

\n

This action is not supported for Managed Service for Apache Flink for SQL applications.

" + "smithy.api#documentation": "

Reverts the application to the previous running version. You can roll back an\n application if you suspect it is stuck in a transient status or in the running status.

\n

You can roll back an application only if it is in the UPDATING,\n AUTOSCALING, or RUNNING statuses.

\n

When you rollback an application, it loads state data from the last successful snapshot.\n If the application has no snapshots, Managed Service for Apache Flink rejects the rollback request.

" } }, "com.amazonaws.kinesisanalyticsv2#RollbackApplicationRequest": { @@ -6148,6 +6585,12 @@ "traits": { "smithy.api#required": {} } + }, + "OperationId": { + "target": "com.amazonaws.kinesisanalyticsv2#OperationId", + "traits": { + "smithy.api#documentation": "Operation ID for tracking RollbackApplication request" + } } }, "traits": { @@ -6465,7 +6908,7 @@ } }, "traits": { - "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, identifies the Amazon S3\n bucket and object that contains the reference data.

\n \n

A SQL-based Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication\n operation to trigger reloading of data into your application.

" + "smithy.api#documentation": "

For a SQL-based Kinesis Data Analytics application, identifies the Amazon S3\n bucket and object that contains the reference data.

\n

A SQL-based Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication\n operation to trigger reloading of data into your application.

" } }, "com.amazonaws.kinesisanalyticsv2#S3ReferenceDataSourceDescription": { @@ -6825,7 +7268,14 @@ }, "com.amazonaws.kinesisanalyticsv2#StartApplicationResponse": { "type": "structure", - "members": {}, + "members": { + "OperationId": { + "target": "com.amazonaws.kinesisanalyticsv2#OperationId", + "traits": { + "smithy.api#documentation": "Operation ID for tracking StartApplication request" + } + } + }, "traits": { "smithy.api#output": {} } @@ -6859,7 +7309,7 @@ } ], "traits": { - "smithy.api#documentation": "

Stops the application from processing data. You can stop\n an application only if it is in the running status, unless you set the Force \n parameter to true.

\n

You can use the DescribeApplication operation to find the application status.\n

\n

Managed Service for Apache Flink takes a snapshot when the application is stopped, unless Force is set \n to true.

" + "smithy.api#documentation": "

Stops the application from processing data. You can stop\n an application only if it is in the running status, unless you set the Force \n parameter to true.

\n

You can use the DescribeApplication operation to find the application status.\n

\n

Managed Service for Apache Flink takes a snapshot when the application is stopped, unless Force is set \n to true.

" } }, "com.amazonaws.kinesisanalyticsv2#StopApplicationRequest": { @@ -6875,7 +7325,7 @@ "Force": { "target": "com.amazonaws.kinesisanalyticsv2#BooleanObject", "traits": { - "smithy.api#documentation": "

Set to true to force the application to stop. If you set Force\n to true, Managed Service for Apache Flink stops the application without taking a snapshot. \n

\n \n

Force-stopping your application may lead to data loss or duplication.\n To prevent data loss or duplicate processing of data during application restarts, \n we recommend you to take frequent snapshots of your application.

\n \n

You can only force stop a Managed Service for Apache Flink application. You can't force stop a SQL-based Kinesis Data Analytics application.

\n

The application must be in the\n STARTING, UPDATING, STOPPING, AUTOSCALING, or\n RUNNING status.

" + "smithy.api#documentation": "

Set to true to force the application to stop. If you set Force\n to true, Managed Service for Apache Flink stops the application without taking a snapshot. \n

\n \n

Force-stopping your application may lead to data loss or duplication.\n To prevent data loss or duplicate processing of data during application restarts, \n we recommend you to take frequent snapshots of your application.

\n \n

You can only force stop a Managed Service for Apache Flink application. You can't force stop a SQL-based Kinesis Data Analytics application.

\n

The application must be in the\n STARTING, UPDATING, STOPPING, AUTOSCALING, or\n RUNNING status.

" } } }, @@ -6885,7 +7335,14 @@ }, "com.amazonaws.kinesisanalyticsv2#StopApplicationResponse": { "type": "structure", - "members": {}, + "members": { + "OperationId": { + "target": "com.amazonaws.kinesisanalyticsv2#OperationId", + "traits": { + "smithy.api#documentation": "Operation ID for tracking StopApplication request" + } + } + }, "traits": { "smithy.api#output": {} } @@ -7302,7 +7759,7 @@ "RuntimeEnvironmentUpdate": { "target": "com.amazonaws.kinesisanalyticsv2#RuntimeEnvironment", "traits": { - "smithy.api#documentation": "

Updates the Managed Service for Apache Flink runtime environment used to run your code. To avoid issues you must:

\n " + "smithy.api#documentation": "

Updates the Managed Service for Apache Flink runtime environment used to run your code. To avoid issues you must:

\n " } } }, @@ -7319,6 +7776,12 @@ "smithy.api#documentation": "

Describes application updates.

", "smithy.api#required": {} } + }, + "OperationId": { + "target": "com.amazonaws.kinesisanalyticsv2#OperationId", + "traits": { + "smithy.api#documentation": "Operation ID for tracking UpdateApplication request" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/opensearch.json b/codegen/sdk-codegen/aws-models/opensearch.json index c20cf2b0975..a04daec6154 100644 --- a/codegen/sdk-codegen/aws-models/opensearch.json +++ b/codegen/sdk-codegen/aws-models/opensearch.json @@ -29,6 +29,51 @@ ] }, "shapes": { + "com.amazonaws.opensearch#AIMLOptionsInput": { + "type": "structure", + "members": { + "NaturalLanguageQueryGenerationOptions": { + "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsInput", + "traits": { + "smithy.api#documentation": "

Container for parameters required for natural language query generation on the specified domain.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for parameters required to enable all machine learning features.

" + } + }, + "com.amazonaws.opensearch#AIMLOptionsOutput": { + "type": "structure", + "members": { + "NaturalLanguageQueryGenerationOptions": { + "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsOutput", + "traits": { + "smithy.api#documentation": "

Container for parameters required for natural language query generation on the specified domain.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for parameters representing the state of machine learning features on the specified domain.

" + } + }, + "com.amazonaws.opensearch#AIMLOptionsStatus": { + "type": "structure", + "members": { + "Options": { + "target": "com.amazonaws.opensearch#AIMLOptionsOutput", + "traits": { + "smithy.api#documentation": "

Machine learning options on the specified domain.

" + } + }, + "Status": { + "target": "com.amazonaws.opensearch#OptionStatus" + } + }, + "traits": { + "smithy.api#documentation": "

The status of machine learning options on the specified domain.

" + } + }, "com.amazonaws.opensearch#ARN": { "type": "string", "traits": { @@ -3318,6 +3363,12 @@ "traits": { "smithy.api#documentation": "

Software update options for the domain.

" } + }, + "AIMLOptions": { + "target": "com.amazonaws.opensearch#AIMLOptionsInput", + "traits": { + "smithy.api#documentation": "

Options for all machine learning features for the specified domain.

" + } } }, "traits": { @@ -5710,6 +5761,12 @@ "traits": { "smithy.api#documentation": "

Information about the domain properties that are currently being modified.

" } + }, + "AIMLOptions": { + "target": "com.amazonaws.opensearch#AIMLOptionsStatus", + "traits": { + "smithy.api#documentation": "

Container for parameters required to enable all machine learning features.

" + } } }, "traits": { @@ -6386,6 +6443,12 @@ "traits": { "smithy.api#documentation": "

Information about the domain properties that are currently being modified.

" } + }, + "AIMLOptions": { + "target": "com.amazonaws.opensearch#AIMLOptionsOutput", + "traits": { + "smithy.api#documentation": "

Container for parameters required to enable all machine learning features.

" + } } }, "traits": { @@ -9036,6 +9099,104 @@ "target": "com.amazonaws.opensearch#ModifyingProperties" } }, + "com.amazonaws.opensearch#NaturalLanguageQueryGenerationCurrentState": { + "type": "enum", + "members": { + "NotEnabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_ENABLED" + } + }, + "EnableComplete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_COMPLETE" + } + }, + "EnableInProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_IN_PROGRESS" + } + }, + "EnableFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_FAILED" + } + }, + "DisableComplete": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE_COMPLETE" + } + }, + "DisableInProgress": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE_IN_PROGRESS" + } + }, + "DisableFailed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE_FAILED" + } + } + } + }, + "com.amazonaws.opensearch#NaturalLanguageQueryGenerationDesiredState": { + "type": "enum", + "members": { + "Enabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "Disabled": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsInput": { + "type": "structure", + "members": { + "DesiredState": { + "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationDesiredState", + "traits": { + "smithy.api#documentation": "

The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for parameters required to enable the natural language query generation feature.

" + } + }, + "com.amazonaws.opensearch#NaturalLanguageQueryGenerationOptionsOutput": { + "type": "structure", + "members": { + "DesiredState": { + "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationDesiredState", + "traits": { + "smithy.api#documentation": "

The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.

" + } + }, + "CurrentState": { + "target": "com.amazonaws.opensearch#NaturalLanguageQueryGenerationCurrentState", + "traits": { + "smithy.api#documentation": "

The current state of the natural language query generation feature, indicating completion, in progress, or failure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Container for parameters representing the state of the natural language query generation feature on the specified domain.

" + } + }, "com.amazonaws.opensearch#NextToken": { "type": "string", "traits": { @@ -12221,6 +12382,12 @@ "traits": { "smithy.api#documentation": "

Service software update options for the domain.

" } + }, + "AIMLOptions": { + "target": "com.amazonaws.opensearch#AIMLOptionsInput", + "traits": { + "smithy.api#documentation": "

Options for all machine learning features for the specified domain.

" + } } }, "traits": {