Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
For more information about these types of resources, see the Amazon Web Services Control Tower User Guide .
About control APIs
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
To call these APIs, you'll need to know:
the controlIdentifier for the control--or guardrail--you are targeting.
the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier for your Amazon Web Services Control Tower control:
The controlIdentifier is an ARN that is specified for each control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.
The controlIdentifier is unique in each Amazon Web Services Region for each control. You can 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.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Controls reference guide section of the Amazon Web Services Control Tower User Guide. Remember that Mandatory controls cannot be added or removed.
ARN format: arn:aws:controltower:{REGION}::control/{CONTROL_NAME}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
To get the targetIdentifier:
The targetIdentifier is the ARN for an OU.
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.
OU ARN format:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
About landing zone APIs
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.
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.
About baseline APIs
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.
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.
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.
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
", + "service": "Amazon Web Services Control Tower offers application programming interface (API) operations that support programmatic interaction with these types of resources:
For more information about these types of resources, see the Amazon Web Services Control Tower User Guide .
About control APIs
These interfaces allow you to apply the Amazon Web Services library of pre-defined controls to your organizational units, programmatically. In Amazon Web Services Control Tower, the terms \"control\" and \"guardrail\" are synonyms.
To call these APIs, you'll need to know:
the controlIdentifier for the control--or guardrail--you are targeting.
the ARN associated with the target organizational unit (OU), which we call the targetIdentifier.
the ARN associated with a resource that you wish to tag or untag.
To get the controlIdentifier for your Amazon Web Services Control Tower control:
The controlIdentifier is an ARN that is specified for each control. You can view the controlIdentifier in the console on the Control details page, as well as in the documentation.
The controlIdentifier is unique in each Amazon Web Services Region for each control. You can 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.
A quick-reference list of control identifers for the Amazon Web Services Control Tower legacy Strongly recommended and Elective controls is given in Resource identifiers for APIs and controls in the Amazon Web Services Control Tower Controls Reference Guide . Remember that Mandatory controls cannot be added or removed.
ARN format: arn:aws:controltower:{REGION}::control/{CONTROL_NAME}
Example:
arn:aws:controltower:us-west-2::control/AWS-GR_AUTOSCALING_LAUNCH_CONFIG_PUBLIC_IP_DISABLED
To get the targetIdentifier:
The targetIdentifier is the ARN for an OU.
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.
OU ARN format:
arn:${Partition}:organizations::${MasterAccountId}:ou/o-${OrganizationId}/ou-${OrganizationalUnitId}
About landing zone APIs
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.
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.
About baseline APIs
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.
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.
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.
Details and examples
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
Amazon Web Services Control Tower supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the Amazon Web Services Control Tower service received, who made the request and when, and so on. For more about Amazon Web Services Control Tower and its support for CloudTrail, see Logging Amazon Web Services Control Tower Actions with Amazon Web Services CloudTrail in the Amazon Web Services Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the Amazon Web Services CloudTrail User Guide.
", "operations": { "CreateLandingZone": "Creates a new landing zone. This API call starts an asynchronous operation that creates and configures a landing zone, based on the parameters specified in the manifest JSON file.
", "DeleteLandingZone": "Decommissions a landing zone. This API call starts an asynchronous operation that deletes Amazon Web Services Control Tower resources deployed in accounts managed by Amazon Web Services Control Tower.
", "DisableBaseline": "Disable an EnabledBaseline resource on the specified Target. This API starts an asynchronous operation to remove all resources deployed as part of the baseline enablement. The resource will vary depending on the enabled baseline. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call turns off a control. It starts an asynchronous operation that deletes AWS resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
", + "DisableControl": "This API call turns off a control. It starts an asynchronous operation that deletes Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .
", "EnableBaseline": "Enable (apply) a Baseline to a Target. This API starts an asynchronous operation to deploy resources specified by the Baseline to the specified Target. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Amazon Web Services Control Tower User Guide .
", + "EnableControl": "This API call activates a control. It starts an asynchronous operation that creates Amazon Web Services resources on the specified organizational unit and the accounts it contains. The resources created will vary according to the control that you specify. For usage examples, see the Controls Reference Guide .
", "GetBaseline": "Retrieve details about an existing Baseline resource by specifying its identifier. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline. A status message is displayed in case of operation failure. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Amazon Web Services Control Tower User Guide .
Returns the status of a particular EnableControl or DisableControl operation. Displays a message in case of error. Details for an operation are available for 90 days. For usage examples, see the Controls Reference Guide .
Retrieve details of an EnabledBaseline resource by specifying its identifier.
Retrieves details about an enabled control. For usage examples, see the Amazon Web Services Control Tower User Guide .
", + "GetEnabledControl": "Retrieves details about an enabled control. For usage examples, see the Controls Reference Guide .
", "GetLandingZone": "Returns details about the landing zone. Displays a message in case of error.
", "GetLandingZoneOperation": "Returns the status of the specified landing zone operation. Details for an operation are available for 90 days.
", "ListBaselines": "Returns a summary list of all available baselines. For usage examples, see the Amazon Web Services Control Tower User Guide .
", - "ListControlOperations": "Provides a list of operations in progress or queued.
", + "ListControlOperations": "Provides a list of operations in progress or queued. For usage examples, see ListControlOperation examples.
", "ListEnabledBaselines": "Returns a list of summaries describing EnabledBaseline resources. You can filter the list by the corresponding Baseline or Target of the EnabledBaseline resources. For usage examples, see the Amazon Web Services Control Tower User Guide .
Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the Amazon Web Services Control Tower User Guide .
", + "ListEnabledControls": "Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains. For usage examples, see the Controls Reference Guide .
", + "ListLandingZoneOperations": "Lists all landing zone operations from the past 90 days. Results are sorted by time, with the most recent operation first.
", "ListLandingZones": "Returns the landing zone ARN for the landing zone deployed in your managed account. This API also creates an ARN for existing accounts that do not yet have a landing zone ARN.
Returns one landing zone ARN.
", - "ListTagsForResource": "Returns a list of tags associated with the resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
", + "ListTagsForResource": "Returns a list of tags associated with the resource. For usage examples, see the Controls Reference Guide .
", "ResetEnabledBaseline": "Re-enables an EnabledBaseline resource. For example, this API can re-apply the existing Baseline after a new member account is moved to the target OU. For usage examples, see the Amazon Web Services Control Tower User Guide .
This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in its original configuration.
", - "TagResource": "Applies tags to a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
", - "UntagResource": "Removes tags from a resource. For usage examples, see the Amazon Web Services Control Tower User Guide .
", + "ResetLandingZone": "This API call resets a landing zone. It starts an asynchronous operation that resets the landing zone to the parameters specified in the original configuration, which you specified in the manifest file. Nothing in the manifest file's original landing zone configuration is changed during the reset process, by default. This API is not the same as a rollback of a landing zone version, which is not a supported operation.
", + "TagResource": "Applies tags to a resource. For usage examples, see the Controls Reference Guide .
", + "UntagResource": "Removes tags from a resource. For usage examples, see the Controls Reference Guide .
", "UpdateEnabledBaseline": "Updates an EnabledBaseline resource's applied parameters or version. For usage examples, see the Amazon Web Services Control Tower User Guide .
Updates the configuration of an already enabled control.
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.
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.
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 Amazon Web Services Control Tower User Guide
Updates the configuration of an already enabled control.
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.
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.
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 Controls Reference Guide .
This API call updates the landing zone. It starts an asynchronous operation that updates the landing zone based on the new landing zone version, or on the changed parameters specified in the updated manifest file.
" }, "shapes": { @@ -140,7 +141,7 @@ } }, "ControlOperationFilter": { - "base": "A filter object that lets you call ListCOntrolOperations with a specific filter.
A filter object that lets you call ListControlOperations with a specific filter.
An input filter for the ListControlOperations API that lets you select the types of control operations to view.
Returns a list of output from control operations. PLACEHOLDER
" + "ListControlOperationsOutput$controlOperations": "Returns a list of output from control operations.
" } }, "CreateLandingZoneInput": { @@ -349,7 +350,7 @@ "EnabledControlFilter": { "base": "A structure that returns a set of control identifiers, the control status for each control in the set, and the drift status for each control in the set.
", "refs": { - "ListEnabledControlsInput$filter": "An input filter for the ListCEnabledControls API that lets you select the types of control operations to view.
An input filter for the ListEnabledControls API that lets you select the types of control operations to view.
The deployment status of the enabled control.
Valid values:
SUCCEEDED: The enabledControl configuration was deployed successfully.
UNDER_CHANGE: The enabledControl configuration is changing.
FAILED: The enabledControl configuration failed to deploy.
The deployment status of the enabled resource.
Valid values:
SUCCEEDED: The EnabledControl or EnabledBaseline configuration was deployed successfully.
UNDER_CHANGE: The EnabledControl or EnabledBaseline configuration is changing.
FAILED: The EnabledControl or EnabledBaseline configuration failed to deploy.
The deployment summary of the enabled control.
", + "base": "The deployment summary of an EnabledControl or EnabledBaseline resource.
Details about a landing zone operation.
" } }, + "LandingZoneOperationFilter": { + "base": "A filter object that lets you call ListLandingZoneOperations with a specific filter.
An input filter for the ListLandingZoneOperations API that lets you select the types of landing zone operations to view.
Valid values:
SUCCEEDED: The landing zone operation succeeded.
IN_PROGRESS: The landing zone operation is in progress.
FAILED: The landing zone operation failed.
Valid values:
SUCCEEDED: The landing zone operation succeeded.
IN_PROGRESS: The landing zone operation is in progress.
FAILED: The landing zone operation failed.
The status of the landing zone operation.
" + } + }, + "LandingZoneOperationStatuses": { + "base": null, + "refs": { + "LandingZoneOperationFilter$statuses": "The statuses of the set of landing zone operations selected by the filter.
" + } + }, + "LandingZoneOperationSummary": { + "base": "Returns a summary of information about a landing zone operation.
", + "refs": { + "LandingZoneOperations$member": null } }, "LandingZoneOperationType": { "base": null, "refs": { - "LandingZoneOperationDetail$operationType": "The landing zone operation type.
Valid values:
DELETE: The DeleteLandingZone operation.
CREATE: The CreateLandingZone operation.
UPDATE: The UpdateLandingZone operation.
RESET: The ResetLandingZone operation.
The landing zone operation type.
Valid values:
DELETE: The DeleteLandingZone operation.
CREATE: The CreateLandingZone operation.
UPDATE: The UpdateLandingZone operation.
RESET: The ResetLandingZone operation.
The type of the landing zone operation.
", + "LandingZoneOperationTypes$member": null + } + }, + "LandingZoneOperationTypes": { + "base": null, + "refs": { + "LandingZoneOperationFilter$types": "The set of landing zone operation types selected by the filter.
" + } + }, + "LandingZoneOperations": { + "base": null, + "refs": { + "ListLandingZoneOperationsOutput$landingZoneOperations": "Lists landing zone operations.
" } }, "LandingZoneStatus": { @@ -627,6 +662,22 @@ "refs": { } }, + "ListLandingZoneOperationsInput": { + "base": null, + "refs": { + } + }, + "ListLandingZoneOperationsMaxResults": { + "base": null, + "refs": { + "ListLandingZoneOperationsInput$maxResults": "How many results to return per API call.
" + } + }, + "ListLandingZoneOperationsOutput": { + "base": null, + "refs": { + } + }, "ListLandingZonesInput": { "base": null, "refs": { @@ -664,7 +715,7 @@ "refs": { "CreateLandingZoneInput$manifest": "The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.
", "LandingZoneDetail$manifest": "The landing zone manifest JSON text file that specifies the landing zone configurations.
", - "UpdateLandingZoneInput$manifest": "The manifest JSON file is a text file that describes your Amazon Web Services resources. For examples, review Launch your landing zone.
" + "UpdateLandingZoneInput$manifest": "The manifest file (JSON) is a text file that describes your Amazon Web Services resources. For an example, review 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.
" } }, "MaxResults": { @@ -685,10 +736,12 @@ "DisableControlOutput$operationIdentifier": "The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
", "EnableBaselineOutput$operationIdentifier": "The ID (in UUID format) of the asynchronous EnableBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
", - "EnablementStatusSummary$lastOperationIdentifier": "The last operation identifier for the enabled control.
", + "EnablementStatusSummary$lastOperationIdentifier": "The last operation identifier for the enabled resource.
", "GetBaselineOperationInput$operationIdentifier": "The operation ID returned from mutating asynchronous APIs (Enable, Disable, Update, Reset).
", "GetControlOperationInput$operationIdentifier": "The ID of the asynchronous operation, which is used to track status. The operation is available for 90 days.
", "GetLandingZoneOperationInput$operationIdentifier": "A unique identifier assigned to a landing zone operation.
", + "LandingZoneOperationDetail$operationIdentifier": "The operationIdentifier of the landing zone operation.
The operationIdentifier of the landing zone operation.
The ID (in UUID format) of the asynchronous ResetEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
A unique identifier assigned to a ResetLandingZone operation. You can use this identifier as an input parameter of GetLandingZoneOperation to check the operation's status.
The ID (in UUID format) of the asynchronous UpdateEnabledBaseline operation. This operationIdentifier is used to track status through calls to the GetBaselineOperation API.
A pagination token.
", "ListEnabledControlsInput$nextToken": "The token to continue the list from a previous API call with the same parameters.
", "ListEnabledControlsOutput$nextToken": "Retrieves the next page of results. If the string is empty, the response is the end of the results.
", + "ListLandingZoneOperationsInput$nextToken": "The token to continue the list from a previous API call with the same parameters.
", + "ListLandingZoneOperationsOutput$nextToken": "Retrieves the next page of results. If the string is empty, the response is the end of the results.
", "ListLandingZonesInput$nextToken": "The token to continue the list from a previous API call with the same parameters.
", "ListLandingZonesOutput$nextToken": "Retrieves the next page of results. If the string is empty, the response is the end of the results.
", "ResetLandingZoneInput$landingZoneIdentifier": "The unique identifier of the landing zone.
", diff --git a/models/apis/controltower/2018-05-10/paginators-1.json b/models/apis/controltower/2018-05-10/paginators-1.json index a8886472f4d..3fb0ea34643 100644 --- a/models/apis/controltower/2018-05-10/paginators-1.json +++ b/models/apis/controltower/2018-05-10/paginators-1.json @@ -24,6 +24,12 @@ "limit_key": "maxResults", "result_key": "enabledControls" }, + "ListLandingZoneOperations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "landingZoneOperations" + }, "ListLandingZones": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/models/apis/eks/2017-11-01/api-2.json b/models/apis/eks/2017-11-01/api-2.json index 3f765214679..73b1cde8393 100644 --- a/models/apis/eks/2017-11-01/api-2.json +++ b/models/apis/eks/2017-11-01/api-2.json @@ -1502,7 +1502,8 @@ "tags":{"shape":"TagMap"}, "encryptionConfig":{"shape":"EncryptionConfigList"}, "outpostConfig":{"shape":"OutpostConfigRequest"}, - "accessConfig":{"shape":"CreateAccessConfigRequest"} + "accessConfig":{"shape":"CreateAccessConfigRequest"}, + "bootstrapSelfManagedAddons":{"shape":"BoxedBoolean"} } }, "CreateClusterResponse":{ diff --git a/models/apis/eks/2017-11-01/docs-2.json b/models/apis/eks/2017-11-01/docs-2.json index 63f0e645d2d..1225df5d2c3 100644 --- a/models/apis/eks/2017-11-01/docs-2.json +++ b/models/apis/eks/2017-11-01/docs-2.json @@ -292,6 +292,7 @@ "refs": { "AccessConfigResponse$bootstrapClusterCreatorAdminPermissions": "Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.
", "CreateAccessConfigRequest$bootstrapClusterCreatorAdminPermissions": "Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time. The default value is true.
If you set this value to False when creating a cluster, the default networking add-ons will not be installed.
The default networking addons include vpc-cni, coredns, and kube-proxy.
Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.
", "LogSetup$enabled": "If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.
", "VpcConfigRequest$endpointPublicAccess": "Set this value to false to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .
Introduction
The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
Terminology:
A stage is a virtual space where participants can exchange video in real time.
A participant token is a token that authenticates a participant when they join a stage.
A participant object represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.
Server-side composition: The composition process composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition endpoints support this process.
Server-side composition: A composition controls the look of the outputs, including how participants are positioned in the video.
Resources
The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS Real-Time Streaming):
Stage — A stage is a virtual space where participants can exchange video in real time.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
Stages Endpoints
CreateParticipantToken — Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire.
CreateStage — Creates a new stage (and optionally participant tokens).
DeleteStage — Shuts down and deletes the specified stage (disconnecting all participants).
DisconnectParticipant — Disconnects a specified participant and revokes the participant permanently from a specified stage.
GetParticipant — Gets information about the specified participant token.
GetStage — Gets information for the specified stage.
GetStageSession — Gets information for the specified stage session.
ListParticipantEvents — Lists events for a specified participant that occurred during a specified stage session.
ListParticipants — Lists all participants in a specified stage session.
ListStages — Gets summary information about all stages in your account, in the AWS region where the API request is processed.
ListStageSessions — Gets all sessions for a specified stage.
UpdateStage — Updates a stage’s configuration.
Composition Endpoints
GetComposition — Gets information about the specified Composition resource.
ListCompositions — Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
StartComposition — Starts a Composition from a stage based on the configuration provided in the request.
StopComposition — Stops and deletes a Composition resource. Any broadcast from the Composition resource is stopped.
EncoderConfiguration Endpoints
CreateEncoderConfiguration — Creates an EncoderConfiguration object.
DeleteEncoderConfiguration — Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
GetEncoderConfiguration — Gets information about the specified EncoderConfiguration resource.
ListEncoderConfigurations — Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
StorageConfiguration Endpoints
CreateStorageConfiguration — Creates a new storage configuration, used to enable recording to Amazon S3.
DeleteStorageConfiguration — Deletes the storage configuration for the specified ARN.
GetStorageConfiguration — Gets the storage configuration for the specified ARN.
ListStorageConfigurations — Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
Tags Endpoints
ListTagsForResource — Gets information about AWS tags for the specified ARN.
TagResource — Adds or updates tags for the AWS resource with the specified ARN.
UntagResource — Removes tags from the resource with the specified ARN.
The Amazon Interactive Video Service (IVS) real-time API is REST compatible, using a standard HTTP API and an AWS EventBridge event stream for responses. JSON is used for both requests and responses, including errors.
Key Concepts
Stage — A virtual space where participants can exchange video in real time.
Participant token — A token that authenticates a participant when they join a stage.
Participant object — Represents participants (people) in the stage and contains information about them. When a token is created, it includes a participant ID; when a participant uses that token to join a stage, the participant is associated with that participant ID. There is a 1:1 mapping between participant tokens and participants.
For server-side composition:
Composition process — Composites participants of a stage into a single video and forwards it to a set of outputs (e.g., IVS channels). Composition endpoints support this process.
Composition — Controls the look of the outputs, including how participants are positioned in the video.
For more information about your IVS live stream, also see Getting Started with Amazon IVS Real-Time Streaming.
Tagging
A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS stages has no service-specific constraints beyond what is documented there.
Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).
The Amazon IVS real-time API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resource supports tagging: Stage.
At most 50 tags can be applied to a resource.
", "operations": { "CreateEncoderConfiguration": "Creates an EncoderConfiguration object.
", "CreateParticipantToken": "Creates an additional token for a specified stage. This can be done after stage creation or when tokens expire. Tokens always are scoped to the stage for which they are created.
Encryption keys are owned by Amazon IVS and never used directly by your application.
", "CreateStage": "Creates a new stage (and optionally participant tokens).
", "CreateStorageConfiguration": "Creates a new storage configuration, used to enable recording to Amazon S3. When a StorageConfiguration is created, IVS will modify the S3 bucketPolicy of the provided bucket. This will ensure that IVS has sufficient permissions to write content to the provided bucket.
", "DeleteEncoderConfiguration": "Deletes an EncoderConfiguration resource. Ensures that no Compositions are using this template; otherwise, returns an error.
", + "DeletePublicKey": "Deletes the specified public key used to sign stage participant tokens. This invalidates future participant tokens generated using the key pair’s private key.
", "DeleteStage": "Shuts down and deletes the specified stage (disconnecting all participants).
", "DeleteStorageConfiguration": "Deletes the storage configuration for the specified ARN.
If you try to delete a storage configuration that is used by a Composition, you will get an error (409 ConflictException). To avoid this, for all Compositions that reference the storage configuration, first use StopComposition and wait for it to complete, then use DeleteStorageConfiguration.
", "DisconnectParticipant": "Disconnects a specified participant and revokes the participant permanently from a specified stage.
", "GetComposition": "Get information about the specified Composition resource.
", "GetEncoderConfiguration": "Gets information about the specified EncoderConfiguration resource.
", "GetParticipant": "Gets information about the specified participant token.
", + "GetPublicKey": "Gets information for the specified public key.
", "GetStage": "Gets information for the specified stage.
", "GetStageSession": "Gets information for the specified stage session.
", "GetStorageConfiguration": "Gets the storage configuration for the specified ARN.
", + "ImportPublicKey": "Import a public key to be used for signing stage participant tokens.
", "ListCompositions": "Gets summary information about all Compositions in your account, in the AWS region where the API request is processed.
", "ListEncoderConfigurations": "Gets summary information about all EncoderConfigurations in your account, in the AWS region where the API request is processed.
", "ListParticipantEvents": "Lists events for a specified participant that occurred during a specified stage session.
", "ListParticipants": "Lists all participants in a specified stage session.
", + "ListPublicKeys": "Gets summary information about all public keys in your account, in the AWS region where the API request is processed.
", "ListStageSessions": "Gets all sessions for a specified stage.
", "ListStages": "Gets summary information about all stages in your account, in the AWS region where the API request is processed.
", "ListStorageConfigurations": "Gets summary information about all storage configurations in your account, in the AWS region where the API request is processed.
", @@ -39,23 +43,23 @@ "AttributeKey": { "base": null, "refs": { - "GridConfiguration$featuredParticipantAttribute": "This attribute name identifies the featured slot. A participant with this attribute set to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot.
This attribute name identifies the featured slot. A participant with this attribute set to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot.
Identifies the PiP slot. A participant with this attribute set to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot.
This attribute name identifies the featured slot. A participant with this attribute set to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: \"\" (no featured participant).
This attribute name identifies the featured slot. A participant with this attribute set to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the featured slot. Default: \"\" (no featured participant).
Specifies the participant for the PiP window. A participant with this attribute set to \"true\" (as a string value) in ParticipantTokenConfiguration is placed in the PiP slot. Default: \"\" (no PiP participant).
Object specifying an auto-participant-recording configuration.
", + "base": "Object specifying a configuration for individual participant recording.
", "refs": { - "CreateStageRequest$autoParticipantRecordingConfiguration": "Auto participant recording configuration object attached to the stage.
", - "Stage$autoParticipantRecordingConfiguration": "Auto-participant-recording configuration object attached to the stage.
", - "UpdateStageRequest$autoParticipantRecordingConfiguration": "Auto-participant-recording configuration object to attach to the stage. Auto-participant-recording configuration cannot be updated while recording is active.
" + "CreateStageRequest$autoParticipantRecordingConfiguration": "Configuration object for individual participant recording, to attach to the new stage.
", + "Stage$autoParticipantRecordingConfiguration": "Configuration object for individual participant recording, attached to the stage.
", + "UpdateStageRequest$autoParticipantRecordingConfiguration": "Configuration object for individual participant recording, to attach to the stage. Note that this cannot be updated while recording is active.
" } }, "AutoParticipantRecordingStorageConfigurationArn": { "base": null, "refs": { - "AutoParticipantRecordingConfiguration$storageConfigurationArn": "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.
" + "AutoParticipantRecordingConfiguration$storageConfigurationArn": "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.
Video-resolution height. Note that the maximum value is determined by width times height, such that the maximum total pixels is 2073600 (1920x1080 or 1080x1920). Default: 720.
Maximum number of results to return. Default: 50.
" } }, + "MaxPublicKeyResults": { + "base": null, + "refs": { + "ListPublicKeysRequest$maxResults": "Maximum number of results to return. Default: 50.
" + } + }, "MaxStageResults": { "base": null, "refs": { @@ -570,6 +620,8 @@ "ListParticipantEventsResponse$nextToken": "If there are more events than maxResults, use nextToken in the request to get the next set.
The first participant to retrieve. This is used for pagination; see the nextToken response field.
If there are more participants than maxResults, use nextToken in the request to get the next set.
The first public key to retrieve. This is used for pagination; see the nextToken response field.
If there are more public keys than maxResults, use nextToken in the request to get the next set.
The first stage session to retrieve. This is used for pagination; see the nextToken response field.
If there are more stage sessions than maxResults, use nextToken in the request to get the next set.
The first stage to retrieve. This is used for pagination; see the nextToken response field.
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.
" + "Participant$recordingS3BucketName": "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.
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.
" + "Participant$recordingS3Prefix": "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.
Participant’s recording state.
", - "ParticipantSummary$recordingState": "Participant’s recording state.
" + "Participant$recordingState": "The participant’s recording state.
", + "ParticipantSummary$recordingState": "The participant’s recording state.
" } }, "ParticipantState": { @@ -759,7 +811,7 @@ "PipBehavior": { "base": null, "refs": { - "PipConfiguration$pipBehavior": "Defines PiP behavior when all participants have left. Default: STATIC.
Defines PiP behavior when all participants have left: STATIC (maintains original position/size) or DYNAMIC (expands to full composition). Default: STATIC.
Specifies the width of the PiP window in pixels. When this is not set explicitly, pipWidth’s value will be based on the size of the composition and the aspect ratio of the participant’s video.
Object specifying a public key used to sign stage participant tokens.
", + "refs": { + "GetPublicKeyResponse$publicKey": "The public key that is returned.
", + "ImportPublicKeyResponse$publicKey": "The public key that was imported.
" + } + }, + "PublicKeyArn": { + "base": null, + "refs": { + "DeletePublicKeyRequest$arn": "ARN of the public key to be deleted.
", + "GetPublicKeyRequest$arn": "ARN of the public key for which the information is to be retrieved.
", + "PublicKey$arn": "Public key ARN.
", + "PublicKeySummary$arn": "Public key ARN.
" + } + }, + "PublicKeyFingerprint": { + "base": null, + "refs": { + "PublicKey$fingerprint": "The public key fingerprint, a short string used to identify or verify the full public key.
" + } + }, + "PublicKeyList": { + "base": null, + "refs": { + "ListPublicKeysResponse$publicKeys": "List of the matching public keys (summary information only).
" + } + }, + "PublicKeyMaterial": { + "base": null, + "refs": { + "ImportPublicKeyRequest$publicKeyMaterial": "The content of the public key to be imported.
", + "PublicKey$publicKeyMaterial": "Public key material.
" + } + }, + "PublicKeyName": { + "base": null, + "refs": { + "ImportPublicKeyRequest$name": "Name of the public key to be imported.
", + "PublicKey$name": "Public key name.
", + "PublicKeySummary$name": "Public key name.
" + } + }, + "PublicKeySummary": { + "base": "Summary information about a public key.
", + "refs": { + "PublicKeyList$member": null + } + }, "Published": { "base": null, "refs": { @@ -885,6 +986,19 @@ "UpdateStageRequest$arn": "ARN of the stage to be updated.
" } }, + "StageEndpoint": { + "base": null, + "refs": { + "StageEndpoints$events": "Events endpoint.
", + "StageEndpoints$whip": "WHIP endpoint.
" + } + }, + "StageEndpoints": { + "base": "Summary information about various endpoints for a stage.
", + "refs": { + "Stage$endpoints": "Summary information about various endpoints for a stage.
" + } + }, "StageName": { "base": null, "refs": { @@ -1045,7 +1159,10 @@ "CreateStorageConfigurationRequest$tags": "Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value).
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and \"Tag naming limits and requirements\"; Amazon IVS has no constraints on tags beyond what is documented there.
Sets the non-featured participant display mode. Default: VIDEO.
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.
Defines how video fits within the participant tile. When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.
Defines how video fits within the participant tile. Default: COVER.
Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). When not set, videoFillMode defaults to COVER fill mode for participants in the grid and to CONTAIN fill mode for featured participants.
Defines how video content fits within the participant tile: FILL (stretched), COVER (cropped), or CONTAIN (letterboxed). Default: COVER.
Deletes a snapshot of application state.
", "DeleteApplicationVpcConfiguration": "Removes a VPC configuration from a Managed Service for Apache Flink application.
", "DescribeApplication": "Returns information about a specific Managed Service for Apache Flink application.
If you want to retrieve a list of all applications in your account, use the ListApplications operation.
", + "DescribeApplicationOperation": "Returns information about a specific operation performed on a Managed Service for Apache Flink application", "DescribeApplicationSnapshot": "Returns information about a snapshot of application state data.
", "DescribeApplicationVersion": "Provides a detailed description of a specified version of the application. To see a list of all the versions of an application, invoke the ListApplicationVersions operation.
This operation is supported only for Managed Service for Apache Flink.
Infers a schema for a SQL-based Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.
You can use the inferred schema when configuring a streaming source for your application. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface.
", + "ListApplicationOperations": "Lists information about operations performed on a Managed Service for Apache Flink application", "ListApplicationSnapshots": "Lists information about the current application snapshots.
", "ListApplicationVersions": "Lists all the versions for the specified application, including versions that were rolled back. The response also includes a summary of the configuration associated with each version.
To get the complete description of a specific application version, invoke the DescribeApplicationVersion operation.
This operation is supported only for Managed Service for Apache Flink.
Returns a list of Managed Service for Apache Flink applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status.
If you want detailed information about a specific application, use DescribeApplication.
", "ListTagsForResource": "Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.
", - "RollbackApplication": "Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status.
You can roll back an application only if it is in the UPDATING or AUTOSCALING status.
When you rollback an application, it loads state data from the last successful snapshot. If the application has no snapshots, Managed Service for Apache Flink rejects the rollback request.
This action is not supported for Managed Service for Apache Flink for SQL applications.
", + "RollbackApplication": "Reverts the application to the previous running version. You can roll back an application if you suspect it is stuck in a transient status or in the running status.
You can roll back an application only if it is in the UPDATING, AUTOSCALING, or RUNNING statuses.
When you rollback an application, it loads state data from the last successful snapshot. If the application has no snapshots, Managed Service for Apache Flink rejects the rollback request.
", "StartApplication": "Starts the specified Managed Service for Apache Flink application. After creating an application, you must exclusively call this operation to start your application.
", "StopApplication": "Stops the application from processing data. You can stop an application only if it is in the running status, unless you set the Force parameter to true.
You can use the DescribeApplication operation to find the application status.
Managed Service for Apache Flink takes a snapshot when the application is stopped, unless Force is set to true.
Adds one or more key-value tags to a Managed Service for Apache Flink application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.
", @@ -183,7 +185,7 @@ } }, "ApplicationName": { - "base": null, + "base": "The name of the application", "refs": { "AddApplicationCloudWatchLoggingOptionRequest$ApplicationName": "The Kinesis Data Analytics application name.
", "AddApplicationInputProcessingConfigurationRequest$ApplicationName": "The name of the application to which you want to add the input processing configuration.
", @@ -203,9 +205,11 @@ "DeleteApplicationRequest$ApplicationName": "The name of the application to delete.
", "DeleteApplicationSnapshotRequest$ApplicationName": "The name of an existing application.
", "DeleteApplicationVpcConfigurationRequest$ApplicationName": "The name of an existing application.
", + "DescribeApplicationOperationRequest$ApplicationName": null, "DescribeApplicationRequest$ApplicationName": "The name of the application.
", "DescribeApplicationSnapshotRequest$ApplicationName": "The name of an existing application.
", "DescribeApplicationVersionRequest$ApplicationName": "The name of the application for which you want to get the version description.
", + "ListApplicationOperationsRequest$ApplicationName": null, "ListApplicationSnapshotsRequest$ApplicationName": "The name of an existing application.
", "ListApplicationVersionsRequest$ApplicationName": "The name of the application for which you want to list all versions.
", "ListApplicationsRequest$NextToken": "If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.
", @@ -217,6 +221,24 @@ "UpdateApplicationRequest$ApplicationName": "The name of the application to update.
" } }, + "ApplicationOperationInfo": { + "base": "Provides a description of the operation, such as the type and status of operation", + "refs": { + "ApplicationOperationInfoList$member": null + } + }, + "ApplicationOperationInfoDetails": { + "base": "Provides a description of the operation, such as the operation-type and status", + "refs": { + "DescribeApplicationOperationResponse$ApplicationOperationInfoDetails": null + } + }, + "ApplicationOperationInfoList": { + "base": "List of ApplicationOperationInfo for an application", + "refs": { + "ListApplicationOperationsResponse$ApplicationOperationInfoList": null + } + }, "ApplicationRestoreConfiguration": { "base": "Specifies the method and snapshot to use when restarting an application using previously saved application state.
", "refs": { @@ -269,6 +291,30 @@ "ApplicationSummaries$member": null } }, + "ApplicationSystemRollbackConfiguration": { + "base": "Describes system rollback configuration for a Managed Service for Apache Flink application", + "refs": { + "ApplicationConfiguration$ApplicationSystemRollbackConfiguration": null + } + }, + "ApplicationSystemRollbackConfigurationDescription": { + "base": "Describes system rollback configuration for a Managed Service for Apache Flink application", + "refs": { + "ApplicationConfigurationDescription$ApplicationSystemRollbackConfigurationDescription": null + } + }, + "ApplicationSystemRollbackConfigurationUpdate": { + "base": "Describes system rollback configuration for a Managed Service for Apache Flink application", + "refs": { + "ApplicationConfigurationUpdate$ApplicationSystemRollbackConfigurationUpdate": null + } + }, + "ApplicationVersionChangeDetails": { + "base": "Contains information about the application version changes due to an operation", + "refs": { + "ApplicationOperationInfoDetails$ApplicationVersionChangeDetails": null + } + }, "ApplicationVersionId": { "base": null, "refs": { @@ -289,6 +335,8 @@ "ApplicationDetail$ApplicationVersionRolledBackFrom": "If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.
The version to which you want to roll back the application.
", "ApplicationSummary$ApplicationVersionId": "Provides the current application version.
", + "ApplicationVersionChangeDetails$ApplicationVersionUpdatedFrom": "The operation was performed on this version of the application", + "ApplicationVersionChangeDetails$ApplicationVersionUpdatedTo": "The operation execution resulted in the transition to the following version of the application", "ApplicationVersionSummary$ApplicationVersionId": "The ID of the application version. Managed Service for Apache Flink updates the ApplicationVersionId each time you update the application.
The version ID of the application. You must provide the CurrentApplicationVersionId or the ConditionalToken. You can retrieve the application version ID using DescribeApplication. For better concurrency support, use the ConditionalToken parameter instead of CurrentApplicationVersionId.
The version ID of the application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.
Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
", "ApplicationSnapshotConfigurationDescription$SnapshotsEnabled": "Describes whether snapshots are enabled for a Managed Service for Apache Flink application.
", "ApplicationSnapshotConfigurationUpdate$SnapshotsEnabledUpdate": "Describes updates to whether snapshots are enabled for an application.
", + "ApplicationSystemRollbackConfiguration$RollbackEnabled": "Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application", + "ApplicationSystemRollbackConfigurationDescription$RollbackEnabled": "Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application", + "ApplicationSystemRollbackConfigurationUpdate$RollbackEnabledUpdate": "Describes whether system rollbacks are enabled for a Managed Service for Apache Flink application", "CheckpointConfiguration$CheckpointingEnabled": "Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
Describes whether checkpointing is enabled for a Managed Service for Apache Flink application.
If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
Describes updates to whether checkpointing is enabled for an application.
If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a CheckpointingEnabled value of true, even if this value is set to another value using this API or in application code.
Describes updates to the environment properties for a Managed Service for Apache Flink application.
" } }, + "ErrorInfo": { + "base": "Provides a description of the operation failure error", + "refs": { + "OperationFailureDetails$ErrorInfo": null + } + }, "ErrorMessage": { "base": null, "refs": { @@ -768,6 +835,12 @@ "UnsupportedOperationException$Message": null } }, + "ErrorString": { + "base": "Error message resulting in failure of the operation", + "refs": { + "ErrorInfo$ErrorString": null + } + }, "FileKey": { "base": null, "refs": { @@ -1121,6 +1194,22 @@ "refs": { } }, + "ListApplicationOperationsInputLimit": { + "base": "Limit on the number of records returned in the response", + "refs": { + "ListApplicationOperationsRequest$Limit": null + } + }, + "ListApplicationOperationsRequest": { + "base": "Request to list operations performed on an application", + "refs": { + } + }, + "ListApplicationOperationsResponse": { + "base": "Response with the list of operations for an application", + "refs": { + } + }, "ListApplicationSnapshotsRequest": { "base": null, "refs": { @@ -1264,8 +1353,10 @@ } }, "NextToken": { - "base": null, + "base": "If a previous command returned a pagination token, pass it into this value to retrieve the next set of results", "refs": { + "ListApplicationOperationsRequest$NextToken": null, + "ListApplicationOperationsResponse$NextToken": null, "ListApplicationSnapshotsRequest$NextToken": "Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.
The token for the next set of results, or null if there are no additional results.
If a previous invocation of this operation returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.
", @@ -1280,6 +1371,44 @@ "S3ContentLocationUpdate$ObjectVersionUpdate": "The new version of the object containing the application code.
" } }, + "Operation": { + "base": "Type of operation performed on an application", + "refs": { + "ApplicationOperationInfo$Operation": null, + "ApplicationOperationInfoDetails$Operation": null, + "ListApplicationOperationsRequest$Operation": null + } + }, + "OperationFailureDetails": { + "base": "Provides a description of the operation failure", + "refs": { + "ApplicationOperationInfoDetails$OperationFailureDetails": null + } + }, + "OperationId": { + "base": "Identifier of the Operation", + "refs": { + "AddApplicationCloudWatchLoggingOptionResponse$OperationId": "Operation ID for tracking AddApplicationCloudWatchLoggingOption request", + "AddApplicationVpcConfigurationResponse$OperationId": "Operation ID for tracking AddApplicationVpcConfiguration request", + "ApplicationOperationInfo$OperationId": null, + "DeleteApplicationCloudWatchLoggingOptionResponse$OperationId": "Operation ID for tracking DeleteApplicationCloudWatchLoggingOption request", + "DeleteApplicationVpcConfigurationResponse$OperationId": "Operation ID for tracking DeleteApplicationVpcConfiguration request", + "DescribeApplicationOperationRequest$OperationId": null, + "OperationFailureDetails$RollbackOperationId": "Provides the operation ID of a system-rollback operation executed due to failure in the current operation", + "RollbackApplicationResponse$OperationId": "Operation ID for tracking RollbackApplication request", + "StartApplicationResponse$OperationId": "Operation ID for tracking StartApplication request", + "StopApplicationResponse$OperationId": "Operation ID for tracking StopApplication request", + "UpdateApplicationResponse$OperationId": "Operation ID for tracking UpdateApplication request" + } + }, + "OperationStatus": { + "base": "Status of the operation performed on an application", + "refs": { + "ApplicationOperationInfo$OperationStatus": null, + "ApplicationOperationInfoDetails$OperationStatus": null, + "ListApplicationOperationsRequest$OperationStatus": null + } + }, "Output": { "base": "Describes a SQL-based Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.
", "refs": { @@ -1892,6 +2021,11 @@ "refs": { "ApplicationDetail$CreateTimestamp": "The current timestamp when the application was created.
", "ApplicationDetail$LastUpdateTimestamp": "The current timestamp when the application was last updated.
", + "ApplicationDetail$ApplicationVersionCreateTimestamp": "The current timestamp when the application version was created.", + "ApplicationOperationInfo$StartTime": "The timestamp at which the operation was created", + "ApplicationOperationInfo$EndTime": "The timestamp at which the operation finished for the application", + "ApplicationOperationInfoDetails$StartTime": "The timestamp at which the operation was created", + "ApplicationOperationInfoDetails$EndTime": "The timestamp at which the operation finished for the application", "DeleteApplicationRequest$CreateTimestamp": "Use the DescribeApplication operation to get this value.
The creation timestamp of the application snapshot to delete. You can retrieve this value using or .
", "SnapshotDetails$SnapshotCreationTimestamp": "The timestamp of the application snapshot.
" diff --git a/models/apis/kinesisanalyticsv2/2018-05-23/paginators-1.json b/models/apis/kinesisanalyticsv2/2018-05-23/paginators-1.json index 5677bd8e4a2..80ef6c0911e 100644 --- a/models/apis/kinesisanalyticsv2/2018-05-23/paginators-1.json +++ b/models/apis/kinesisanalyticsv2/2018-05-23/paginators-1.json @@ -1,4 +1,28 @@ { "pagination": { + "ListApplicationOperations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "Limit", + "result_key": "ApplicationOperationInfoList" + }, + "ListApplicationSnapshots": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "Limit", + "result_key": "SnapshotSummaries" + }, + "ListApplicationVersions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "Limit", + "result_key": "ApplicationVersionSummaries" + }, + "ListApplications": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "Limit", + "result_key": "ApplicationSummaries" + } } } diff --git a/models/apis/opensearch/2021-01-01/api-2.json b/models/apis/opensearch/2021-01-01/api-2.json index ae094168fe8..b1bae1abcc1 100644 --- a/models/apis/opensearch/2021-01-01/api-2.json +++ b/models/apis/opensearch/2021-01-01/api-2.json @@ -1000,6 +1000,25 @@ } }, "shapes":{ + "AIMLOptionsInput":{ + "type":"structure", + "members":{ + "NaturalLanguageQueryGenerationOptions":{"shape":"NaturalLanguageQueryGenerationOptionsInput"} + } + }, + "AIMLOptionsOutput":{ + "type":"structure", + "members":{ + "NaturalLanguageQueryGenerationOptions":{"shape":"NaturalLanguageQueryGenerationOptionsOutput"} + } + }, + "AIMLOptionsStatus":{ + "type":"structure", + "members":{ + "Options":{"shape":"AIMLOptionsOutput"}, + "Status":{"shape":"OptionStatus"} + } + }, "ARN":{ "type":"string", "max":2048, @@ -1619,7 +1638,8 @@ "TagList":{"shape":"TagList"}, "AutoTuneOptions":{"shape":"AutoTuneOptionsInput"}, "OffPeakWindowOptions":{"shape":"OffPeakWindowOptions"}, - "SoftwareUpdateOptions":{"shape":"SoftwareUpdateOptions"} + "SoftwareUpdateOptions":{"shape":"SoftwareUpdateOptions"}, + "AIMLOptions":{"shape":"AIMLOptionsInput"} } }, "CreateDomainResponse":{ @@ -2278,7 +2298,8 @@ "ChangeProgressDetails":{"shape":"ChangeProgressDetails"}, "OffPeakWindowOptions":{"shape":"OffPeakWindowOptionsStatus"}, "SoftwareUpdateOptions":{"shape":"SoftwareUpdateOptionsStatus"}, - "ModifyingProperties":{"shape":"ModifyingPropertiesList"} + "ModifyingProperties":{"shape":"ModifyingPropertiesList"}, + "AIMLOptions":{"shape":"AIMLOptionsStatus"} } }, "DomainEndpointOptions":{ @@ -2471,7 +2492,8 @@ "OffPeakWindowOptions":{"shape":"OffPeakWindowOptions"}, "SoftwareUpdateOptions":{"shape":"SoftwareUpdateOptions"}, "DomainProcessingStatus":{"shape":"DomainProcessingStatusType"}, - "ModifyingProperties":{"shape":"ModifyingPropertiesList"} + "ModifyingProperties":{"shape":"ModifyingPropertiesList"}, + "AIMLOptions":{"shape":"AIMLOptionsOutput"} } }, "DomainStatusList":{ @@ -3365,6 +3387,38 @@ "type":"list", "member":{"shape":"ModifyingProperties"} }, + "NaturalLanguageQueryGenerationCurrentState":{ + "type":"string", + "enum":[ + "NOT_ENABLED", + "ENABLE_COMPLETE", + "ENABLE_IN_PROGRESS", + "ENABLE_FAILED", + "DISABLE_COMPLETE", + "DISABLE_IN_PROGRESS", + "DISABLE_FAILED" + ] + }, + "NaturalLanguageQueryGenerationDesiredState":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "NaturalLanguageQueryGenerationOptionsInput":{ + "type":"structure", + "members":{ + "DesiredState":{"shape":"NaturalLanguageQueryGenerationDesiredState"} + } + }, + "NaturalLanguageQueryGenerationOptionsOutput":{ + "type":"structure", + "members":{ + "DesiredState":{"shape":"NaturalLanguageQueryGenerationDesiredState"}, + "CurrentState":{"shape":"NaturalLanguageQueryGenerationCurrentState"} + } + }, "NextToken":{"type":"string"}, "NodeId":{ "type":"string", @@ -4309,7 +4363,8 @@ "DryRun":{"shape":"DryRun"}, "DryRunMode":{"shape":"DryRunMode"}, "OffPeakWindowOptions":{"shape":"OffPeakWindowOptions"}, - "SoftwareUpdateOptions":{"shape":"SoftwareUpdateOptions"} + "SoftwareUpdateOptions":{"shape":"SoftwareUpdateOptions"}, + "AIMLOptions":{"shape":"AIMLOptionsInput"} } }, "UpdateDomainConfigResponse":{ diff --git a/models/apis/opensearch/2021-01-01/docs-2.json b/models/apis/opensearch/2021-01-01/docs-2.json index af8019750ea..41f9e3dbba3 100644 --- a/models/apis/opensearch/2021-01-01/docs-2.json +++ b/models/apis/opensearch/2021-01-01/docs-2.json @@ -67,6 +67,26 @@ "UpgradeDomain": "Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
" }, "shapes": { + "AIMLOptionsInput": { + "base": "Container for parameters required to enable all machine learning features.
", + "refs": { + "CreateDomainRequest$AIMLOptions": "Options for all machine learning features for the specified domain.
", + "UpdateDomainConfigRequest$AIMLOptions": "Options for all machine learning features for the specified domain.
" + } + }, + "AIMLOptionsOutput": { + "base": "Container for parameters representing the state of machine learning features on the specified domain.
", + "refs": { + "AIMLOptionsStatus$Options": "Machine learning options on the specified domain.
", + "DomainStatus$AIMLOptions": "Container for parameters required to enable all machine learning features.
" + } + }, + "AIMLOptionsStatus": { + "base": "The status of machine learning options on the specified domain.
", + "refs": { + "DomainConfig$AIMLOptions": "Container for parameters required to enable all machine learning features.
" + } + }, "ARN": { "base": "The Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities in Using Amazon Web Services Identity and Access Management for more information.
", "refs": { @@ -1894,6 +1914,31 @@ "DomainStatus$ModifyingProperties": "Information about the domain properties that are currently being modified.
" } }, + "NaturalLanguageQueryGenerationCurrentState": { + "base": null, + "refs": { + "NaturalLanguageQueryGenerationOptionsOutput$CurrentState": "The current state of the natural language query generation feature, indicating completion, in progress, or failure.
" + } + }, + "NaturalLanguageQueryGenerationDesiredState": { + "base": null, + "refs": { + "NaturalLanguageQueryGenerationOptionsInput$DesiredState": "The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
", + "NaturalLanguageQueryGenerationOptionsOutput$DesiredState": "The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
" + } + }, + "NaturalLanguageQueryGenerationOptionsInput": { + "base": "Container for parameters required to enable the natural language query generation feature.
", + "refs": { + "AIMLOptionsInput$NaturalLanguageQueryGenerationOptions": "Container for parameters required for natural language query generation on the specified domain.
" + } + }, + "NaturalLanguageQueryGenerationOptionsOutput": { + "base": "Container for parameters representing the state of the natural language query generation feature on the specified domain.
", + "refs": { + "AIMLOptionsOutput$NaturalLanguageQueryGenerationOptions": "Container for parameters required for natural language query generation on the specified domain.
" + } + }, "NextToken": { "base": "When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
Provides the current status of an entity.
", "refs": { + "AIMLOptionsStatus$Status": null, "AccessPoliciesStatus$Status": "The status of the access policy for the domain.
", "AdvancedOptionsStatus$Status": "The status of advanced options for the specified domain.
", "AdvancedSecurityOptionsStatus$Status": "Status of the fine-grained access control settings for a domain.
", diff --git a/service/controltower/api.go b/service/controltower/api.go index 9be2aac78cc..840fa49183c 100644 --- a/service/controltower/api.go +++ b/service/controltower/api.go @@ -257,10 +257,9 @@ func (c *ControlTower) DisableControlRequest(input *DisableControlInput) (req *r // DisableControl API operation for AWS Control Tower. // // This API call turns off a control. It starts an asynchronous operation that -// deletes AWS resources on the specified organizational unit and the accounts -// it contains. The resources will vary according to the control that you specify. -// For usage examples, see the Amazon Web Services Control Tower User Guide -// (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html). +// deletes Amazon Web Services resources on the specified organizational unit +// and the accounts it contains. The resources will vary according to the control +// that you specify. For usage examples, see the Controls Reference Guide (https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -463,8 +462,8 @@ func (c *ControlTower) EnableControlRequest(input *EnableControlInput) (req *req // This API call activates a control. It starts an asynchronous operation that // creates Amazon Web Services resources on the specified organizational unit // and the accounts it contains. The resources created will vary according to -// the control that you specify. For usage examples, see the Amazon Web Services -// Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html). +// the control that you specify. For usage examples, see the Controls Reference +// Guide (https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -755,8 +754,7 @@ func (c *ControlTower) GetControlOperationRequest(input *GetControlOperationInpu // // Returns the status of a particular EnableControl or DisableControl operation. // Displays a message in case of error. Details for an operation are available -// for 90 days. For usage examples, see the Amazon Web Services Control Tower -// User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html). +// for 90 days. For usage examples, see the Controls Reference Guide (https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -940,8 +938,8 @@ func (c *ControlTower) GetEnabledControlRequest(input *GetEnabledControlInput) ( // GetEnabledControl API operation for AWS Control Tower. // -// Retrieves details about an enabled control. For usage examples, see the Amazon -// Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html). +// Retrieves details about an enabled control. For usage examples, see the Controls +// Reference Guide (https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1279,7 +1277,8 @@ func (c *ControlTower) ListControlOperationsRequest(input *ListControlOperations // ListControlOperations API operation for AWS Control Tower. // -// Provides a list of operations in progress or queued. +// Provides a list of operations in progress or queued. For usage examples, +// see ListControlOperation examples (https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html#list-control-operations-api-examples). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1576,7 +1575,7 @@ func (c *ControlTower) ListEnabledControlsRequest(input *ListEnabledControlsInpu // // Lists the controls enabled by Amazon Web Services Control Tower on the specified // organizational unit and the accounts it contains. For usage examples, see -// the Amazon Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html). +// the Controls Reference Guide (https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1676,6 +1675,153 @@ func (c *ControlTower) ListEnabledControlsPagesWithContext(ctx aws.Context, inpu return p.Err() } +const opListLandingZoneOperations = "ListLandingZoneOperations" + +// ListLandingZoneOperationsRequest generates a "aws/request.Request" representing the +// client's request for the ListLandingZoneOperations operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListLandingZoneOperations for more information on using the ListLandingZoneOperations +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListLandingZoneOperationsRequest method. +// req, resp := client.ListLandingZoneOperationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListLandingZoneOperations +func (c *ControlTower) ListLandingZoneOperationsRequest(input *ListLandingZoneOperationsInput) (req *request.Request, output *ListLandingZoneOperationsOutput) { + op := &request.Operation{ + Name: opListLandingZoneOperations, + HTTPMethod: "POST", + HTTPPath: "/list-landingzone-operations", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListLandingZoneOperationsInput{} + } + + output = &ListLandingZoneOperationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListLandingZoneOperations API operation for AWS Control Tower. +// +// Lists all landing zone operations from the past 90 days. Results are sorted +// by time, with the most recent operation first. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Control Tower's +// API operation ListLandingZoneOperations for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// The input does not satisfy the constraints specified by an Amazon Web Services +// service. +// +// - InternalServerException +// An unexpected error occurred during processing of a request. +// +// - AccessDeniedException +// You do not have sufficient access to perform this action. +// +// - ThrottlingException +// The request was denied due to request throttling. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/controltower-2018-05-10/ListLandingZoneOperations +func (c *ControlTower) ListLandingZoneOperations(input *ListLandingZoneOperationsInput) (*ListLandingZoneOperationsOutput, error) { + req, out := c.ListLandingZoneOperationsRequest(input) + return out, req.Send() +} + +// ListLandingZoneOperationsWithContext is the same as ListLandingZoneOperations with the addition of +// the ability to pass a context and additional request options. +// +// See ListLandingZoneOperations for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ControlTower) ListLandingZoneOperationsWithContext(ctx aws.Context, input *ListLandingZoneOperationsInput, opts ...request.Option) (*ListLandingZoneOperationsOutput, error) { + req, out := c.ListLandingZoneOperationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListLandingZoneOperationsPages iterates over the pages of a ListLandingZoneOperations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListLandingZoneOperations method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListLandingZoneOperations operation. +// pageNum := 0 +// err := client.ListLandingZoneOperationsPages(params, +// func(page *controltower.ListLandingZoneOperationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *ControlTower) ListLandingZoneOperationsPages(input *ListLandingZoneOperationsInput, fn func(*ListLandingZoneOperationsOutput, bool) bool) error { + return c.ListLandingZoneOperationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListLandingZoneOperationsPagesWithContext same as ListLandingZoneOperationsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ControlTower) ListLandingZoneOperationsPagesWithContext(ctx aws.Context, input *ListLandingZoneOperationsInput, fn func(*ListLandingZoneOperationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListLandingZoneOperationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListLandingZoneOperationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListLandingZoneOperationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListLandingZones = "ListLandingZones" // ListLandingZonesRequest generates a "aws/request.Request" representing the @@ -1870,7 +2016,7 @@ func (c *ControlTower) ListTagsForResourceRequest(input *ListTagsForResourceInpu // ListTagsForResource API operation for AWS Control Tower. // // Returns a list of tags associated with the resource. For usage examples, -// see the Amazon Web Services Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html). +// see the Controls Reference Guide (https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2059,8 +2205,11 @@ func (c *ControlTower) ResetLandingZoneRequest(input *ResetLandingZoneInput) (re // ResetLandingZone API operation for AWS Control Tower. // // This API call resets a landing zone. It starts an asynchronous operation -// that resets the landing zone to the parameters specified in its original -// configuration. +// that resets the landing zone to the parameters specified in the original +// configuration, which you specified in the manifest file. Nothing in the manifest +// file's original landing zone configuration is changed during the reset process, +// by default. This API is not the same as a rollback of a landing zone version, +// which is not a supported operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2156,8 +2305,8 @@ func (c *ControlTower) TagResourceRequest(input *TagResourceInput) (req *request // TagResource API operation for AWS Control Tower. // -// Applies tags to a resource. For usage examples, see the Amazon Web Services -// Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html). +// Applies tags to a resource. For usage examples, see the Controls Reference +// Guide (https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2244,8 +2393,8 @@ func (c *ControlTower) UntagResourceRequest(input *UntagResourceInput) (req *req // UntagResource API operation for AWS Control Tower. // -// Removes tags from a resource. For usage examples, see the Amazon Web Services -// Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html). +// Removes tags from a resource. For usage examples, see the Controls Reference +// Guide (https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2755,7 +2904,7 @@ func (s *ControlOperation) SetTargetIdentifier(v string) *ControlOperation { return s } -// A filter object that lets you call ListCOntrolOperations with a specific +// A filter object that lets you call ListControlOperations with a specific // filter. type ControlOperationFilter struct { _ struct{} `type:"structure"` @@ -3549,7 +3698,7 @@ type EnabledBaselineDetails struct { // The enabled version of the Baseline. BaselineVersion *string `locationName:"baselineVersion" type:"string"` - // The deployment summary of the enabled control. + // The deployment summary of an EnabledControl or EnabledBaseline resource. // // StatusSummary is a required field StatusSummary *EnablementStatusSummary `locationName:"statusSummary" type:"structure" required:"true"` @@ -3684,7 +3833,7 @@ type EnabledBaselineSummary struct { // The enabled version of the baseline. BaselineVersion *string `locationName:"baselineVersion" type:"string"` - // The deployment summary of the enabled control. + // The deployment summary of an EnabledControl or EnabledBaseline resource. // // StatusSummary is a required field StatusSummary *EnablementStatusSummary `locationName:"statusSummary" type:"structure" required:"true"` @@ -3961,22 +4110,25 @@ func (s *EnabledControlSummary) SetTargetIdentifier(v string) *EnabledControlSum return s } -// The deployment summary of the enabled control. +// The deployment summary of an EnabledControl or EnabledBaseline resource. type EnablementStatusSummary struct { _ struct{} `type:"structure"` - // The last operation identifier for the enabled control. + // The last operation identifier for the enabled resource. LastOperationIdentifier *string `locationName:"lastOperationIdentifier" min:"36" type:"string"` - // The deployment status of the enabled control. + // The deployment status of the enabled resource. // // Valid values: // - // * SUCCEEDED: The enabledControl configuration was deployed successfully. + // * SUCCEEDED: The EnabledControl or EnabledBaseline configuration was deployed + // successfully. // - // * UNDER_CHANGE: The enabledControl configuration is changing. + // * UNDER_CHANGE: The EnabledControl or EnabledBaseline configuration is + // changing. // - // * FAILED: The enabledControl configuration failed to deploy. + // * FAILED: The EnabledControl or EnabledBaseline configuration failed to + // deploy. Status *string `locationName:"status" type:"string" enum:"EnablementStatus"` } @@ -4591,6 +4743,9 @@ type LandingZoneOperationDetail struct { // The landing zone operation end time. EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"` + // The operationIdentifier of the landing zone operation. + OperationIdentifier *string `locationName:"operationIdentifier" min:"36" type:"string"` + // The landing zone operation type. // // Valid values: @@ -4645,6 +4800,12 @@ func (s *LandingZoneOperationDetail) SetEndTime(v time.Time) *LandingZoneOperati return s } +// SetOperationIdentifier sets the OperationIdentifier field's value. +func (s *LandingZoneOperationDetail) SetOperationIdentifier(v string) *LandingZoneOperationDetail { + s.OperationIdentifier = &v + return s +} + // SetOperationType sets the OperationType field's value. func (s *LandingZoneOperationDetail) SetOperationType(v string) *LandingZoneOperationDetail { s.OperationType = &v @@ -4669,6 +4830,114 @@ func (s *LandingZoneOperationDetail) SetStatusMessage(v string) *LandingZoneOper return s } +// A filter object that lets you call ListLandingZoneOperations with a specific +// filter. +type LandingZoneOperationFilter struct { + _ struct{} `type:"structure"` + + // The statuses of the set of landing zone operations selected by the filter. + Statuses []*string `locationName:"statuses" min:"1" type:"list" enum:"LandingZoneOperationStatus"` + + // The set of landing zone operation types selected by the filter. + Types []*string `locationName:"types" min:"1" type:"list" enum:"LandingZoneOperationType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LandingZoneOperationFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LandingZoneOperationFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *LandingZoneOperationFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "LandingZoneOperationFilter"} + if s.Statuses != nil && len(s.Statuses) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Statuses", 1)) + } + if s.Types != nil && len(s.Types) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Types", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetStatuses sets the Statuses field's value. +func (s *LandingZoneOperationFilter) SetStatuses(v []*string) *LandingZoneOperationFilter { + s.Statuses = v + return s +} + +// SetTypes sets the Types field's value. +func (s *LandingZoneOperationFilter) SetTypes(v []*string) *LandingZoneOperationFilter { + s.Types = v + return s +} + +// Returns a summary of information about a landing zone operation. +type LandingZoneOperationSummary struct { + _ struct{} `type:"structure"` + + // The operationIdentifier of the landing zone operation. + OperationIdentifier *string `locationName:"operationIdentifier" min:"36" type:"string"` + + // The type of the landing zone operation. + OperationType *string `locationName:"operationType" type:"string" enum:"LandingZoneOperationType"` + + // The status of the landing zone operation. + Status *string `locationName:"status" type:"string" enum:"LandingZoneOperationStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LandingZoneOperationSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s LandingZoneOperationSummary) GoString() string { + return s.String() +} + +// SetOperationIdentifier sets the OperationIdentifier field's value. +func (s *LandingZoneOperationSummary) SetOperationIdentifier(v string) *LandingZoneOperationSummary { + s.OperationIdentifier = &v + return s +} + +// SetOperationType sets the OperationType field's value. +func (s *LandingZoneOperationSummary) SetOperationType(v string) *LandingZoneOperationSummary { + s.OperationType = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *LandingZoneOperationSummary) SetStatus(v string) *LandingZoneOperationSummary { + s.Status = &v + return s +} + // Returns a summary of information about a landing zone. type LandingZoneSummary struct { _ struct{} `type:"structure"` @@ -4867,7 +5136,7 @@ func (s *ListControlOperationsInput) SetNextToken(v string) *ListControlOperatio type ListControlOperationsOutput struct { _ struct{} `type:"structure"` - // Returns a list of output from control operations. PLACEHOLDER + // Returns a list of output from control operations. // // ControlOperations is a required field ControlOperations []*ControlOperationSummary `locationName:"controlOperations" type:"list" required:"true"` @@ -5020,7 +5289,7 @@ func (s *ListEnabledBaselinesOutput) SetNextToken(v string) *ListEnabledBaseline type ListEnabledControlsInput struct { _ struct{} `type:"structure"` - // An input filter for the ListCEnabledControls API that lets you select the + // An input filter for the ListEnabledControls API that lets you select the // types of control operations to view. Filter *EnabledControlFilter `locationName:"filter" type:"structure"` @@ -5142,6 +5411,117 @@ func (s *ListEnabledControlsOutput) SetNextToken(v string) *ListEnabledControlsO return s } +type ListLandingZoneOperationsInput struct { + _ struct{} `type:"structure"` + + // An input filter for the ListLandingZoneOperations API that lets you select + // the types of landing zone operations to view. + Filter *LandingZoneOperationFilter `locationName:"filter" type:"structure"` + + // How many results to return per API call. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // The token to continue the list from a previous API call with the same parameters. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListLandingZoneOperationsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListLandingZoneOperationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListLandingZoneOperationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListLandingZoneOperationsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.Filter != nil { + if err := s.Filter.Validate(); err != nil { + invalidParams.AddNested("Filter", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFilter sets the Filter field's value. +func (s *ListLandingZoneOperationsInput) SetFilter(v *LandingZoneOperationFilter) *ListLandingZoneOperationsInput { + s.Filter = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListLandingZoneOperationsInput) SetMaxResults(v int64) *ListLandingZoneOperationsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListLandingZoneOperationsInput) SetNextToken(v string) *ListLandingZoneOperationsInput { + s.NextToken = &v + return s +} + +type ListLandingZoneOperationsOutput struct { + _ struct{} `type:"structure"` + + // Lists landing zone operations. + // + // LandingZoneOperations is a required field + LandingZoneOperations []*LandingZoneOperationSummary `locationName:"landingZoneOperations" type:"list" required:"true"` + + // Retrieves the next page of results. If the string is empty, the response + // is the end of the results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListLandingZoneOperationsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListLandingZoneOperationsOutput) GoString() string { + return s.String() +} + +// SetLandingZoneOperations sets the LandingZoneOperations field's value. +func (s *ListLandingZoneOperationsOutput) SetLandingZoneOperations(v []*LandingZoneOperationSummary) *ListLandingZoneOperationsOutput { + s.LandingZoneOperations = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListLandingZoneOperationsOutput) SetNextToken(v string) *ListLandingZoneOperationsOutput { + s.NextToken = &v + return s +} + type ListLandingZonesInput struct { _ struct{} `type:"structure"` diff --git a/service/controltower/controltoweriface/interface.go b/service/controltower/controltoweriface/interface.go index f7d876f0957..a256a381094 100644 --- a/service/controltower/controltoweriface/interface.go +++ b/service/controltower/controltoweriface/interface.go @@ -132,6 +132,13 @@ type ControlTowerAPI interface { ListEnabledControlsPages(*controltower.ListEnabledControlsInput, func(*controltower.ListEnabledControlsOutput, bool) bool) error ListEnabledControlsPagesWithContext(aws.Context, *controltower.ListEnabledControlsInput, func(*controltower.ListEnabledControlsOutput, bool) bool, ...request.Option) error + ListLandingZoneOperations(*controltower.ListLandingZoneOperationsInput) (*controltower.ListLandingZoneOperationsOutput, error) + ListLandingZoneOperationsWithContext(aws.Context, *controltower.ListLandingZoneOperationsInput, ...request.Option) (*controltower.ListLandingZoneOperationsOutput, error) + ListLandingZoneOperationsRequest(*controltower.ListLandingZoneOperationsInput) (*request.Request, *controltower.ListLandingZoneOperationsOutput) + + ListLandingZoneOperationsPages(*controltower.ListLandingZoneOperationsInput, func(*controltower.ListLandingZoneOperationsOutput, bool) bool) error + ListLandingZoneOperationsPagesWithContext(aws.Context, *controltower.ListLandingZoneOperationsInput, func(*controltower.ListLandingZoneOperationsOutput, bool) bool, ...request.Option) error + ListLandingZones(*controltower.ListLandingZonesInput) (*controltower.ListLandingZonesOutput, error) ListLandingZonesWithContext(aws.Context, *controltower.ListLandingZonesInput, ...request.Option) (*controltower.ListLandingZonesOutput, error) ListLandingZonesRequest(*controltower.ListLandingZonesInput) (*request.Request, *controltower.ListLandingZonesOutput) diff --git a/service/controltower/doc.go b/service/controltower/doc.go index b3bad8bf2e4..2534c644615 100644 --- a/service/controltower/doc.go +++ b/service/controltower/doc.go @@ -7,11 +7,38 @@ // (API) operations that support programmatic interaction with these types of // resources: // -// - controls (https://docs.aws.amazon.com/controltower/latest/userguide/controls.html) -// -// - landing zones (https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch.html) -// -// - baselines (https://docs.aws.amazon.com/controltower/latest/userguide/types-of-baselines.html) +// - Controls (https://docs.aws.amazon.com/controltower/latest/userguide/controls.html) +// DisableControl (https://docs.aws.amazon.com/controltower/latest/APIReference/API_DisableControl.html) +// EnableControl (https://docs.aws.amazon.com/controltower/latest/APIReference/API_EnableControl.html) +// GetEnabledControl (https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetEnabledControl.html) +// ListControlOperations (https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListControlOperations.html) +// ListEnabledControls (https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListEnabledControls.html) +// UpdateEnabledControl (https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateEnabledControl.html) +// +// - Landing zones (https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch.html) +// CreateLandingZone (https://docs.aws.amazon.com/controltower/latest/APIReference/API_CreateLandingZone.html) +// DeleteLandingZone (https://docs.aws.amazon.com/controltower/latest/APIReference/API_DeleteLandingZone.html) +// GetLandingZone (https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetLandingZone.html) +// GetLandingZoneOperation (https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetLandingZoneOperation.html) +// ListLandingZones (https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListLandingZones.html) +// ResetLandingZone (https://docs.aws.amazon.com/controltower/latest/APIReference/API_ResetLandingZone.html) +// UpdateLandingZone (https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateLandingZone.html) +// +// - Baselines (https://docs.aws.amazon.com/controltower/latest/userguide/types-of-baselines.html) +// DisableBaseline (https://docs.aws.amazon.com/controltower/latest/APIReference/API_DisableBaseline.html) +// EnableBaseline (https://docs.aws.amazon.com/controltower/latest/APIReference/API_EnableBaseline.html) +// GetBaseline (https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetBaseline.html) +// GetBaselineOperation (https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetBaselineOperation.html) +// GetEnabledBaseline (https://docs.aws.amazon.com/controltower/latest/APIReference/API_GetEnabledBaseline.html) +// ListBaselines (https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListBaselines.html) +// ListEnabledBaselines (https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListEnabledBaselines.html) +// ResetEnabledBaseline (https://docs.aws.amazon.com/controltower/latest/APIReference/API_ResetEnabledBaseline.html) +// UpdateEnabledBaseline (https://docs.aws.amazon.com/controltower/latest/APIReference/API_UpdateEnabledBaseline.html) +// +// - Tagging (https://docs.aws.amazon.com/controltower/latest/controlreference/tagging.html) +// ListTagsForResource (https://docs.aws.amazon.com/controltower/latest/APIReference/API_ListTagsForResource.html) +// TagResource (https://docs.aws.amazon.com/controltower/latest/APIReference/API_TagResource.html) +// UntagResource (https://docs.aws.amazon.com/controltower/latest/APIReference/API_UntagResource.html) // // For more information about these types of resources, see the Amazon Web Services // Control Tower User Guide (https://docs.aws.amazon.com/controltower/latest/userguide/what-is-control-tower.html). @@ -39,16 +66,15 @@ // // The controlIdentifier is unique in each Amazon Web Services Region for each // control. You can find the controlIdentifier for each Region and control in -// the Tables of control metadata (https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html) -// or the Control availability by Region tables (https://docs.aws.amazon.com/controltower/latest/userguide/control-region-tables.html) -// in the Amazon Web Services Control Tower User Guide. +// the Tables of control metadata (https://docs.aws.amazon.com/controltower/latest/controlreference/control-metadata-tables.html) +// or the Control availability by Region tables (https://docs.aws.amazon.com/controltower/latest/controlreference/control-region-tables.html) +// in the Amazon Web Services Control Tower Controls Reference Guide. // // A quick-reference list of control identifers for the Amazon Web Services // Control Tower legacy Strongly recommended and Elective controls is given -// in Resource identifiers for APIs and controls (https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html.html) -// in the Controls reference guide section (https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html) -// of the Amazon Web Services Control Tower User Guide. Remember that Mandatory -// controls cannot be added or removed. +// in Resource identifiers for APIs and controls (https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html.html) +// in the Amazon Web Services Control Tower Controls Reference Guide (https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html). +// Remember that Mandatory controls cannot be added or removed. // // ARN format: arn:aws:controltower:{REGION}::control/{CONTROL_NAME} // @@ -98,23 +124,23 @@ // // Details and examples // -// - Control API input and output examples with CLI (https://docs.aws.amazon.com/controltower/latest/userguide/control-api-examples-short.html) +// - Control API input and output examples with CLI (https://docs.aws.amazon.com/controltower/latest/controlreference/control-api-examples-short.html) // // - Baseline API input and output examples with CLI (https://docs.aws.amazon.com/controltower/latest/userguide/baseline-api-examples.html) // -// - Enable controls with CloudFormation (https://docs.aws.amazon.com/controltower/latest/userguide/enable-controls.html) +// - Enable controls with CloudFormation (https://docs.aws.amazon.com/controltower/latest/controlreference/enable-controls.html) // // - Launch a landing zone with CloudFormation (https://docs.aws.amazon.com/controltower/latest/userguide/lz-apis-cfn-setup.html) // -// - Control metadata tables (large page) (https://docs.aws.amazon.com/controltower/latest/userguide/control-metadata-tables.html) +// - Control metadata tables (large page) (https://docs.aws.amazon.com/controltower/latest/controlreference/control-metadata-tables.html) // -// - Control availability by Region tables (large page) (https://docs.aws.amazon.com/controltower/latest/userguide/control-region-tables.html) +// - Control availability by Region tables (large page) (https://docs.aws.amazon.com/controltower/latest/controlreference/control-region-tables.html) // -// - List of identifiers for legacy controls (https://docs.aws.amazon.com/controltower/latest/userguide/control-identifiers.html) +// - List of identifiers for legacy controls (https://docs.aws.amazon.com/controltower/latest/controlreference/control-identifiers.html) // -// - Controls reference guide (https://docs.aws.amazon.com/controltower/latest/userguide/controls.html) +// - Controls reference guide (https://docs.aws.amazon.com/controltower/latest/controlreference/controls.html) // -// - Controls library groupings (https://docs.aws.amazon.com/controltower/latest/userguide/controls-reference.html) +// - Controls library groupings (https://docs.aws.amazon.com/controltower/latest/controlreference/controls-reference.html) // // - Creating Amazon Web Services Control Tower resources with Amazon Web // Services CloudFormation (https://docs.aws.amazon.com/controltower/latest/userguide/creating-resources-with-cloudformation.html) diff --git a/service/eks/api.go b/service/eks/api.go index 5bf8b53e56b..bc3cb0f0af5 100644 --- a/service/eks/api.go +++ b/service/eks/api.go @@ -8951,6 +8951,15 @@ type CreateClusterInput struct { // The access configuration for the cluster. AccessConfig *CreateAccessConfigRequest `locationName:"accessConfig" type:"structure"` + // If you set this value to False when creating a cluster, the default networking + // add-ons will not be installed. + // + // The default networking addons include vpc-cni, coredns, and kube-proxy. + // + // Use this option when you plan to install third-party alternative add-ons + // or self-manage the default networking add-ons. + BootstrapSelfManagedAddons *bool `locationName:"bootstrapSelfManagedAddons" type:"boolean"` + // A unique, case-sensitive identifier that you provide to ensure the idempotency // of the request. ClientRequestToken *string `locationName:"clientRequestToken" type:"string" idempotencyToken:"true"` @@ -9071,6 +9080,12 @@ func (s *CreateClusterInput) SetAccessConfig(v *CreateAccessConfigRequest) *Crea return s } +// SetBootstrapSelfManagedAddons sets the BootstrapSelfManagedAddons field's value. +func (s *CreateClusterInput) SetBootstrapSelfManagedAddons(v bool) *CreateClusterInput { + s.BootstrapSelfManagedAddons = &v + return s +} + // SetClientRequestToken sets the ClientRequestToken field's value. func (s *CreateClusterInput) SetClientRequestToken(v string) *CreateClusterInput { s.ClientRequestToken = &v diff --git a/service/ivsrealtime/api.go b/service/ivsrealtime/api.go index 188443c18fa..226574d7f55 100644 --- a/service/ivsrealtime/api.go +++ b/service/ivsrealtime/api.go @@ -460,6 +460,95 @@ func (c *IVSRealTime) DeleteEncoderConfigurationWithContext(ctx aws.Context, inp return out, req.Send() } +const opDeletePublicKey = "DeletePublicKey" + +// DeletePublicKeyRequest generates a "aws/request.Request" representing the +// client's request for the DeletePublicKey operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeletePublicKey for more information on using the DeletePublicKey +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DeletePublicKeyRequest method. +// req, resp := client.DeletePublicKeyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeletePublicKey +func (c *IVSRealTime) DeletePublicKeyRequest(input *DeletePublicKeyInput) (req *request.Request, output *DeletePublicKeyOutput) { + op := &request.Operation{ + Name: opDeletePublicKey, + HTTPMethod: "POST", + HTTPPath: "/DeletePublicKey", + } + + if input == nil { + input = &DeletePublicKeyInput{} + } + + output = &DeletePublicKeyOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeletePublicKey API operation for Amazon Interactive Video Service RealTime. +// +// Deletes the specified public key used to sign stage participant tokens. This +// invalidates future participant tokens generated using the key pair’s private +// key. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Interactive Video Service RealTime's +// API operation DeletePublicKey for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// +// - ValidationException +// +// - AccessDeniedException +// +// - ConflictException +// +// - PendingVerification +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/DeletePublicKey +func (c *IVSRealTime) DeletePublicKey(input *DeletePublicKeyInput) (*DeletePublicKeyOutput, error) { + req, out := c.DeletePublicKeyRequest(input) + return out, req.Send() +} + +// DeletePublicKeyWithContext is the same as DeletePublicKey with the addition of +// the ability to pass a context and additional request options. +// +// See DeletePublicKey for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IVSRealTime) DeletePublicKeyWithContext(ctx aws.Context, input *DeletePublicKeyInput, opts ...request.Option) (*DeletePublicKeyOutput, error) { + req, out := c.DeletePublicKeyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteStage = "DeleteStage" // DeleteStageRequest generates a "aws/request.Request" representing the @@ -985,6 +1074,88 @@ func (c *IVSRealTime) GetParticipantWithContext(ctx aws.Context, input *GetParti return out, req.Send() } +const opGetPublicKey = "GetPublicKey" + +// GetPublicKeyRequest generates a "aws/request.Request" representing the +// client's request for the GetPublicKey operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetPublicKey for more information on using the GetPublicKey +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the GetPublicKeyRequest method. +// req, resp := client.GetPublicKeyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetPublicKey +func (c *IVSRealTime) GetPublicKeyRequest(input *GetPublicKeyInput) (req *request.Request, output *GetPublicKeyOutput) { + op := &request.Operation{ + Name: opGetPublicKey, + HTTPMethod: "POST", + HTTPPath: "/GetPublicKey", + } + + if input == nil { + input = &GetPublicKeyInput{} + } + + output = &GetPublicKeyOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetPublicKey API operation for Amazon Interactive Video Service RealTime. +// +// Gets information for the specified public key. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Interactive Video Service RealTime's +// API operation GetPublicKey for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// +// - ValidationException +// +// - AccessDeniedException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/GetPublicKey +func (c *IVSRealTime) GetPublicKey(input *GetPublicKeyInput) (*GetPublicKeyOutput, error) { + req, out := c.GetPublicKeyRequest(input) + return out, req.Send() +} + +// GetPublicKeyWithContext is the same as GetPublicKey with the addition of +// the ability to pass a context and additional request options. +// +// See GetPublicKey for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IVSRealTime) GetPublicKeyWithContext(ctx aws.Context, input *GetPublicKeyInput, opts ...request.Option) (*GetPublicKeyOutput, error) { + req, out := c.GetPublicKeyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetStage = "GetStage" // GetStageRequest generates a "aws/request.Request" representing the @@ -1237,6 +1408,92 @@ func (c *IVSRealTime) GetStorageConfigurationWithContext(ctx aws.Context, input return out, req.Send() } +const opImportPublicKey = "ImportPublicKey" + +// ImportPublicKeyRequest generates a "aws/request.Request" representing the +// client's request for the ImportPublicKey operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ImportPublicKey for more information on using the ImportPublicKey +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ImportPublicKeyRequest method. +// req, resp := client.ImportPublicKeyRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ImportPublicKey +func (c *IVSRealTime) ImportPublicKeyRequest(input *ImportPublicKeyInput) (req *request.Request, output *ImportPublicKeyOutput) { + op := &request.Operation{ + Name: opImportPublicKey, + HTTPMethod: "POST", + HTTPPath: "/ImportPublicKey", + } + + if input == nil { + input = &ImportPublicKeyInput{} + } + + output = &ImportPublicKeyOutput{} + req = c.newRequest(op, input, output) + return +} + +// ImportPublicKey API operation for Amazon Interactive Video Service RealTime. +// +// Import a public key to be used for signing stage participant tokens. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Interactive Video Service RealTime's +// API operation ImportPublicKey for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// +// - AccessDeniedException +// +// - ServiceQuotaExceededException +// +// - ConflictException +// +// - PendingVerification +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ImportPublicKey +func (c *IVSRealTime) ImportPublicKey(input *ImportPublicKeyInput) (*ImportPublicKeyOutput, error) { + req, out := c.ImportPublicKeyRequest(input) + return out, req.Send() +} + +// ImportPublicKeyWithContext is the same as ImportPublicKey with the addition of +// the ability to pass a context and additional request options. +// +// See ImportPublicKey for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IVSRealTime) ImportPublicKeyWithContext(ctx aws.Context, input *ImportPublicKeyInput, opts ...request.Option) (*ImportPublicKeyOutput, error) { + req, out := c.ImportPublicKeyRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opListCompositions = "ListCompositions" // ListCompositionsRequest generates a "aws/request.Request" representing the @@ -1753,38 +2010,176 @@ func (c *IVSRealTime) ListParticipantsWithContext(ctx aws.Context, input *ListPa // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListParticipants method for more information on how to use this operation. +// See ListParticipants method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListParticipants operation. +// pageNum := 0 +// err := client.ListParticipantsPages(params, +// func(page *ivsrealtime.ListParticipantsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *IVSRealTime) ListParticipantsPages(input *ListParticipantsInput, fn func(*ListParticipantsOutput, bool) bool) error { + return c.ListParticipantsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListParticipantsPagesWithContext same as ListParticipantsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IVSRealTime) ListParticipantsPagesWithContext(ctx aws.Context, input *ListParticipantsInput, fn func(*ListParticipantsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListParticipantsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListParticipantsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListParticipantsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListPublicKeys = "ListPublicKeys" + +// ListPublicKeysRequest generates a "aws/request.Request" representing the +// client's request for the ListPublicKeys operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListPublicKeys for more information on using the ListPublicKeys +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListPublicKeysRequest method. +// req, resp := client.ListPublicKeysRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListPublicKeys +func (c *IVSRealTime) ListPublicKeysRequest(input *ListPublicKeysInput) (req *request.Request, output *ListPublicKeysOutput) { + op := &request.Operation{ + Name: opListPublicKeys, + HTTPMethod: "POST", + HTTPPath: "/ListPublicKeys", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListPublicKeysInput{} + } + + output = &ListPublicKeysOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListPublicKeys API operation for Amazon Interactive Video Service RealTime. +// +// Gets summary information about all public keys in your account, in the AWS +// region where the API request is processed. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Interactive Video Service RealTime's +// API operation ListPublicKeys for usage and error information. +// +// Returned Error Types: +// +// - ValidationException +// +// - AccessDeniedException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14/ListPublicKeys +func (c *IVSRealTime) ListPublicKeys(input *ListPublicKeysInput) (*ListPublicKeysOutput, error) { + req, out := c.ListPublicKeysRequest(input) + return out, req.Send() +} + +// ListPublicKeysWithContext is the same as ListPublicKeys with the addition of +// the ability to pass a context and additional request options. +// +// See ListPublicKeys for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IVSRealTime) ListPublicKeysWithContext(ctx aws.Context, input *ListPublicKeysInput, opts ...request.Option) (*ListPublicKeysOutput, error) { + req, out := c.ListPublicKeysRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListPublicKeysPages iterates over the pages of a ListPublicKeys operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListPublicKeys method for more information on how to use this operation. // // Note: This operation can generate multiple requests to a service. // -// // Example iterating over at most 3 pages of a ListParticipants operation. +// // Example iterating over at most 3 pages of a ListPublicKeys operation. // pageNum := 0 -// err := client.ListParticipantsPages(params, -// func(page *ivsrealtime.ListParticipantsOutput, lastPage bool) bool { +// err := client.ListPublicKeysPages(params, +// func(page *ivsrealtime.ListPublicKeysOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) -func (c *IVSRealTime) ListParticipantsPages(input *ListParticipantsInput, fn func(*ListParticipantsOutput, bool) bool) error { - return c.ListParticipantsPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *IVSRealTime) ListPublicKeysPages(input *ListPublicKeysInput, fn func(*ListPublicKeysOutput, bool) bool) error { + return c.ListPublicKeysPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListParticipantsPagesWithContext same as ListParticipantsPages except +// ListPublicKeysPagesWithContext same as ListPublicKeysPages except // it takes a Context and allows setting request options on the pages. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *IVSRealTime) ListParticipantsPagesWithContext(ctx aws.Context, input *ListParticipantsInput, fn func(*ListParticipantsOutput, bool) bool, opts ...request.Option) error { +func (c *IVSRealTime) ListPublicKeysPagesWithContext(ctx aws.Context, input *ListPublicKeysInput, fn func(*ListPublicKeysOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListParticipantsInput + var inCpy *ListPublicKeysInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListParticipantsRequest(inCpy) + req, _ := c.ListPublicKeysRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -1792,7 +2187,7 @@ func (c *IVSRealTime) ListParticipantsPagesWithContext(ctx aws.Context, input *L } for p.Next() { - if !fn(p.Page().(*ListParticipantsOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListPublicKeysOutput), !p.HasNextPage()) { break } } @@ -2820,17 +3215,17 @@ func (s *AccessDeniedException) RequestID() string { return s.RespMetadata.RequestID } -// Object specifying an auto-participant-recording configuration. +// Object specifying a configuration for individual participant recording. type AutoParticipantRecordingConfiguration struct { _ struct{} `type:"structure"` // Types of media to be recorded. Default: AUDIO_VIDEO. MediaTypes []*string `locationName:"mediaTypes" type:"list" enum:"ParticipantRecordingMediaType"` - // 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. + // 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. // // StorageConfigurationArn is a required field StorageConfigurationArn *string `locationName:"storageConfigurationArn" type:"string" required:"true"` @@ -3451,7 +3846,8 @@ func (s *CreateParticipantTokenOutput) SetParticipantToken(v *ParticipantToken) type CreateStageInput struct { _ struct{} `type:"structure"` - // Auto participant recording configuration object attached to the stage. + // Configuration object for individual participant recording, to attach to the + // new stage. AutoParticipantRecordingConfiguration *AutoParticipantRecordingConfiguration `locationName:"autoParticipantRecordingConfiguration" type:"structure"` // Optional name that can be specified for the stage being created. @@ -3752,6 +4148,77 @@ func (s DeleteEncoderConfigurationOutput) GoString() string { return s.String() } +type DeletePublicKeyInput struct { + _ struct{} `type:"structure"` + + // ARN of the public key to be deleted. + // + // Arn is a required field + Arn *string `locationName:"arn" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePublicKeyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePublicKeyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeletePublicKeyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeletePublicKeyInput"} + if s.Arn == nil { + invalidParams.Add(request.NewErrParamRequired("Arn")) + } + if s.Arn != nil && len(*s.Arn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Arn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetArn sets the Arn field's value. +func (s *DeletePublicKeyInput) SetArn(v string) *DeletePublicKeyInput { + s.Arn = &v + return s +} + +type DeletePublicKeyOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePublicKeyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePublicKeyOutput) GoString() string { + return s.String() +} + type DeleteStageInput struct { _ struct{} `type:"structure"` @@ -4717,6 +5184,86 @@ func (s *GetParticipantOutput) SetParticipant(v *Participant) *GetParticipantOut return s } +type GetPublicKeyInput struct { + _ struct{} `type:"structure"` + + // ARN of the public key for which the information is to be retrieved. + // + // Arn is a required field + Arn *string `locationName:"arn" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetPublicKeyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetPublicKeyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetPublicKeyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetPublicKeyInput"} + if s.Arn == nil { + invalidParams.Add(request.NewErrParamRequired("Arn")) + } + if s.Arn != nil && len(*s.Arn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Arn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetArn sets the Arn field's value. +func (s *GetPublicKeyInput) SetArn(v string) *GetPublicKeyInput { + s.Arn = &v + return s +} + +type GetPublicKeyOutput struct { + _ struct{} `type:"structure"` + + // The public key that is returned. + PublicKey *PublicKey `locationName:"publicKey" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetPublicKeyOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetPublicKeyOutput) GoString() string { + return s.String() +} + +// SetPublicKey sets the PublicKey field's value. +func (s *GetPublicKeyOutput) SetPublicKey(v *PublicKey) *GetPublicKeyOutput { + s.PublicKey = v + return s +} + type GetStageInput struct { _ struct{} `type:"structure"` @@ -4974,30 +5521,156 @@ func (s *GetStorageConfigurationOutput) SetStorageConfiguration(v *StorageConfig return s } -// Configuration information specific to Grid layout, for server-side composition. -// See "Layouts" in Server-Side Composition (https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html). -type GridConfiguration struct { +// Configuration information specific to Grid layout, for server-side composition. +// See "Layouts" in Server-Side Composition (https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/server-side-composition.html). +type GridConfiguration struct { + _ struct{} `type:"structure"` + + // This attribute name identifies the featured slot. A participant with this + // attribute set to "true" (as a string value) in ParticipantTokenConfiguration + // is placed in the featured slot. Default: "" (no featured participant). + FeaturedParticipantAttribute *string `locationName:"featuredParticipantAttribute" type:"string"` + + // Specifies the spacing between participant tiles in pixels. Default: 2. + GridGap *int64 `locationName:"gridGap" type:"integer"` + + // Determines whether to omit participants with stopped video in the composition. + // Default: false. + OmitStoppedVideo *bool `locationName:"omitStoppedVideo" type:"boolean"` + + // 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. + VideoAspectRatio *string `locationName:"videoAspectRatio" type:"string" enum:"VideoAspectRatio"` + + // Defines how video content fits within the participant tile: FILL (stretched), + // COVER (cropped), or CONTAIN (letterboxed). When not set, videoFillMode defaults + // to COVER fill mode for participants in the grid and to CONTAIN fill mode + // for featured participants. + VideoFillMode *string `locationName:"videoFillMode" type:"string" enum:"VideoFillMode"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GridConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GridConfiguration) GoString() string { + return s.String() +} + +// SetFeaturedParticipantAttribute sets the FeaturedParticipantAttribute field's value. +func (s *GridConfiguration) SetFeaturedParticipantAttribute(v string) *GridConfiguration { + s.FeaturedParticipantAttribute = &v + return s +} + +// SetGridGap sets the GridGap field's value. +func (s *GridConfiguration) SetGridGap(v int64) *GridConfiguration { + s.GridGap = &v + return s +} + +// SetOmitStoppedVideo sets the OmitStoppedVideo field's value. +func (s *GridConfiguration) SetOmitStoppedVideo(v bool) *GridConfiguration { + s.OmitStoppedVideo = &v + return s +} + +// SetVideoAspectRatio sets the VideoAspectRatio field's value. +func (s *GridConfiguration) SetVideoAspectRatio(v string) *GridConfiguration { + s.VideoAspectRatio = &v + return s +} + +// SetVideoFillMode sets the VideoFillMode field's value. +func (s *GridConfiguration) SetVideoFillMode(v string) *GridConfiguration { + s.VideoFillMode = &v + return s +} + +type ImportPublicKeyInput struct { + _ struct{} `type:"structure"` + + // Name of the public key to be imported. + Name *string `locationName:"name" type:"string"` + + // The content of the public key to be imported. + // + // PublicKeyMaterial is a required field + PublicKeyMaterial *string `locationName:"publicKeyMaterial" type:"string" required:"true"` + + // Tags attached to the resource. Array of maps, each of the form string:string + // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS has no constraints on tags beyond what is documented + // there. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ImportPublicKeyInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ImportPublicKeyInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ImportPublicKeyInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ImportPublicKeyInput"} + if s.PublicKeyMaterial == nil { + invalidParams.Add(request.NewErrParamRequired("PublicKeyMaterial")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *ImportPublicKeyInput) SetName(v string) *ImportPublicKeyInput { + s.Name = &v + return s +} + +// SetPublicKeyMaterial sets the PublicKeyMaterial field's value. +func (s *ImportPublicKeyInput) SetPublicKeyMaterial(v string) *ImportPublicKeyInput { + s.PublicKeyMaterial = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *ImportPublicKeyInput) SetTags(v map[string]*string) *ImportPublicKeyInput { + s.Tags = v + return s +} + +type ImportPublicKeyOutput struct { _ struct{} `type:"structure"` - // This attribute name identifies the featured slot. A participant with this - // attribute set to "true" (as a string value) in ParticipantTokenConfiguration - // is placed in the featured slot. - FeaturedParticipantAttribute *string `locationName:"featuredParticipantAttribute" type:"string"` - - // Specifies the spacing between participant tiles in pixels. Default: 2. - GridGap *int64 `locationName:"gridGap" type:"integer"` - - // Determines whether to omit participants with stopped video in the composition. - // Default: false. - OmitStoppedVideo *bool `locationName:"omitStoppedVideo" type:"boolean"` - - // Sets the non-featured participant display mode. Default: VIDEO. - VideoAspectRatio *string `locationName:"videoAspectRatio" type:"string" enum:"VideoAspectRatio"` - - // Defines how video fits within the participant tile. When not set, videoFillMode - // defaults to COVER fill mode for participants in the grid and to CONTAIN fill - // mode for featured participants. - VideoFillMode *string `locationName:"videoFillMode" type:"string" enum:"VideoFillMode"` + // The public key that was imported. + PublicKey *PublicKey `locationName:"publicKey" type:"structure"` } // String returns the string representation. @@ -5005,7 +5678,7 @@ type GridConfiguration struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GridConfiguration) String() string { +func (s ImportPublicKeyOutput) String() string { return awsutil.Prettify(s) } @@ -5014,37 +5687,13 @@ func (s GridConfiguration) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GridConfiguration) GoString() string { +func (s ImportPublicKeyOutput) GoString() string { return s.String() } -// SetFeaturedParticipantAttribute sets the FeaturedParticipantAttribute field's value. -func (s *GridConfiguration) SetFeaturedParticipantAttribute(v string) *GridConfiguration { - s.FeaturedParticipantAttribute = &v - return s -} - -// SetGridGap sets the GridGap field's value. -func (s *GridConfiguration) SetGridGap(v int64) *GridConfiguration { - s.GridGap = &v - return s -} - -// SetOmitStoppedVideo sets the OmitStoppedVideo field's value. -func (s *GridConfiguration) SetOmitStoppedVideo(v bool) *GridConfiguration { - s.OmitStoppedVideo = &v - return s -} - -// SetVideoAspectRatio sets the VideoAspectRatio field's value. -func (s *GridConfiguration) SetVideoAspectRatio(v string) *GridConfiguration { - s.VideoAspectRatio = &v - return s -} - -// SetVideoFillMode sets the VideoFillMode field's value. -func (s *GridConfiguration) SetVideoFillMode(v string) *GridConfiguration { - s.VideoFillMode = &v +// SetPublicKey sets the PublicKey field's value. +func (s *ImportPublicKeyOutput) SetPublicKey(v *PublicKey) *ImportPublicKeyOutput { + s.PublicKey = v return s } @@ -5712,6 +6361,103 @@ func (s *ListParticipantsOutput) SetParticipants(v []*ParticipantSummary) *ListP return s } +type ListPublicKeysInput struct { + _ struct{} `type:"structure"` + + // Maximum number of results to return. Default: 50. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // The first public key to retrieve. This is used for pagination; see the nextToken + // response field. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPublicKeysInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPublicKeysInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListPublicKeysInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListPublicKeysInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListPublicKeysInput) SetMaxResults(v int64) *ListPublicKeysInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListPublicKeysInput) SetNextToken(v string) *ListPublicKeysInput { + s.NextToken = &v + return s +} + +type ListPublicKeysOutput struct { + _ struct{} `type:"structure"` + + // If there are more public keys than maxResults, use nextToken in the request + // to get the next set. + NextToken *string `locationName:"nextToken" type:"string"` + + // List of the matching public keys (summary information only). + // + // PublicKeys is a required field + PublicKeys []*PublicKeySummary `locationName:"publicKeys" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPublicKeysOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListPublicKeysOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListPublicKeysOutput) SetNextToken(v string) *ListPublicKeysOutput { + s.NextToken = &v + return s +} + +// SetPublicKeys sets the PublicKeys field's value. +func (s *ListPublicKeysOutput) SetPublicKeys(v []*PublicKeySummary) *ListPublicKeysOutput { + s.PublicKeys = v + return s +} + type ListStageSessionsInput struct { _ struct{} `type:"structure"` @@ -6145,12 +6891,12 @@ type Participant struct { // enabled. RecordingS3BucketName *string `locationName:"recordingS3BucketName" type:"string"` - // 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. + // 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. RecordingS3Prefix *string `locationName:"recordingS3Prefix" type:"string"` - // Participant’s recording state. + // The participant’s recording state. RecordingState *string `locationName:"recordingState" type:"string" enum:"ParticipantRecordingState"` // The participant’s SDK version. @@ -6288,7 +7034,7 @@ type ParticipantSummary struct { // Whether the participant ever published to the stage session. Published *bool `locationName:"published" type:"boolean"` - // Participant’s recording state. + // The participant’s recording state. RecordingState *string `locationName:"recordingState" type:"string" enum:"ParticipantRecordingState"` // Whether the participant is connected to or disconnected from the stage. @@ -6607,7 +7353,7 @@ type PipConfiguration struct { // This attribute name identifies the featured slot. A participant with this // attribute set to "true" (as a string value) in ParticipantTokenConfiguration - // is placed in the featured slot. + // is placed in the featured slot. Default: "" (no featured participant). FeaturedParticipantAttribute *string `locationName:"featuredParticipantAttribute" type:"string"` // Specifies the spacing between participant tiles in pixels. Default: 0. @@ -6617,7 +7363,8 @@ type PipConfiguration struct { // Default: false. OmitStoppedVideo *bool `locationName:"omitStoppedVideo" type:"boolean"` - // Defines PiP behavior when all participants have left. Default: STATIC. + // Defines PiP behavior when all participants have left: STATIC (maintains original + // position/size) or DYNAMIC (expands to full composition). Default: STATIC. PipBehavior *string `locationName:"pipBehavior" type:"string" enum:"PipBehavior"` // Specifies the height of the PiP window in pixels. When this is not set explicitly, @@ -6629,9 +7376,9 @@ type PipConfiguration struct { // determined by PipPosition. Default: 0. PipOffset *int64 `locationName:"pipOffset" type:"integer"` - // Identifies the PiP slot. A participant with this attribute set to "true" - // (as a string value) in ParticipantTokenConfiguration is placed in the PiP - // slot. + // Specifies the participant for the PiP window. A participant with this attribute + // set to "true" (as a string value) in ParticipantTokenConfiguration is placed + // in the PiP slot. Default: "" (no PiP participant). PipParticipantAttribute *string `locationName:"pipParticipantAttribute" type:"string"` // Determines the corner position of the PiP window. Default: BOTTOM_RIGHT. @@ -6642,7 +7389,8 @@ type PipConfiguration struct { // ratio of the participant’s video. PipWidth *int64 `locationName:"pipWidth" min:"1" type:"integer"` - // Defines how video fits within the participant tile. Default: COVER. + // Defines how video content fits within the participant tile: FILL (stretched), + // COVER (cropped), or CONTAIN (letterboxed). Default: COVER. VideoFillMode *string `locationName:"videoFillMode" type:"string" enum:"VideoFillMode"` } @@ -6740,6 +7488,133 @@ func (s *PipConfiguration) SetVideoFillMode(v string) *PipConfiguration { return s } +// Object specifying a public key used to sign stage participant tokens. +type PublicKey struct { + _ struct{} `type:"structure"` + + // Public key ARN. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // The public key fingerprint, a short string used to identify or verify the + // full public key. + Fingerprint *string `locationName:"fingerprint" type:"string"` + + // Public key name. + Name *string `locationName:"name" type:"string"` + + // Public key material. + PublicKeyMaterial *string `locationName:"publicKeyMaterial" type:"string"` + + // Tags attached to the resource. Array of maps, each of the form string:string + // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS has no constraints on tags beyond what is documented + // there. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PublicKey) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PublicKey) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *PublicKey) SetArn(v string) *PublicKey { + s.Arn = &v + return s +} + +// SetFingerprint sets the Fingerprint field's value. +func (s *PublicKey) SetFingerprint(v string) *PublicKey { + s.Fingerprint = &v + return s +} + +// SetName sets the Name field's value. +func (s *PublicKey) SetName(v string) *PublicKey { + s.Name = &v + return s +} + +// SetPublicKeyMaterial sets the PublicKeyMaterial field's value. +func (s *PublicKey) SetPublicKeyMaterial(v string) *PublicKey { + s.PublicKeyMaterial = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *PublicKey) SetTags(v map[string]*string) *PublicKey { + s.Tags = v + return s +} + +// Summary information about a public key. +type PublicKeySummary struct { + _ struct{} `type:"structure"` + + // Public key ARN. + Arn *string `locationName:"arn" min:"1" type:"string"` + + // Public key name. + Name *string `locationName:"name" type:"string"` + + // Tags attached to the resource. Array of maps, each of the form string:string + // (key:value). See Tagging AWS Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) + // for details, including restrictions that apply to tags and "Tag naming limits + // and requirements"; Amazon IVS has no constraints on tags beyond what is documented + // there. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PublicKeySummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PublicKeySummary) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *PublicKeySummary) SetArn(v string) *PublicKeySummary { + s.Arn = &v + return s +} + +// SetName sets the Name field's value. +func (s *PublicKeySummary) SetName(v string) *PublicKeySummary { + s.Name = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *PublicKeySummary) SetTags(v map[string]*string) *PublicKeySummary { + s.Tags = v + return s +} + // An object representing a configuration to record a stage stream. type RecordingConfiguration struct { _ struct{} `type:"structure"` @@ -7083,9 +7958,13 @@ type Stage struct { // Arn is a required field Arn *string `locationName:"arn" min:"1" type:"string" required:"true"` - // Auto-participant-recording configuration object attached to the stage. + // Configuration object for individual participant recording, attached to the + // stage. AutoParticipantRecordingConfiguration *AutoParticipantRecordingConfiguration `locationName:"autoParticipantRecordingConfiguration" type:"structure"` + // Summary information about various endpoints for a stage. + Endpoints *StageEndpoints `locationName:"endpoints" type:"structure"` + // Stage name. Name *string `locationName:"name" type:"string"` @@ -7133,6 +8012,12 @@ func (s *Stage) SetAutoParticipantRecordingConfiguration(v *AutoParticipantRecor return s } +// SetEndpoints sets the Endpoints field's value. +func (s *Stage) SetEndpoints(v *StageEndpoints) *Stage { + s.Endpoints = v + return s +} + // SetName sets the Name field's value. func (s *Stage) SetName(v string) *Stage { s.Name = &v @@ -7145,6 +8030,47 @@ func (s *Stage) SetTags(v map[string]*string) *Stage { return s } +// Summary information about various endpoints for a stage. +type StageEndpoints struct { + _ struct{} `type:"structure"` + + // Events endpoint. + Events *string `locationName:"events" type:"string"` + + // WHIP endpoint. + Whip *string `locationName:"whip" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StageEndpoints) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StageEndpoints) GoString() string { + return s.String() +} + +// SetEvents sets the Events field's value. +func (s *StageEndpoints) SetEvents(v string) *StageEndpoints { + s.Events = &v + return s +} + +// SetWhip sets the Whip field's value. +func (s *StageEndpoints) SetWhip(v string) *StageEndpoints { + s.Whip = &v + return s +} + // A stage session begins when the first participant joins a stage and ends // after the last participant leaves the stage. A stage session helps with debugging // stages by grouping events and participants into shorter periods of time (i.e., @@ -7848,8 +8774,8 @@ type UpdateStageInput struct { // Arn is a required field Arn *string `locationName:"arn" min:"1" type:"string" required:"true"` - // Auto-participant-recording configuration object to attach to the stage. Auto-participant-recording - // configuration cannot be updated while recording is active. + // Configuration object for individual participant recording, to attach to the + // stage. Note that this cannot be updated while recording is active. AutoParticipantRecordingConfiguration *AutoParticipantRecordingConfiguration `locationName:"autoParticipantRecordingConfiguration" type:"structure"` // Name of the stage to be updated. diff --git a/service/ivsrealtime/doc.go b/service/ivsrealtime/doc.go index 279cef93d02..5c9da495f0b 100644 --- a/service/ivsrealtime/doc.go +++ b/service/ivsrealtime/doc.go @@ -3,40 +3,35 @@ // Package ivsrealtime provides the client and types for making API // requests to Amazon Interactive Video Service RealTime. // -// # Introduction -// // The Amazon Interactive Video Service (IVS) real-time API is REST compatible, // using a standard HTTP API and an AWS EventBridge event stream for responses. // JSON is used for both requests and responses, including errors. // -// Terminology: +// Key Concepts // -// - A stage is a virtual space where participants can exchange video in -// real time. +// - Stage — A virtual space where participants can exchange video in real +// time. // -// - A participant token is a token that authenticates a participant when +// - Participant token — A token that authenticates a participant when // they join a stage. // -// - A participant object represents participants (people) in the stage and -// contains information about them. When a token is created, it includes +// - Participant object — Represents participants (people) in the stage +// and contains information about them. When a token is created, it includes // a participant ID; when a participant uses that token to join a stage, // the participant is associated with that participant ID. There is a 1:1 // mapping between participant tokens and participants. // -// - Server-side composition: The composition process composites participants -// of a stage into a single video and forwards it to a set of outputs (e.g., -// IVS channels). Composition endpoints support this process. -// -// - Server-side composition: A composition controls the look of the outputs, -// including how participants are positioned in the video. +// For server-side composition: // -// # Resources +// - Composition process — Composites participants of a stage into a single +// video and forwards it to a set of outputs (e.g., IVS channels). Composition +// endpoints support this process. // -// The following resources contain information about your IVS live stream (see -// Getting Started with Amazon IVS Real-Time Streaming (https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html)): +// - Composition — Controls the look of the outputs, including how participants +// are positioned in the video. // -// - Stage — A stage is a virtual space where participants can exchange -// video in real time. +// For more information about your IVS live stream, also see Getting Started +// with Amazon IVS Real-Time Streaming (https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started.html). // // # Tagging // @@ -57,92 +52,6 @@ // // At most 50 tags can be applied to a resource. // -// Stages Endpoints -// -// - CreateParticipantToken — Creates an additional token for a specified -// stage. This can be done after stage creation or when tokens expire. -// -// - CreateStage — Creates a new stage (and optionally participant tokens). -// -// - DeleteStage — Shuts down and deletes the specified stage (disconnecting -// all participants). -// -// - DisconnectParticipant — Disconnects a specified participant and revokes -// the participant permanently from a specified stage. -// -// - GetParticipant — Gets information about the specified participant -// token. -// -// - GetStage — Gets information for the specified stage. -// -// - GetStageSession — Gets information for the specified stage session. -// -// - ListParticipantEvents — Lists events for a specified participant that -// occurred during a specified stage session. -// -// - ListParticipants — Lists all participants in a specified stage session. -// -// - ListStages — Gets summary information about all stages in your account, -// in the AWS region where the API request is processed. -// -// - ListStageSessions — Gets all sessions for a specified stage. -// -// - UpdateStage — Updates a stage’s configuration. -// -// Composition Endpoints -// -// - GetComposition — Gets information about the specified Composition -// resource. -// -// - ListCompositions — Gets summary information about all Compositions -// in your account, in the AWS region where the API request is processed. -// -// - StartComposition — Starts a Composition from a stage based on the -// configuration provided in the request. -// -// - StopComposition — Stops and deletes a Composition resource. Any broadcast -// from the Composition resource is stopped. -// -// EncoderConfiguration Endpoints -// -// - CreateEncoderConfiguration — Creates an EncoderConfiguration object. -// -// - DeleteEncoderConfiguration — Deletes an EncoderConfiguration resource. -// Ensures that no Compositions are using this template; otherwise, returns -// an error. -// -// - GetEncoderConfiguration — Gets information about the specified EncoderConfiguration -// resource. -// -// - ListEncoderConfigurations — Gets summary information about all EncoderConfigurations -// in your account, in the AWS region where the API request is processed. -// -// StorageConfiguration Endpoints -// -// - CreateStorageConfiguration — Creates a new storage configuration, -// used to enable recording to Amazon S3. -// -// - DeleteStorageConfiguration — Deletes the storage configuration for -// the specified ARN. -// -// - GetStorageConfiguration — Gets the storage configuration for the specified -// ARN. -// -// - ListStorageConfigurations — Gets summary information about all storage -// configurations in your account, in the AWS region where the API request -// is processed. -// -// Tags Endpoints -// -// - ListTagsForResource — Gets information about AWS tags for the specified -// ARN. -// -// - TagResource — Adds or updates tags for the AWS resource with the specified -// ARN. -// -// - UntagResource — Removes tags from the resource with the specified -// ARN. -// // See https://docs.aws.amazon.com/goto/WebAPI/ivs-realtime-2020-07-14 for more information on this service. // // See ivsrealtime package documentation for more information. diff --git a/service/ivsrealtime/ivsrealtimeiface/interface.go b/service/ivsrealtime/ivsrealtimeiface/interface.go index d7cf651cf03..5ec7947af0a 100644 --- a/service/ivsrealtime/ivsrealtimeiface/interface.go +++ b/service/ivsrealtime/ivsrealtimeiface/interface.go @@ -80,6 +80,10 @@ type IVSRealTimeAPI interface { DeleteEncoderConfigurationWithContext(aws.Context, *ivsrealtime.DeleteEncoderConfigurationInput, ...request.Option) (*ivsrealtime.DeleteEncoderConfigurationOutput, error) DeleteEncoderConfigurationRequest(*ivsrealtime.DeleteEncoderConfigurationInput) (*request.Request, *ivsrealtime.DeleteEncoderConfigurationOutput) + DeletePublicKey(*ivsrealtime.DeletePublicKeyInput) (*ivsrealtime.DeletePublicKeyOutput, error) + DeletePublicKeyWithContext(aws.Context, *ivsrealtime.DeletePublicKeyInput, ...request.Option) (*ivsrealtime.DeletePublicKeyOutput, error) + DeletePublicKeyRequest(*ivsrealtime.DeletePublicKeyInput) (*request.Request, *ivsrealtime.DeletePublicKeyOutput) + DeleteStage(*ivsrealtime.DeleteStageInput) (*ivsrealtime.DeleteStageOutput, error) DeleteStageWithContext(aws.Context, *ivsrealtime.DeleteStageInput, ...request.Option) (*ivsrealtime.DeleteStageOutput, error) DeleteStageRequest(*ivsrealtime.DeleteStageInput) (*request.Request, *ivsrealtime.DeleteStageOutput) @@ -104,6 +108,10 @@ type IVSRealTimeAPI interface { GetParticipantWithContext(aws.Context, *ivsrealtime.GetParticipantInput, ...request.Option) (*ivsrealtime.GetParticipantOutput, error) GetParticipantRequest(*ivsrealtime.GetParticipantInput) (*request.Request, *ivsrealtime.GetParticipantOutput) + GetPublicKey(*ivsrealtime.GetPublicKeyInput) (*ivsrealtime.GetPublicKeyOutput, error) + GetPublicKeyWithContext(aws.Context, *ivsrealtime.GetPublicKeyInput, ...request.Option) (*ivsrealtime.GetPublicKeyOutput, error) + GetPublicKeyRequest(*ivsrealtime.GetPublicKeyInput) (*request.Request, *ivsrealtime.GetPublicKeyOutput) + GetStage(*ivsrealtime.GetStageInput) (*ivsrealtime.GetStageOutput, error) GetStageWithContext(aws.Context, *ivsrealtime.GetStageInput, ...request.Option) (*ivsrealtime.GetStageOutput, error) GetStageRequest(*ivsrealtime.GetStageInput) (*request.Request, *ivsrealtime.GetStageOutput) @@ -116,6 +124,10 @@ type IVSRealTimeAPI interface { GetStorageConfigurationWithContext(aws.Context, *ivsrealtime.GetStorageConfigurationInput, ...request.Option) (*ivsrealtime.GetStorageConfigurationOutput, error) GetStorageConfigurationRequest(*ivsrealtime.GetStorageConfigurationInput) (*request.Request, *ivsrealtime.GetStorageConfigurationOutput) + ImportPublicKey(*ivsrealtime.ImportPublicKeyInput) (*ivsrealtime.ImportPublicKeyOutput, error) + ImportPublicKeyWithContext(aws.Context, *ivsrealtime.ImportPublicKeyInput, ...request.Option) (*ivsrealtime.ImportPublicKeyOutput, error) + ImportPublicKeyRequest(*ivsrealtime.ImportPublicKeyInput) (*request.Request, *ivsrealtime.ImportPublicKeyOutput) + ListCompositions(*ivsrealtime.ListCompositionsInput) (*ivsrealtime.ListCompositionsOutput, error) ListCompositionsWithContext(aws.Context, *ivsrealtime.ListCompositionsInput, ...request.Option) (*ivsrealtime.ListCompositionsOutput, error) ListCompositionsRequest(*ivsrealtime.ListCompositionsInput) (*request.Request, *ivsrealtime.ListCompositionsOutput) @@ -144,6 +156,13 @@ type IVSRealTimeAPI interface { ListParticipantsPages(*ivsrealtime.ListParticipantsInput, func(*ivsrealtime.ListParticipantsOutput, bool) bool) error ListParticipantsPagesWithContext(aws.Context, *ivsrealtime.ListParticipantsInput, func(*ivsrealtime.ListParticipantsOutput, bool) bool, ...request.Option) error + ListPublicKeys(*ivsrealtime.ListPublicKeysInput) (*ivsrealtime.ListPublicKeysOutput, error) + ListPublicKeysWithContext(aws.Context, *ivsrealtime.ListPublicKeysInput, ...request.Option) (*ivsrealtime.ListPublicKeysOutput, error) + ListPublicKeysRequest(*ivsrealtime.ListPublicKeysInput) (*request.Request, *ivsrealtime.ListPublicKeysOutput) + + ListPublicKeysPages(*ivsrealtime.ListPublicKeysInput, func(*ivsrealtime.ListPublicKeysOutput, bool) bool) error + ListPublicKeysPagesWithContext(aws.Context, *ivsrealtime.ListPublicKeysInput, func(*ivsrealtime.ListPublicKeysOutput, bool) bool, ...request.Option) error + ListStageSessions(*ivsrealtime.ListStageSessionsInput) (*ivsrealtime.ListStageSessionsOutput, error) ListStageSessionsWithContext(aws.Context, *ivsrealtime.ListStageSessionsInput, ...request.Option) (*ivsrealtime.ListStageSessionsOutput, error) ListStageSessionsRequest(*ivsrealtime.ListStageSessionsInput) (*request.Request, *ivsrealtime.ListStageSessionsOutput) diff --git a/service/kinesisanalyticsv2/api.go b/service/kinesisanalyticsv2/api.go index 98de739ed85..5d4f3c8459f 100644 --- a/service/kinesisanalyticsv2/api.go +++ b/service/kinesisanalyticsv2/api.go @@ -1690,6 +1690,93 @@ func (c *KinesisAnalyticsV2) DescribeApplicationWithContext(ctx aws.Context, inp return out, req.Send() } +const opDescribeApplicationOperation = "DescribeApplicationOperation" + +// DescribeApplicationOperationRequest generates a "aws/request.Request" representing the +// client's request for the DescribeApplicationOperation operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeApplicationOperation for more information on using the DescribeApplicationOperation +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the DescribeApplicationOperationRequest method. +// req, resp := client.DescribeApplicationOperationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DescribeApplicationOperation +func (c *KinesisAnalyticsV2) DescribeApplicationOperationRequest(input *DescribeApplicationOperationInput) (req *request.Request, output *DescribeApplicationOperationOutput) { + op := &request.Operation{ + Name: opDescribeApplicationOperation, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeApplicationOperationInput{} + } + + output = &DescribeApplicationOperationOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeApplicationOperation API operation for Amazon Kinesis Analytics. +// +// Returns information about a specific operation performed on a Managed Service +// for Apache Flink application +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Kinesis Analytics's +// API operation DescribeApplicationOperation for usage and error information. +// +// Returned Error Types: +// +// - InvalidArgumentException +// The specified input parameter value is not valid. +// +// - ResourceNotFoundException +// Specified application can't be found. +// +// - UnsupportedOperationException +// The request was rejected because a specified parameter is not supported or +// a specified resource is not valid for this operation. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/DescribeApplicationOperation +func (c *KinesisAnalyticsV2) DescribeApplicationOperation(input *DescribeApplicationOperationInput) (*DescribeApplicationOperationOutput, error) { + req, out := c.DescribeApplicationOperationRequest(input) + return out, req.Send() +} + +// DescribeApplicationOperationWithContext is the same as DescribeApplicationOperation with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeApplicationOperation for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *KinesisAnalyticsV2) DescribeApplicationOperationWithContext(ctx aws.Context, input *DescribeApplicationOperationInput, opts ...request.Option) (*DescribeApplicationOperationOutput, error) { + req, out := c.DescribeApplicationOperationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeApplicationSnapshot = "DescribeApplicationSnapshot" // DescribeApplicationSnapshotRequest generates a "aws/request.Request" representing the @@ -1974,6 +2061,150 @@ func (c *KinesisAnalyticsV2) DiscoverInputSchemaWithContext(ctx aws.Context, inp return out, req.Send() } +const opListApplicationOperations = "ListApplicationOperations" + +// ListApplicationOperationsRequest generates a "aws/request.Request" representing the +// client's request for the ListApplicationOperations operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListApplicationOperations for more information on using the ListApplicationOperations +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// // Example sending a request using the ListApplicationOperationsRequest method. +// req, resp := client.ListApplicationOperationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ListApplicationOperations +func (c *KinesisAnalyticsV2) ListApplicationOperationsRequest(input *ListApplicationOperationsInput) (req *request.Request, output *ListApplicationOperationsOutput) { + op := &request.Operation{ + Name: opListApplicationOperations, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "Limit", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListApplicationOperationsInput{} + } + + output = &ListApplicationOperationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListApplicationOperations API operation for Amazon Kinesis Analytics. +// +// Lists information about operations performed on a Managed Service for Apache +// Flink application +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Kinesis Analytics's +// API operation ListApplicationOperations for usage and error information. +// +// Returned Error Types: +// +// - InvalidArgumentException +// The specified input parameter value is not valid. +// +// - ResourceNotFoundException +// Specified application can't be found. +// +// - UnsupportedOperationException +// The request was rejected because a specified parameter is not supported or +// a specified resource is not valid for this operation. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kinesisanalyticsv2-2018-05-23/ListApplicationOperations +func (c *KinesisAnalyticsV2) ListApplicationOperations(input *ListApplicationOperationsInput) (*ListApplicationOperationsOutput, error) { + req, out := c.ListApplicationOperationsRequest(input) + return out, req.Send() +} + +// ListApplicationOperationsWithContext is the same as ListApplicationOperations with the addition of +// the ability to pass a context and additional request options. +// +// See ListApplicationOperations for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *KinesisAnalyticsV2) ListApplicationOperationsWithContext(ctx aws.Context, input *ListApplicationOperationsInput, opts ...request.Option) (*ListApplicationOperationsOutput, error) { + req, out := c.ListApplicationOperationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListApplicationOperationsPages iterates over the pages of a ListApplicationOperations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListApplicationOperations method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListApplicationOperations operation. +// pageNum := 0 +// err := client.ListApplicationOperationsPages(params, +// func(page *kinesisanalyticsv2.ListApplicationOperationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *KinesisAnalyticsV2) ListApplicationOperationsPages(input *ListApplicationOperationsInput, fn func(*ListApplicationOperationsOutput, bool) bool) error { + return c.ListApplicationOperationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListApplicationOperationsPagesWithContext same as ListApplicationOperationsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *KinesisAnalyticsV2) ListApplicationOperationsPagesWithContext(ctx aws.Context, input *ListApplicationOperationsInput, fn func(*ListApplicationOperationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListApplicationOperationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListApplicationOperationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListApplicationOperationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListApplicationSnapshots = "ListApplicationSnapshots" // ListApplicationSnapshotsRequest generates a "aws/request.Request" representing the @@ -2004,6 +2235,12 @@ func (c *KinesisAnalyticsV2) ListApplicationSnapshotsRequest(input *ListApplicat Name: opListApplicationSnapshots, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "Limit", + TruncationToken: "", + }, } if input == nil { @@ -2057,6 +2294,57 @@ func (c *KinesisAnalyticsV2) ListApplicationSnapshotsWithContext(ctx aws.Context return out, req.Send() } +// ListApplicationSnapshotsPages iterates over the pages of a ListApplicationSnapshots operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListApplicationSnapshots method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListApplicationSnapshots operation. +// pageNum := 0 +// err := client.ListApplicationSnapshotsPages(params, +// func(page *kinesisanalyticsv2.ListApplicationSnapshotsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *KinesisAnalyticsV2) ListApplicationSnapshotsPages(input *ListApplicationSnapshotsInput, fn func(*ListApplicationSnapshotsOutput, bool) bool) error { + return c.ListApplicationSnapshotsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListApplicationSnapshotsPagesWithContext same as ListApplicationSnapshotsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *KinesisAnalyticsV2) ListApplicationSnapshotsPagesWithContext(ctx aws.Context, input *ListApplicationSnapshotsInput, fn func(*ListApplicationSnapshotsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListApplicationSnapshotsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListApplicationSnapshotsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListApplicationSnapshotsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListApplicationVersions = "ListApplicationVersions" // ListApplicationVersionsRequest generates a "aws/request.Request" representing the @@ -2087,6 +2375,12 @@ func (c *KinesisAnalyticsV2) ListApplicationVersionsRequest(input *ListApplicati Name: opListApplicationVersions, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "Limit", + TruncationToken: "", + }, } if input == nil { @@ -2150,6 +2444,57 @@ func (c *KinesisAnalyticsV2) ListApplicationVersionsWithContext(ctx aws.Context, return out, req.Send() } +// ListApplicationVersionsPages iterates over the pages of a ListApplicationVersions operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListApplicationVersions method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListApplicationVersions operation. +// pageNum := 0 +// err := client.ListApplicationVersionsPages(params, +// func(page *kinesisanalyticsv2.ListApplicationVersionsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *KinesisAnalyticsV2) ListApplicationVersionsPages(input *ListApplicationVersionsInput, fn func(*ListApplicationVersionsOutput, bool) bool) error { + return c.ListApplicationVersionsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListApplicationVersionsPagesWithContext same as ListApplicationVersionsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *KinesisAnalyticsV2) ListApplicationVersionsPagesWithContext(ctx aws.Context, input *ListApplicationVersionsInput, fn func(*ListApplicationVersionsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListApplicationVersionsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListApplicationVersionsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListApplicationVersionsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListApplications = "ListApplications" // ListApplicationsRequest generates a "aws/request.Request" representing the @@ -2180,6 +2525,12 @@ func (c *KinesisAnalyticsV2) ListApplicationsRequest(input *ListApplicationsInpu Name: opListApplications, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "Limit", + TruncationToken: "", + }, } if input == nil { @@ -2232,6 +2583,57 @@ func (c *KinesisAnalyticsV2) ListApplicationsWithContext(ctx aws.Context, input return out, req.Send() } +// ListApplicationsPages iterates over the pages of a ListApplications operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListApplications method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListApplications operation. +// pageNum := 0 +// err := client.ListApplicationsPages(params, +// func(page *kinesisanalyticsv2.ListApplicationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *KinesisAnalyticsV2) ListApplicationsPages(input *ListApplicationsInput, fn func(*ListApplicationsOutput, bool) bool) error { + return c.ListApplicationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListApplicationsPagesWithContext same as ListApplicationsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *KinesisAnalyticsV2) ListApplicationsPagesWithContext(ctx aws.Context, input *ListApplicationsInput, fn func(*ListApplicationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListApplicationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListApplicationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListApplicationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListTagsForResource = "ListTagsForResource" // ListTagsForResourceRequest generates a "aws/request.Request" representing the @@ -2364,18 +2766,16 @@ func (c *KinesisAnalyticsV2) RollbackApplicationRequest(input *RollbackApplicati // RollbackApplication API operation for Amazon Kinesis Analytics. // // Reverts the application to the previous running version. You can roll back -// an application if you suspect it is stuck in a transient status. +// an application if you suspect it is stuck in a transient status or in the +// running status. // -// You can roll back an application only if it is in the UPDATING or AUTOSCALING -// status. +// You can roll back an application only if it is in the UPDATING, AUTOSCALING, +// or RUNNING statuses. // // When you rollback an application, it loads state data from the last successful // snapshot. If the application has no snapshots, Managed Service for Apache // Flink rejects the rollback request. // -// This action is not supported for Managed Service for Apache Flink for SQL -// applications. -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -2466,7 +2866,6 @@ func (c *KinesisAnalyticsV2) StartApplicationRequest(input *StartApplicationInpu output = &StartApplicationOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } @@ -2560,7 +2959,6 @@ func (c *KinesisAnalyticsV2) StopApplicationRequest(input *StopApplicationInput) output = &StopApplicationOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } @@ -3156,6 +3554,9 @@ type AddApplicationCloudWatchLoggingOptionOutput struct { // The descriptions of the current CloudWatch logging options for the SQL-based // Kinesis Data Analytics application. CloudWatchLoggingOptionDescriptions []*CloudWatchLoggingOptionDescription `type:"list"` + + // Operation ID for tracking AddApplicationCloudWatchLoggingOption request + OperationId *string `min:"1" type:"string"` } // String returns the string representation. @@ -3194,6 +3595,12 @@ func (s *AddApplicationCloudWatchLoggingOptionOutput) SetCloudWatchLoggingOption return s } +// SetOperationId sets the OperationId field's value. +func (s *AddApplicationCloudWatchLoggingOptionOutput) SetOperationId(v string) *AddApplicationCloudWatchLoggingOptionOutput { + s.OperationId = &v + return s +} + type AddApplicationInputInput struct { _ struct{} `type:"structure"` @@ -3895,6 +4302,9 @@ type AddApplicationVpcConfigurationOutput struct { // updates the ApplicationVersionId each time you update the application. ApplicationVersionId *int64 `min:"1" type:"long"` + // Operation ID for tracking AddApplicationVpcConfiguration request + OperationId *string `min:"1" type:"string"` + // The parameters of the new VPC configuration. VpcConfigurationDescription *VpcConfigurationDescription `type:"structure"` } @@ -3929,6 +4339,12 @@ func (s *AddApplicationVpcConfigurationOutput) SetApplicationVersionId(v int64) return s } +// SetOperationId sets the OperationId field's value. +func (s *AddApplicationVpcConfigurationOutput) SetOperationId(v string) *AddApplicationVpcConfigurationOutput { + s.OperationId = &v + return s +} + // SetVpcConfigurationDescription sets the VpcConfigurationDescription field's value. func (s *AddApplicationVpcConfigurationOutput) SetVpcConfigurationDescription(v *VpcConfigurationDescription) *AddApplicationVpcConfigurationOutput { s.VpcConfigurationDescription = v @@ -4110,6 +4526,10 @@ type ApplicationConfiguration struct { // Flink application. ApplicationSnapshotConfiguration *ApplicationSnapshotConfiguration `type:"structure"` + // Describes system rollback configuration for a Managed Service for Apache + // Flink application + ApplicationSystemRollbackConfiguration *ApplicationSystemRollbackConfiguration `type:"structure"` + // Describes execution properties for a Managed Service for Apache Flink application. EnvironmentProperties *EnvironmentProperties `type:"structure"` @@ -4160,6 +4580,11 @@ func (s *ApplicationConfiguration) Validate() error { invalidParams.AddNested("ApplicationSnapshotConfiguration", err.(request.ErrInvalidParams)) } } + if s.ApplicationSystemRollbackConfiguration != nil { + if err := s.ApplicationSystemRollbackConfiguration.Validate(); err != nil { + invalidParams.AddNested("ApplicationSystemRollbackConfiguration", err.(request.ErrInvalidParams)) + } + } if s.EnvironmentProperties != nil { if err := s.EnvironmentProperties.Validate(); err != nil { invalidParams.AddNested("EnvironmentProperties", err.(request.ErrInvalidParams)) @@ -4209,6 +4634,12 @@ func (s *ApplicationConfiguration) SetApplicationSnapshotConfiguration(v *Applic return s } +// SetApplicationSystemRollbackConfiguration sets the ApplicationSystemRollbackConfiguration field's value. +func (s *ApplicationConfiguration) SetApplicationSystemRollbackConfiguration(v *ApplicationSystemRollbackConfiguration) *ApplicationConfiguration { + s.ApplicationSystemRollbackConfiguration = v + return s +} + // SetEnvironmentProperties sets the EnvironmentProperties field's value. func (s *ApplicationConfiguration) SetEnvironmentProperties(v *EnvironmentProperties) *ApplicationConfiguration { s.EnvironmentProperties = v @@ -4252,6 +4683,10 @@ type ApplicationConfigurationDescription struct { // Flink application. ApplicationSnapshotConfigurationDescription *ApplicationSnapshotConfigurationDescription `type:"structure"` + // Describes system rollback configuration for a Managed Service for Apache + // Flink application + ApplicationSystemRollbackConfigurationDescription *ApplicationSystemRollbackConfigurationDescription `type:"structure"` + // Describes execution properties for a Managed Service for Apache Flink application. EnvironmentPropertyDescriptions *EnvironmentPropertyDescriptions `type:"structure"` @@ -4304,6 +4739,12 @@ func (s *ApplicationConfigurationDescription) SetApplicationSnapshotConfiguratio return s } +// SetApplicationSystemRollbackConfigurationDescription sets the ApplicationSystemRollbackConfigurationDescription field's value. +func (s *ApplicationConfigurationDescription) SetApplicationSystemRollbackConfigurationDescription(v *ApplicationSystemRollbackConfigurationDescription) *ApplicationConfigurationDescription { + s.ApplicationSystemRollbackConfigurationDescription = v + return s +} + // SetEnvironmentPropertyDescriptions sets the EnvironmentPropertyDescriptions field's value. func (s *ApplicationConfigurationDescription) SetEnvironmentPropertyDescriptions(v *EnvironmentPropertyDescriptions) *ApplicationConfigurationDescription { s.EnvironmentPropertyDescriptions = v @@ -4351,6 +4792,10 @@ type ApplicationConfigurationUpdate struct { // Flink application. ApplicationSnapshotConfigurationUpdate *ApplicationSnapshotConfigurationUpdate `type:"structure"` + // Describes system rollback configuration for a Managed Service for Apache + // Flink application + ApplicationSystemRollbackConfigurationUpdate *ApplicationSystemRollbackConfigurationUpdate `type:"structure"` + // Describes updates to the environment properties for a Managed Service for // Apache Flink application. EnvironmentPropertyUpdates *EnvironmentPropertyUpdates `type:"structure"` @@ -4401,6 +4846,11 @@ func (s *ApplicationConfigurationUpdate) Validate() error { invalidParams.AddNested("ApplicationSnapshotConfigurationUpdate", err.(request.ErrInvalidParams)) } } + if s.ApplicationSystemRollbackConfigurationUpdate != nil { + if err := s.ApplicationSystemRollbackConfigurationUpdate.Validate(); err != nil { + invalidParams.AddNested("ApplicationSystemRollbackConfigurationUpdate", err.(request.ErrInvalidParams)) + } + } if s.EnvironmentPropertyUpdates != nil { if err := s.EnvironmentPropertyUpdates.Validate(); err != nil { invalidParams.AddNested("EnvironmentPropertyUpdates", err.(request.ErrInvalidParams)) @@ -4450,6 +4900,12 @@ func (s *ApplicationConfigurationUpdate) SetApplicationSnapshotConfigurationUpda return s } +// SetApplicationSystemRollbackConfigurationUpdate sets the ApplicationSystemRollbackConfigurationUpdate field's value. +func (s *ApplicationConfigurationUpdate) SetApplicationSystemRollbackConfigurationUpdate(v *ApplicationSystemRollbackConfigurationUpdate) *ApplicationConfigurationUpdate { + s.ApplicationSystemRollbackConfigurationUpdate = v + return s +} + // SetEnvironmentPropertyUpdates sets the EnvironmentPropertyUpdates field's value. func (s *ApplicationConfigurationUpdate) SetEnvironmentPropertyUpdates(v *EnvironmentPropertyUpdates) *ApplicationConfigurationUpdate { s.EnvironmentPropertyUpdates = v @@ -4515,6 +4971,9 @@ type ApplicationDetail struct { // ApplicationStatus is a required field ApplicationStatus *string `type:"string" required:"true" enum:"ApplicationStatus"` + // The current timestamp when the application version was created. + ApplicationVersionCreateTimestamp *time.Time `type:"timestamp"` + // Provides the current application version. Managed Service for Apache Flink // updates the ApplicationVersionId each time you update the application. // @@ -4613,6 +5072,12 @@ func (s *ApplicationDetail) SetApplicationStatus(v string) *ApplicationDetail { return s } +// SetApplicationVersionCreateTimestamp sets the ApplicationVersionCreateTimestamp field's value. +func (s *ApplicationDetail) SetApplicationVersionCreateTimestamp(v time.Time) *ApplicationDetail { + s.ApplicationVersionCreateTimestamp = &v + return s +} + // SetApplicationVersionId sets the ApplicationVersionId field's value. func (s *ApplicationDetail) SetApplicationVersionId(v int64) *ApplicationDetail { s.ApplicationVersionId = &v @@ -4768,6 +5233,159 @@ func (s *ApplicationMaintenanceConfigurationUpdate) SetApplicationMaintenanceWin return s } +// Provides a description of the operation, such as the type and status of operation +type ApplicationOperationInfo struct { + _ struct{} `type:"structure"` + + // The timestamp at which the operation finished for the application + EndTime *time.Time `type:"timestamp"` + + // Type of operation performed on an application + Operation *string `min:"1" type:"string"` + + // Identifier of the Operation + OperationId *string `min:"1" type:"string"` + + // Status of the operation performed on an application + OperationStatus *string `type:"string" enum:"OperationStatus"` + + // The timestamp at which the operation was created + StartTime *time.Time `type:"timestamp"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationOperationInfo) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationOperationInfo) GoString() string { + return s.String() +} + +// SetEndTime sets the EndTime field's value. +func (s *ApplicationOperationInfo) SetEndTime(v time.Time) *ApplicationOperationInfo { + s.EndTime = &v + return s +} + +// SetOperation sets the Operation field's value. +func (s *ApplicationOperationInfo) SetOperation(v string) *ApplicationOperationInfo { + s.Operation = &v + return s +} + +// SetOperationId sets the OperationId field's value. +func (s *ApplicationOperationInfo) SetOperationId(v string) *ApplicationOperationInfo { + s.OperationId = &v + return s +} + +// SetOperationStatus sets the OperationStatus field's value. +func (s *ApplicationOperationInfo) SetOperationStatus(v string) *ApplicationOperationInfo { + s.OperationStatus = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *ApplicationOperationInfo) SetStartTime(v time.Time) *ApplicationOperationInfo { + s.StartTime = &v + return s +} + +// Provides a description of the operation, such as the operation-type and status +type ApplicationOperationInfoDetails struct { + _ struct{} `type:"structure"` + + // Contains information about the application version changes due to an operation + ApplicationVersionChangeDetails *ApplicationVersionChangeDetails `type:"structure"` + + // The timestamp at which the operation finished for the application + // + // EndTime is a required field + EndTime *time.Time `type:"timestamp" required:"true"` + + // Type of operation performed on an application + // + // Operation is a required field + Operation *string `min:"1" type:"string" required:"true"` + + // Provides a description of the operation failure + OperationFailureDetails *OperationFailureDetails `type:"structure"` + + // Status of the operation performed on an application + // + // OperationStatus is a required field + OperationStatus *string `type:"string" required:"true" enum:"OperationStatus"` + + // The timestamp at which the operation was created + // + // StartTime is a required field + StartTime *time.Time `type:"timestamp" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationOperationInfoDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationOperationInfoDetails) GoString() string { + return s.String() +} + +// SetApplicationVersionChangeDetails sets the ApplicationVersionChangeDetails field's value. +func (s *ApplicationOperationInfoDetails) SetApplicationVersionChangeDetails(v *ApplicationVersionChangeDetails) *ApplicationOperationInfoDetails { + s.ApplicationVersionChangeDetails = v + return s +} + +// SetEndTime sets the EndTime field's value. +func (s *ApplicationOperationInfoDetails) SetEndTime(v time.Time) *ApplicationOperationInfoDetails { + s.EndTime = &v + return s +} + +// SetOperation sets the Operation field's value. +func (s *ApplicationOperationInfoDetails) SetOperation(v string) *ApplicationOperationInfoDetails { + s.Operation = &v + return s +} + +// SetOperationFailureDetails sets the OperationFailureDetails field's value. +func (s *ApplicationOperationInfoDetails) SetOperationFailureDetails(v *OperationFailureDetails) *ApplicationOperationInfoDetails { + s.OperationFailureDetails = v + return s +} + +// SetOperationStatus sets the OperationStatus field's value. +func (s *ApplicationOperationInfoDetails) SetOperationStatus(v string) *ApplicationOperationInfoDetails { + s.OperationStatus = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *ApplicationOperationInfoDetails) SetStartTime(v time.Time) *ApplicationOperationInfoDetails { + s.StartTime = &v + return s +} + // Specifies the method and snapshot to use when restarting an application using // previously saved application state. type ApplicationRestoreConfiguration struct { @@ -5052,6 +5670,186 @@ func (s *ApplicationSummary) SetRuntimeEnvironment(v string) *ApplicationSummary return s } +// Describes system rollback configuration for a Managed Service for Apache +// Flink application +type ApplicationSystemRollbackConfiguration struct { + _ struct{} `type:"structure"` + + // Describes whether system rollbacks are enabled for a Managed Service for + // Apache Flink application + // + // RollbackEnabled is a required field + RollbackEnabled *bool `type:"boolean" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationSystemRollbackConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationSystemRollbackConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ApplicationSystemRollbackConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ApplicationSystemRollbackConfiguration"} + if s.RollbackEnabled == nil { + invalidParams.Add(request.NewErrParamRequired("RollbackEnabled")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetRollbackEnabled sets the RollbackEnabled field's value. +func (s *ApplicationSystemRollbackConfiguration) SetRollbackEnabled(v bool) *ApplicationSystemRollbackConfiguration { + s.RollbackEnabled = &v + return s +} + +// Describes system rollback configuration for a Managed Service for Apache +// Flink application +type ApplicationSystemRollbackConfigurationDescription struct { + _ struct{} `type:"structure"` + + // Describes whether system rollbacks are enabled for a Managed Service for + // Apache Flink application + // + // RollbackEnabled is a required field + RollbackEnabled *bool `type:"boolean" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationSystemRollbackConfigurationDescription) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationSystemRollbackConfigurationDescription) GoString() string { + return s.String() +} + +// SetRollbackEnabled sets the RollbackEnabled field's value. +func (s *ApplicationSystemRollbackConfigurationDescription) SetRollbackEnabled(v bool) *ApplicationSystemRollbackConfigurationDescription { + s.RollbackEnabled = &v + return s +} + +// Describes system rollback configuration for a Managed Service for Apache +// Flink application +type ApplicationSystemRollbackConfigurationUpdate struct { + _ struct{} `type:"structure"` + + // Describes whether system rollbacks are enabled for a Managed Service for + // Apache Flink application + // + // RollbackEnabledUpdate is a required field + RollbackEnabledUpdate *bool `type:"boolean" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationSystemRollbackConfigurationUpdate) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationSystemRollbackConfigurationUpdate) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ApplicationSystemRollbackConfigurationUpdate) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ApplicationSystemRollbackConfigurationUpdate"} + if s.RollbackEnabledUpdate == nil { + invalidParams.Add(request.NewErrParamRequired("RollbackEnabledUpdate")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetRollbackEnabledUpdate sets the RollbackEnabledUpdate field's value. +func (s *ApplicationSystemRollbackConfigurationUpdate) SetRollbackEnabledUpdate(v bool) *ApplicationSystemRollbackConfigurationUpdate { + s.RollbackEnabledUpdate = &v + return s +} + +// Contains information about the application version changes due to an operation +type ApplicationVersionChangeDetails struct { + _ struct{} `type:"structure"` + + // The operation was performed on this version of the application + // + // ApplicationVersionUpdatedFrom is a required field + ApplicationVersionUpdatedFrom *int64 `min:"1" type:"long" required:"true"` + + // The operation execution resulted in the transition to the following version + // of the application + // + // ApplicationVersionUpdatedTo is a required field + ApplicationVersionUpdatedTo *int64 `min:"1" type:"long" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationVersionChangeDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ApplicationVersionChangeDetails) GoString() string { + return s.String() +} + +// SetApplicationVersionUpdatedFrom sets the ApplicationVersionUpdatedFrom field's value. +func (s *ApplicationVersionChangeDetails) SetApplicationVersionUpdatedFrom(v int64) *ApplicationVersionChangeDetails { + s.ApplicationVersionUpdatedFrom = &v + return s +} + +// SetApplicationVersionUpdatedTo sets the ApplicationVersionUpdatedTo field's value. +func (s *ApplicationVersionChangeDetails) SetApplicationVersionUpdatedTo(v int64) *ApplicationVersionChangeDetails { + s.ApplicationVersionUpdatedTo = &v + return s +} + // The summary of the application version. type ApplicationVersionSummary struct { _ struct{} `type:"structure"` @@ -6746,6 +7544,9 @@ type DeleteApplicationCloudWatchLoggingOptionOutput struct { // The descriptions of the remaining CloudWatch logging options for the application. CloudWatchLoggingOptionDescriptions []*CloudWatchLoggingOptionDescription `type:"list"` + + // Operation ID for tracking DeleteApplicationCloudWatchLoggingOption request + OperationId *string `min:"1" type:"string"` } // String returns the string representation. @@ -6784,6 +7585,12 @@ func (s *DeleteApplicationCloudWatchLoggingOptionOutput) SetCloudWatchLoggingOpt return s } +// SetOperationId sets the OperationId field's value. +func (s *DeleteApplicationCloudWatchLoggingOptionOutput) SetOperationId(v string) *DeleteApplicationCloudWatchLoggingOptionOutput { + s.OperationId = &v + return s +} + type DeleteApplicationInput struct { _ struct{} `type:"structure"` @@ -7462,6 +8269,9 @@ type DeleteApplicationVpcConfigurationOutput struct { // The updated version ID of the application. ApplicationVersionId *int64 `min:"1" type:"long"` + + // Operation ID for tracking DeleteApplicationVpcConfiguration request + OperationId *string `min:"1" type:"string"` } // String returns the string representation. @@ -7494,6 +8304,12 @@ func (s *DeleteApplicationVpcConfigurationOutput) SetApplicationVersionId(v int6 return s } +// SetOperationId sets the OperationId field's value. +func (s *DeleteApplicationVpcConfigurationOutput) SetOperationId(v string) *DeleteApplicationVpcConfigurationOutput { + s.OperationId = &v + return s +} + // The information required to deploy a Managed Service for Apache Flink Studio // notebook as an application with durable state. type DeployAsApplicationConfiguration struct { @@ -7694,6 +8510,107 @@ func (s *DescribeApplicationInput) SetIncludeAdditionalDetails(v bool) *Describe return s } +// Request for information about a specific operation performed on a Managed +// Service for Apache Flink application +type DescribeApplicationOperationInput struct { + _ struct{} `type:"structure"` + + // The name of the application + // + // ApplicationName is a required field + ApplicationName *string `min:"1" type:"string" required:"true"` + + // Identifier of the Operation + // + // OperationId is a required field + OperationId *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeApplicationOperationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeApplicationOperationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeApplicationOperationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeApplicationOperationInput"} + if s.ApplicationName == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationName")) + } + if s.ApplicationName != nil && len(*s.ApplicationName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationName", 1)) + } + if s.OperationId == nil { + invalidParams.Add(request.NewErrParamRequired("OperationId")) + } + if s.OperationId != nil && len(*s.OperationId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("OperationId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationName sets the ApplicationName field's value. +func (s *DescribeApplicationOperationInput) SetApplicationName(v string) *DescribeApplicationOperationInput { + s.ApplicationName = &v + return s +} + +// SetOperationId sets the OperationId field's value. +func (s *DescribeApplicationOperationInput) SetOperationId(v string) *DescribeApplicationOperationInput { + s.OperationId = &v + return s +} + +// Provides details of the operation corresponding to the operation-ID on a +// Managed Service for Apache Flink application +type DescribeApplicationOperationOutput struct { + _ struct{} `type:"structure"` + + // Provides a description of the operation, such as the operation-type and status + ApplicationOperationInfoDetails *ApplicationOperationInfoDetails `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeApplicationOperationOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeApplicationOperationOutput) GoString() string { + return s.String() +} + +// SetApplicationOperationInfoDetails sets the ApplicationOperationInfoDetails field's value. +func (s *DescribeApplicationOperationOutput) SetApplicationOperationInfoDetails(v *ApplicationOperationInfoDetails) *DescribeApplicationOperationOutput { + s.ApplicationOperationInfoDetails = v + return s +} + type DescribeApplicationOutput struct { _ struct{} `type:"structure"` @@ -8282,6 +9199,38 @@ func (s *EnvironmentPropertyUpdates) SetPropertyGroups(v []*PropertyGroup) *Envi return s } +// Provides a description of the operation failure error +type ErrorInfo struct { + _ struct{} `type:"structure"` + + // Error message resulting in failure of the operation + ErrorString *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ErrorInfo) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ErrorInfo) GoString() string { + return s.String() +} + +// SetErrorString sets the ErrorString field's value. +func (s *ErrorInfo) SetErrorString(v string) *ErrorInfo { + s.ErrorString = &v + return s +} + // Describes configuration parameters for a Managed Service for Apache Flink // application or a Studio notebook. type FlinkApplicationConfiguration struct { @@ -10688,6 +11637,144 @@ func (s *LimitExceededException) RequestID() string { return s.RespMetadata.RequestID } +// Request to list operations performed on an application +type ListApplicationOperationsInput struct { + _ struct{} `type:"structure"` + + // The name of the application + // + // ApplicationName is a required field + ApplicationName *string `min:"1" type:"string" required:"true"` + + // Limit on the number of records returned in the response + Limit *int64 `min:"1" type:"integer"` + + // If a previous command returned a pagination token, pass it into this value + // to retrieve the next set of results + NextToken *string `min:"1" type:"string"` + + // Type of operation performed on an application + Operation *string `min:"1" type:"string"` + + // Status of the operation performed on an application + OperationStatus *string `type:"string" enum:"OperationStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationOperationsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationOperationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListApplicationOperationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListApplicationOperationsInput"} + if s.ApplicationName == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationName")) + } + if s.ApplicationName != nil && len(*s.ApplicationName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ApplicationName", 1)) + } + if s.Limit != nil && *s.Limit < 1 { + invalidParams.Add(request.NewErrParamMinValue("Limit", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.Operation != nil && len(*s.Operation) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Operation", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationName sets the ApplicationName field's value. +func (s *ListApplicationOperationsInput) SetApplicationName(v string) *ListApplicationOperationsInput { + s.ApplicationName = &v + return s +} + +// SetLimit sets the Limit field's value. +func (s *ListApplicationOperationsInput) SetLimit(v int64) *ListApplicationOperationsInput { + s.Limit = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListApplicationOperationsInput) SetNextToken(v string) *ListApplicationOperationsInput { + s.NextToken = &v + return s +} + +// SetOperation sets the Operation field's value. +func (s *ListApplicationOperationsInput) SetOperation(v string) *ListApplicationOperationsInput { + s.Operation = &v + return s +} + +// SetOperationStatus sets the OperationStatus field's value. +func (s *ListApplicationOperationsInput) SetOperationStatus(v string) *ListApplicationOperationsInput { + s.OperationStatus = &v + return s +} + +// Response with the list of operations for an application +type ListApplicationOperationsOutput struct { + _ struct{} `type:"structure"` + + // List of ApplicationOperationInfo for an application + ApplicationOperationInfoList []*ApplicationOperationInfo `type:"list"` + + // If a previous command returned a pagination token, pass it into this value + // to retrieve the next set of results + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationOperationsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListApplicationOperationsOutput) GoString() string { + return s.String() +} + +// SetApplicationOperationInfoList sets the ApplicationOperationInfoList field's value. +func (s *ListApplicationOperationsOutput) SetApplicationOperationInfoList(v []*ApplicationOperationInfo) *ListApplicationOperationsOutput { + s.ApplicationOperationInfoList = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListApplicationOperationsOutput) SetNextToken(v string) *ListApplicationOperationsOutput { + s.NextToken = &v + return s +} + type ListApplicationSnapshotsInput struct { _ struct{} `type:"structure"` @@ -11438,6 +12525,48 @@ func (s *MonitoringConfigurationUpdate) SetMetricsLevelUpdate(v string) *Monitor return s } +// Provides a description of the operation failure +type OperationFailureDetails struct { + _ struct{} `type:"structure"` + + // Provides a description of the operation failure error + ErrorInfo *ErrorInfo `type:"structure"` + + // Provides the operation ID of a system-rollback operation executed due to + // failure in the current operation + RollbackOperationId *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OperationFailureDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OperationFailureDetails) GoString() string { + return s.String() +} + +// SetErrorInfo sets the ErrorInfo field's value. +func (s *OperationFailureDetails) SetErrorInfo(v *ErrorInfo) *OperationFailureDetails { + s.ErrorInfo = v + return s +} + +// SetRollbackOperationId sets the RollbackOperationId field's value. +func (s *OperationFailureDetails) SetRollbackOperationId(v string) *OperationFailureDetails { + s.RollbackOperationId = &v + return s +} + // Describes a SQL-based Kinesis Data Analytics application's output configuration, // in which you identify an in-application stream and a destination where you // want the in-application stream data to be written. The destination can be @@ -12777,6 +13906,9 @@ type RollbackApplicationOutput struct { // // ApplicationDetail is a required field ApplicationDetail *ApplicationDetail `type:"structure" required:"true"` + + // Operation ID for tracking RollbackApplication request + OperationId *string `min:"1" type:"string"` } // String returns the string representation. @@ -12803,6 +13935,12 @@ func (s *RollbackApplicationOutput) SetApplicationDetail(v *ApplicationDetail) * return s } +// SetOperationId sets the OperationId field's value. +func (s *RollbackApplicationOutput) SetOperationId(v string) *RollbackApplicationOutput { + s.OperationId = &v + return s +} + // Describes the starting parameters for an Managed Service for Apache Flink // application. type RunConfiguration struct { @@ -14202,6 +15340,9 @@ func (s *StartApplicationInput) SetRunConfiguration(v *RunConfiguration) *StartA type StartApplicationOutput struct { _ struct{} `type:"structure"` + + // Operation ID for tracking StartApplication request + OperationId *string `min:"1" type:"string"` } // String returns the string representation. @@ -14222,6 +15363,12 @@ func (s StartApplicationOutput) GoString() string { return s.String() } +// SetOperationId sets the OperationId field's value. +func (s *StartApplicationOutput) SetOperationId(v string) *StartApplicationOutput { + s.OperationId = &v + return s +} + type StopApplicationInput struct { _ struct{} `type:"structure"` @@ -14293,6 +15440,9 @@ func (s *StopApplicationInput) SetForce(v bool) *StopApplicationInput { type StopApplicationOutput struct { _ struct{} `type:"structure"` + + // Operation ID for tracking StopApplication request + OperationId *string `min:"1" type:"string"` } // String returns the string representation. @@ -14313,6 +15463,12 @@ func (s StopApplicationOutput) GoString() string { return s.String() } +// SetOperationId sets the OperationId field's value. +func (s *StopApplicationOutput) SetOperationId(v string) *StopApplicationOutput { + s.OperationId = &v + return s +} + // A key-value pair (the value is optional) that you can define and assign to // Amazon resources. If you specify a tag that already exists, the tag value // is replaced with the value that you specify in the request. Note that the @@ -15040,6 +16196,9 @@ type UpdateApplicationOutput struct { // // ApplicationDetail is a required field ApplicationDetail *ApplicationDetail `type:"structure" required:"true"` + + // Operation ID for tracking UpdateApplication request + OperationId *string `min:"1" type:"string"` } // String returns the string representation. @@ -15066,6 +16225,12 @@ func (s *UpdateApplicationOutput) SetApplicationDetail(v *ApplicationDetail) *Up return s } +// SetOperationId sets the OperationId field's value. +func (s *UpdateApplicationOutput) SetOperationId(v string) *UpdateApplicationOutput { + s.OperationId = &v + return s +} + // Describes the parameters of a VPC used by the application. type VpcConfiguration struct { _ struct{} `type:"structure"` @@ -15874,6 +17039,31 @@ func MetricsLevel_Values() []string { } } +// Status of the operation performed on an application +const ( + // OperationStatusInProgress is a OperationStatus enum value + OperationStatusInProgress = "IN_PROGRESS" + + // OperationStatusCancelled is a OperationStatus enum value + OperationStatusCancelled = "CANCELLED" + + // OperationStatusSuccessful is a OperationStatus enum value + OperationStatusSuccessful = "SUCCESSFUL" + + // OperationStatusFailed is a OperationStatus enum value + OperationStatusFailed = "FAILED" +) + +// OperationStatus_Values returns all elements of the OperationStatus enum +func OperationStatus_Values() []string { + return []string{ + OperationStatusInProgress, + OperationStatusCancelled, + OperationStatusSuccessful, + OperationStatusFailed, + } +} + const ( // RecordFormatTypeJson is a RecordFormatType enum value RecordFormatTypeJson = "JSON" diff --git a/service/kinesisanalyticsv2/kinesisanalyticsv2iface/interface.go b/service/kinesisanalyticsv2/kinesisanalyticsv2iface/interface.go index 0bf0fa75ae4..2b354a8591a 100644 --- a/service/kinesisanalyticsv2/kinesisanalyticsv2iface/interface.go +++ b/service/kinesisanalyticsv2/kinesisanalyticsv2iface/interface.go @@ -128,6 +128,10 @@ type KinesisAnalyticsV2API interface { DescribeApplicationWithContext(aws.Context, *kinesisanalyticsv2.DescribeApplicationInput, ...request.Option) (*kinesisanalyticsv2.DescribeApplicationOutput, error) DescribeApplicationRequest(*kinesisanalyticsv2.DescribeApplicationInput) (*request.Request, *kinesisanalyticsv2.DescribeApplicationOutput) + DescribeApplicationOperation(*kinesisanalyticsv2.DescribeApplicationOperationInput) (*kinesisanalyticsv2.DescribeApplicationOperationOutput, error) + DescribeApplicationOperationWithContext(aws.Context, *kinesisanalyticsv2.DescribeApplicationOperationInput, ...request.Option) (*kinesisanalyticsv2.DescribeApplicationOperationOutput, error) + DescribeApplicationOperationRequest(*kinesisanalyticsv2.DescribeApplicationOperationInput) (*request.Request, *kinesisanalyticsv2.DescribeApplicationOperationOutput) + DescribeApplicationSnapshot(*kinesisanalyticsv2.DescribeApplicationSnapshotInput) (*kinesisanalyticsv2.DescribeApplicationSnapshotOutput, error) DescribeApplicationSnapshotWithContext(aws.Context, *kinesisanalyticsv2.DescribeApplicationSnapshotInput, ...request.Option) (*kinesisanalyticsv2.DescribeApplicationSnapshotOutput, error) DescribeApplicationSnapshotRequest(*kinesisanalyticsv2.DescribeApplicationSnapshotInput) (*request.Request, *kinesisanalyticsv2.DescribeApplicationSnapshotOutput) @@ -140,18 +144,34 @@ type KinesisAnalyticsV2API interface { DiscoverInputSchemaWithContext(aws.Context, *kinesisanalyticsv2.DiscoverInputSchemaInput, ...request.Option) (*kinesisanalyticsv2.DiscoverInputSchemaOutput, error) DiscoverInputSchemaRequest(*kinesisanalyticsv2.DiscoverInputSchemaInput) (*request.Request, *kinesisanalyticsv2.DiscoverInputSchemaOutput) + ListApplicationOperations(*kinesisanalyticsv2.ListApplicationOperationsInput) (*kinesisanalyticsv2.ListApplicationOperationsOutput, error) + ListApplicationOperationsWithContext(aws.Context, *kinesisanalyticsv2.ListApplicationOperationsInput, ...request.Option) (*kinesisanalyticsv2.ListApplicationOperationsOutput, error) + ListApplicationOperationsRequest(*kinesisanalyticsv2.ListApplicationOperationsInput) (*request.Request, *kinesisanalyticsv2.ListApplicationOperationsOutput) + + ListApplicationOperationsPages(*kinesisanalyticsv2.ListApplicationOperationsInput, func(*kinesisanalyticsv2.ListApplicationOperationsOutput, bool) bool) error + ListApplicationOperationsPagesWithContext(aws.Context, *kinesisanalyticsv2.ListApplicationOperationsInput, func(*kinesisanalyticsv2.ListApplicationOperationsOutput, bool) bool, ...request.Option) error + ListApplicationSnapshots(*kinesisanalyticsv2.ListApplicationSnapshotsInput) (*kinesisanalyticsv2.ListApplicationSnapshotsOutput, error) ListApplicationSnapshotsWithContext(aws.Context, *kinesisanalyticsv2.ListApplicationSnapshotsInput, ...request.Option) (*kinesisanalyticsv2.ListApplicationSnapshotsOutput, error) ListApplicationSnapshotsRequest(*kinesisanalyticsv2.ListApplicationSnapshotsInput) (*request.Request, *kinesisanalyticsv2.ListApplicationSnapshotsOutput) + ListApplicationSnapshotsPages(*kinesisanalyticsv2.ListApplicationSnapshotsInput, func(*kinesisanalyticsv2.ListApplicationSnapshotsOutput, bool) bool) error + ListApplicationSnapshotsPagesWithContext(aws.Context, *kinesisanalyticsv2.ListApplicationSnapshotsInput, func(*kinesisanalyticsv2.ListApplicationSnapshotsOutput, bool) bool, ...request.Option) error + ListApplicationVersions(*kinesisanalyticsv2.ListApplicationVersionsInput) (*kinesisanalyticsv2.ListApplicationVersionsOutput, error) ListApplicationVersionsWithContext(aws.Context, *kinesisanalyticsv2.ListApplicationVersionsInput, ...request.Option) (*kinesisanalyticsv2.ListApplicationVersionsOutput, error) ListApplicationVersionsRequest(*kinesisanalyticsv2.ListApplicationVersionsInput) (*request.Request, *kinesisanalyticsv2.ListApplicationVersionsOutput) + ListApplicationVersionsPages(*kinesisanalyticsv2.ListApplicationVersionsInput, func(*kinesisanalyticsv2.ListApplicationVersionsOutput, bool) bool) error + ListApplicationVersionsPagesWithContext(aws.Context, *kinesisanalyticsv2.ListApplicationVersionsInput, func(*kinesisanalyticsv2.ListApplicationVersionsOutput, bool) bool, ...request.Option) error + ListApplications(*kinesisanalyticsv2.ListApplicationsInput) (*kinesisanalyticsv2.ListApplicationsOutput, error) ListApplicationsWithContext(aws.Context, *kinesisanalyticsv2.ListApplicationsInput, ...request.Option) (*kinesisanalyticsv2.ListApplicationsOutput, error) ListApplicationsRequest(*kinesisanalyticsv2.ListApplicationsInput) (*request.Request, *kinesisanalyticsv2.ListApplicationsOutput) + ListApplicationsPages(*kinesisanalyticsv2.ListApplicationsInput, func(*kinesisanalyticsv2.ListApplicationsOutput, bool) bool) error + ListApplicationsPagesWithContext(aws.Context, *kinesisanalyticsv2.ListApplicationsInput, func(*kinesisanalyticsv2.ListApplicationsOutput, bool) bool, ...request.Option) error + ListTagsForResource(*kinesisanalyticsv2.ListTagsForResourceInput) (*kinesisanalyticsv2.ListTagsForResourceOutput, error) ListTagsForResourceWithContext(aws.Context, *kinesisanalyticsv2.ListTagsForResourceInput, ...request.Option) (*kinesisanalyticsv2.ListTagsForResourceOutput, error) ListTagsForResourceRequest(*kinesisanalyticsv2.ListTagsForResourceInput) (*request.Request, *kinesisanalyticsv2.ListTagsForResourceOutput) diff --git a/service/opensearchservice/api.go b/service/opensearchservice/api.go index 6d1f518410c..1ef7db0895c 100644 --- a/service/opensearchservice/api.go +++ b/service/opensearchservice/api.go @@ -6653,6 +6653,114 @@ func (c *OpenSearchService) UpgradeDomainWithContext(ctx aws.Context, input *Upg return out, req.Send() } +// Container for parameters required to enable all machine learning features. +type AIMLOptionsInput_ struct { + _ struct{} `type:"structure"` + + // Container for parameters required for natural language query generation on + // the specified domain. + NaturalLanguageQueryGenerationOptions *NaturalLanguageQueryGenerationOptionsInput_ `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AIMLOptionsInput_) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AIMLOptionsInput_) GoString() string { + return s.String() +} + +// SetNaturalLanguageQueryGenerationOptions sets the NaturalLanguageQueryGenerationOptions field's value. +func (s *AIMLOptionsInput_) SetNaturalLanguageQueryGenerationOptions(v *NaturalLanguageQueryGenerationOptionsInput_) *AIMLOptionsInput_ { + s.NaturalLanguageQueryGenerationOptions = v + return s +} + +// Container for parameters representing the state of machine learning features +// on the specified domain. +type AIMLOptionsOutput_ struct { + _ struct{} `type:"structure"` + + // Container for parameters required for natural language query generation on + // the specified domain. + NaturalLanguageQueryGenerationOptions *NaturalLanguageQueryGenerationOptionsOutput_ `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AIMLOptionsOutput_) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AIMLOptionsOutput_) GoString() string { + return s.String() +} + +// SetNaturalLanguageQueryGenerationOptions sets the NaturalLanguageQueryGenerationOptions field's value. +func (s *AIMLOptionsOutput_) SetNaturalLanguageQueryGenerationOptions(v *NaturalLanguageQueryGenerationOptionsOutput_) *AIMLOptionsOutput_ { + s.NaturalLanguageQueryGenerationOptions = v + return s +} + +// The status of machine learning options on the specified domain. +type AIMLOptionsStatus struct { + _ struct{} `type:"structure"` + + // Machine learning options on the specified domain. + Options *AIMLOptionsOutput_ `type:"structure"` + + // Provides the current status of an entity. + Status *OptionStatus `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AIMLOptionsStatus) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AIMLOptionsStatus) GoString() string { + return s.String() +} + +// SetOptions sets the Options field's value. +func (s *AIMLOptionsStatus) SetOptions(v *AIMLOptionsOutput_) *AIMLOptionsStatus { + s.Options = v + return s +} + +// SetStatus sets the Status field's value. +func (s *AIMLOptionsStatus) SetStatus(v *OptionStatus) *AIMLOptionsStatus { + s.Status = v + return s +} + // Information about an Amazon OpenSearch Service domain. type AWSDomainInformation struct { _ struct{} `type:"structure"` @@ -9404,6 +9512,9 @@ func (s *ConnectionProperties) SetEndpoint(v string) *ConnectionProperties { type CreateDomainInput struct { _ struct{} `type:"structure"` + // Options for all machine learning features for the specified domain. + AIMLOptions *AIMLOptionsInput_ `type:"structure"` + // Identity and Access Management (IAM) policy document specifying the access // policies for the new domain. AccessPolicies *string `type:"string"` @@ -9599,6 +9710,12 @@ func (s *CreateDomainInput) Validate() error { return nil } +// SetAIMLOptions sets the AIMLOptions field's value. +func (s *CreateDomainInput) SetAIMLOptions(v *AIMLOptionsInput_) *CreateDomainInput { + s.AIMLOptions = v + return s +} + // SetAccessPolicies sets the AccessPolicies field's value. func (s *CreateDomainInput) SetAccessPolicies(v string) *CreateDomainInput { s.AccessPolicies = &v @@ -12775,6 +12892,9 @@ func (s *DissociatePackageOutput) SetDomainPackageDetails(v *DomainPackageDetail type DomainConfig struct { _ struct{} `type:"structure"` + // Container for parameters required to enable all machine learning features. + AIMLOptions *AIMLOptionsStatus `type:"structure"` + // Specifies the access policies for the domain. AccessPolicies *AccessPoliciesStatus `type:"structure"` @@ -12859,6 +12979,12 @@ func (s DomainConfig) GoString() string { return s.String() } +// SetAIMLOptions sets the AIMLOptions field's value. +func (s *DomainConfig) SetAIMLOptions(v *AIMLOptionsStatus) *DomainConfig { + s.AIMLOptions = v + return s +} + // SetAccessPolicies sets the AccessPolicies field's value. func (s *DomainConfig) SetAccessPolicies(v *AccessPoliciesStatus) *DomainConfig { s.AccessPolicies = v @@ -13503,6 +13629,9 @@ func (s *DomainPackageDetails) SetReferencePath(v string) *DomainPackageDetails type DomainStatus struct { _ struct{} `type:"structure"` + // Container for parameters required to enable all machine learning features. + AIMLOptions *AIMLOptionsOutput_ `type:"structure"` + // The Amazon Resource Name (ARN) of the domain. For more information, see IAM // identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) // in the AWS Identity and Access Management User Guide. @@ -13650,6 +13779,12 @@ func (s DomainStatus) GoString() string { return s.String() } +// SetAIMLOptions sets the AIMLOptions field's value. +func (s *DomainStatus) SetAIMLOptions(v *AIMLOptionsOutput_) *DomainStatus { + s.AIMLOptions = v + return s +} + // SetARN sets the ARN field's value. func (s *DomainStatus) SetARN(v string) *DomainStatus { s.ARN = &v @@ -17336,6 +17471,84 @@ func (s *ModifyingProperties) SetValueType(v string) *ModifyingProperties { return s } +// Container for parameters required to enable the natural language query generation +// feature. +type NaturalLanguageQueryGenerationOptionsInput_ struct { + _ struct{} `type:"structure"` + + // The desired state of the natural language query generation feature. Valid + // values are ENABLED and DISABLED. + DesiredState *string `type:"string" enum:"NaturalLanguageQueryGenerationDesiredState"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NaturalLanguageQueryGenerationOptionsInput_) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NaturalLanguageQueryGenerationOptionsInput_) GoString() string { + return s.String() +} + +// SetDesiredState sets the DesiredState field's value. +func (s *NaturalLanguageQueryGenerationOptionsInput_) SetDesiredState(v string) *NaturalLanguageQueryGenerationOptionsInput_ { + s.DesiredState = &v + return s +} + +// Container for parameters representing the state of the natural language query +// generation feature on the specified domain. +type NaturalLanguageQueryGenerationOptionsOutput_ struct { + _ struct{} `type:"structure"` + + // The current state of the natural language query generation feature, indicating + // completion, in progress, or failure. + CurrentState *string `type:"string" enum:"NaturalLanguageQueryGenerationCurrentState"` + + // The desired state of the natural language query generation feature. Valid + // values are ENABLED and DISABLED. + DesiredState *string `type:"string" enum:"NaturalLanguageQueryGenerationDesiredState"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NaturalLanguageQueryGenerationOptionsOutput_) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s NaturalLanguageQueryGenerationOptionsOutput_) GoString() string { + return s.String() +} + +// SetCurrentState sets the CurrentState field's value. +func (s *NaturalLanguageQueryGenerationOptionsOutput_) SetCurrentState(v string) *NaturalLanguageQueryGenerationOptionsOutput_ { + s.CurrentState = &v + return s +} + +// SetDesiredState sets the DesiredState field's value. +func (s *NaturalLanguageQueryGenerationOptionsOutput_) SetDesiredState(v string) *NaturalLanguageQueryGenerationOptionsOutput_ { + s.DesiredState = &v + return s +} + // Enables or disables node-to-node encryption. For more information, see Node-to-node // encryption for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ntn.html). type NodeToNodeEncryptionOptions struct { @@ -20245,6 +20458,9 @@ func (s *UpdateDataSourceOutput) SetMessage(v string) *UpdateDataSourceOutput { type UpdateDomainConfigInput struct { _ struct{} `type:"structure"` + // Options for all machine learning features for the specified domain. + AIMLOptions *AIMLOptionsInput_ `type:"structure"` + // Identity and Access Management (IAM) access policy as a JSON-formatted string. AccessPolicies *string `type:"string"` @@ -20419,6 +20635,12 @@ func (s *UpdateDomainConfigInput) Validate() error { return nil } +// SetAIMLOptions sets the AIMLOptions field's value. +func (s *UpdateDomainConfigInput) SetAIMLOptions(v *AIMLOptionsInput_) *UpdateDomainConfigInput { + s.AIMLOptions = v + return s +} + // SetAccessPolicies sets the AccessPolicies field's value. func (s *UpdateDomainConfigInput) SetAccessPolicies(v string) *UpdateDomainConfigInput { s.AccessPolicies = &v @@ -22448,6 +22670,58 @@ func MasterNodeStatus_Values() []string { } } +const ( + // NaturalLanguageQueryGenerationCurrentStateNotEnabled is a NaturalLanguageQueryGenerationCurrentState enum value + NaturalLanguageQueryGenerationCurrentStateNotEnabled = "NOT_ENABLED" + + // NaturalLanguageQueryGenerationCurrentStateEnableComplete is a NaturalLanguageQueryGenerationCurrentState enum value + NaturalLanguageQueryGenerationCurrentStateEnableComplete = "ENABLE_COMPLETE" + + // NaturalLanguageQueryGenerationCurrentStateEnableInProgress is a NaturalLanguageQueryGenerationCurrentState enum value + NaturalLanguageQueryGenerationCurrentStateEnableInProgress = "ENABLE_IN_PROGRESS" + + // NaturalLanguageQueryGenerationCurrentStateEnableFailed is a NaturalLanguageQueryGenerationCurrentState enum value + NaturalLanguageQueryGenerationCurrentStateEnableFailed = "ENABLE_FAILED" + + // NaturalLanguageQueryGenerationCurrentStateDisableComplete is a NaturalLanguageQueryGenerationCurrentState enum value + NaturalLanguageQueryGenerationCurrentStateDisableComplete = "DISABLE_COMPLETE" + + // NaturalLanguageQueryGenerationCurrentStateDisableInProgress is a NaturalLanguageQueryGenerationCurrentState enum value + NaturalLanguageQueryGenerationCurrentStateDisableInProgress = "DISABLE_IN_PROGRESS" + + // NaturalLanguageQueryGenerationCurrentStateDisableFailed is a NaturalLanguageQueryGenerationCurrentState enum value + NaturalLanguageQueryGenerationCurrentStateDisableFailed = "DISABLE_FAILED" +) + +// NaturalLanguageQueryGenerationCurrentState_Values returns all elements of the NaturalLanguageQueryGenerationCurrentState enum +func NaturalLanguageQueryGenerationCurrentState_Values() []string { + return []string{ + NaturalLanguageQueryGenerationCurrentStateNotEnabled, + NaturalLanguageQueryGenerationCurrentStateEnableComplete, + NaturalLanguageQueryGenerationCurrentStateEnableInProgress, + NaturalLanguageQueryGenerationCurrentStateEnableFailed, + NaturalLanguageQueryGenerationCurrentStateDisableComplete, + NaturalLanguageQueryGenerationCurrentStateDisableInProgress, + NaturalLanguageQueryGenerationCurrentStateDisableFailed, + } +} + +const ( + // NaturalLanguageQueryGenerationDesiredStateEnabled is a NaturalLanguageQueryGenerationDesiredState enum value + NaturalLanguageQueryGenerationDesiredStateEnabled = "ENABLED" + + // NaturalLanguageQueryGenerationDesiredStateDisabled is a NaturalLanguageQueryGenerationDesiredState enum value + NaturalLanguageQueryGenerationDesiredStateDisabled = "DISABLED" +) + +// NaturalLanguageQueryGenerationDesiredState_Values returns all elements of the NaturalLanguageQueryGenerationDesiredState enum +func NaturalLanguageQueryGenerationDesiredState_Values() []string { + return []string{ + NaturalLanguageQueryGenerationDesiredStateEnabled, + NaturalLanguageQueryGenerationDesiredStateDisabled, + } +} + const ( // NodeStatusActive is a NodeStatus enum value NodeStatusActive = "Active"