The repository for the Amplify app.
", + "App$repository": "The Git repository for the Amplify app.
", "CreateAppRequest$repository": "The repository for an Amplify app.
", "UpdateAppRequest$repository": "The name of the repository for an Amplify app
" } }, + "RepositoryCloneMethod": { + "base": null, + "refs": { + "App$repositoryCloneMethod": "The authentication protocol to use to access the Git repository for an Amplify app. For a GitHub repository, specify TOKEN. For an Amazon Web Services CodeCommit repository, specify SIGV4. For GitLab and Bitbucket repositories, specify SSH.
The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's backend Amazon Web Services resources.
You can also use the Amplify Studio visual designer to create UI components and model data for an app. For more information, see Introduction in the Amplify Docs.
The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework. For more information about deploying an Amplify application to Amazon Web Services, see the Amplify Console User Guide.
", + "service": "The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's backend Amazon Web Services resources.
You can also use the Amplify Studio visual designer to create UI components and model data for an app. For more information, see Introduction in the Amplify Docs.
The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework. For more information about deploying an Amplify application to Amazon Web Services, see the Amplify User Guide.
", "operations": { "CreateComponent": "Creates a new component for an Amplify app.
", "CreateTheme": "Creates a theme to apply to the components in an Amplify app.
", @@ -18,6 +18,12 @@ "UpdateTheme": "Updates an existing theme.
" }, "shapes": { + "ActionParameters": { + "base": "Represents the event action configuration for an element of a Component or ComponentChild. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. ActionParameters defines the action that is performed when an event occurs on the component.
Describes information about the action.
" + } + }, "Boolean": { "base": null, "refs": { @@ -36,7 +42,7 @@ "ComponentBindingProperties": { "base": null, "refs": { - "Component$bindingProperties": "The information to connect a component's properties to data at runtime.
", + "Component$bindingProperties": "The information to connect a component's properties to data at runtime. You can't specify tags as a valid property for bindingProperties.
The data binding information for the component's properties.
", "UpdateComponentData$bindingProperties": "The data binding information for the component's properties.
" } @@ -71,7 +77,7 @@ "ComponentCollectionProperties": { "base": null, "refs": { - "Component$collectionProperties": "The data binding configuration for the component's properties. Use this for a collection component.
", + "Component$collectionProperties": "The data binding configuration for the component's properties. Use this for a collection component. You can't specify tags as a valid property for collectionProperties.
The data binding configuration for customizing a component's properties. Use this for a collection component.
", "UpdateComponentData$collectionProperties": "The configuration for binding a component's properties to a data model. Use this for a collection component.
" } @@ -79,7 +85,7 @@ "ComponentConditionProperty": { "base": "Represents a conditional expression to set a component property. Use ComponentConditionProperty to set a property to different values conditionally, based on the value of another property.
The conditional expression to use to assign a value to the component property..
" + "ComponentProperty$condition": "The conditional expression to use to assign a value to the component property.
" } }, "ComponentDataConfiguration": { @@ -88,6 +94,21 @@ "ComponentCollectionProperties$value": null } }, + "ComponentEvent": { + "base": "Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild. A button click is an example of an event.
Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
", + "ComponentChild$events": "Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
", + "CreateComponentData$events": "The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
", + "UpdateComponentData$events": "The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
" + } + }, "ComponentList": { "base": null, "refs": { @@ -106,8 +127,8 @@ "ComponentOverrides": { "base": null, "refs": { - "Component$overrides": "Describes the component's properties that can be overriden in a customized instance of the component.
", - "ComponentVariant$overrides": "The properties of the component variant that can be overriden when customizing an instance of the component.
", + "Component$overrides": "Describes the component's properties that can be overriden in a customized instance of the component. You can't specify tags as a valid property for overrides.
The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify tags as a valid property for overrides.
Describes the component properties that can be overriden to customize an instance of the component.
", "UpdateComponentData$overrides": "Describes the properties that can be overriden to customize the component.
" } @@ -121,8 +142,9 @@ "ComponentProperties": { "base": null, "refs": { - "Component$properties": "Describes the component's properties.
", - "ComponentChild$properties": "Describes the properties of the child component.
", + "ActionParameters$fields": "A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
", + "Component$properties": "Describes the component's properties. You can't specify tags as a valid property for properties.
Describes the properties of the child component. You can't specify tags as a valid property for properties.
Describes the component's properties.
", "UpdateComponentData$properties": "Describes the component's properties.
" } @@ -130,10 +152,17 @@ "ComponentProperty": { "base": "Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
The HTML anchor link to the location to open. Specify this value for a navigation action.
", + "ActionParameters$global": "Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
", + "ActionParameters$id": "The unique ID of the component that the ActionParameters apply to.
The element within the same component to modify when the action occurs.
", + "ActionParameters$type": "The type of navigation action. Valid values are url and anchor. This value is required for a navigation action.
The URL to the location to open. Specify this value for a navigation action.
", "ComponentConditionProperty$else": "The value to assign to the property if the condition is not met.
", "ComponentConditionProperty$then": "The value to assign to the property if the condition is met.
", "ComponentProperties$value": null, - "ComponentPropertyList$member": null + "ComponentPropertyList$member": null, + "MutationActionSetStateParameter$set": "The state configuration to assign to the property.
" } }, "ComponentPropertyBindingProperties": { @@ -179,7 +208,7 @@ "ComponentVariantValues": { "base": null, "refs": { - "ComponentVariant$variantValues": "The combination of variants that comprise this variant.
" + "ComponentVariant$variantValues": "The combination of variants that comprise this variant. You can't specify tags as a valid property for variantValues.
Represents the state configuration when an action modifies a property of another element within the same component.
", + "refs": { + "ActionParameters$state": "A key-value pair that specifies the state property name and its initial value.
" + } + }, "Predicate": { "base": "Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
", "Component$appId": "The unique ID of the Amplify app associated with the component.
", "Component$environmentName": "The name of the backend environment that is a part of the Amplify app.
", + "Component$schemaVersion": "The schema version of the component when it was imported.
", "Component$sourceId": "The unique ID of the component in its original source system, such as Figma.
", "ComponentBindingProperties$key": null, "ComponentBindingPropertiesValue$defaultValue": "The default value of the property.
", @@ -439,17 +476,22 @@ "ComponentCollectionProperties$key": null, "ComponentConditionProperty$field": "The name of a field. Specify this when the property is a data model.
", "ComponentConditionProperty$operand": "The value of the property to evaluate.
", + "ComponentConditionProperty$operandType": "The type of the property to evaluate.
", "ComponentConditionProperty$operator": "The operator to use to perform the evaluation, such as eq to represent equals.
The name of the conditional property.
", "ComponentDataConfiguration$model": "The name of the data model to use to bind data to a component.
", + "ComponentEvent$action": "The action to perform when a specific event is raised.
", + "ComponentEvents$key": null, "ComponentOverrides$key": null, "ComponentOverridesValue$key": null, "ComponentOverridesValue$value": null, "ComponentProperties$key": null, + "ComponentProperty$componentName": "The name of the component that is affected by an event.
", "ComponentProperty$defaultValue": "The default value to assign to the component property.
", "ComponentProperty$event": "An event that occurs in your app. Use this for workflow data binding.
", - "ComponentProperty$importedValue": "The default value assigned to property when the component is imported into an app.
", + "ComponentProperty$importedValue": "The default value assigned to the property when the component is imported into an app.
", "ComponentProperty$model": "The data model to use to assign a value to the component property.
", + "ComponentProperty$property": "The name of the component's property that is affected by an event.
", "ComponentProperty$type": "The component type.
", "ComponentProperty$userAttribute": "An authenticated user attribute to use to assign a value to the component property.
", "ComponentProperty$value": "The value to assign to the component property.
", @@ -459,6 +501,7 @@ "ComponentSummary$environmentName": "The name of the backend environment that is a part of the Amplify app.
", "ComponentVariantValues$key": null, "ComponentVariantValues$value": null, + "CreateComponentData$schemaVersion": "The schema version of the component when it was imported.
", "CreateComponentData$sourceId": "The unique ID of the component in its original source system, such as Figma.
", "CreateComponentRequest$appId": "The unique ID of the Amplify app to associate with the component.
", "CreateComponentRequest$clientToken": "The unique client token.
", @@ -473,8 +516,12 @@ "ExchangeCodeForTokenRequestBody$redirectUri": "The location of the application that will receive the access code.
", "ExportComponentsRequest$appId": "The unique ID of the Amplify app to export components to.
", "ExportComponentsRequest$environmentName": "The name of the backend environment that is a part of the Amplify app.
", + "ExportComponentsRequest$nextToken": "The token to request the next page of results.
", + "ExportComponentsResponse$nextToken": "The pagination token that's included if more results are available.
", "ExportThemesRequest$appId": "The unique ID of the Amplify app to export the themes to.
", "ExportThemesRequest$environmentName": "The name of the backend environment that is part of the Amplify app.
", + "ExportThemesRequest$nextToken": "The token to request the next page of results.
", + "ExportThemesResponse$nextToken": "The pagination token that's included if more results are available.
", "FormBindingElement$element": "The name of the component to retrieve a value from.
", "FormBindingElement$property": "The property to retrieve a value from.
", "FormBindings$key": null, @@ -493,6 +540,8 @@ "ListThemesRequest$environmentName": "The name of the backend environment that is a part of the Amplify app.
", "ListThemesRequest$nextToken": "The token to request the next page of results.
", "ListThemesResponse$nextToken": "The pagination token that's returned if more results are available.
", + "MutationActionSetStateParameter$componentName": "The name of the component that is being modified.
", + "MutationActionSetStateParameter$property": "The name of the component property to apply the state configuration to.
", "Predicate$field": "The field to query.
", "Predicate$operand": "The value to use when performing the evaluation.
", "Predicate$operator": "The operator to use to perform the evaluation.
", @@ -506,6 +555,7 @@ "ThemeSummary$environmentName": "The name of the backend environment that is part of the Amplify app.
", "ThemeValue$value": "The value of a theme property.
", "ThemeValues$key": "The name of the property.
", + "UpdateComponentData$schemaVersion": "The schema version of the component when it was imported.
", "UpdateComponentData$sourceId": "The unique ID of the component in its original source system, such as Figma.
", "UpdateComponentRequest$appId": "The unique ID for the Amplify app.
", "UpdateComponentRequest$clientToken": "The unique client token.
", diff --git a/models/apis/amplifyuibuilder/2021-08-11/paginators-1.json b/models/apis/amplifyuibuilder/2021-08-11/paginators-1.json index 7cb8a4b8a84..c8de1450ac8 100644 --- a/models/apis/amplifyuibuilder/2021-08-11/paginators-1.json +++ b/models/apis/amplifyuibuilder/2021-08-11/paginators-1.json @@ -1,5 +1,15 @@ { "pagination": { + "ExportComponents": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "entities" + }, + "ExportThemes": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "entities" + }, "ListComponents": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/models/apis/athena/2017-05-18/api-2.json b/models/apis/athena/2017-05-18/api-2.json index 22a7133cfe5..c3c27d4601f 100644 --- a/models/apis/athena/2017-05-18/api-2.json +++ b/models/apis/athena/2017-05-18/api-2.json @@ -443,6 +443,20 @@ {"shape":"InvalidRequestException"} ] }, + "UpdateNamedQuery":{ + "name":"UpdateNamedQuery", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateNamedQueryInput"}, + "output":{"shape":"UpdateNamedQueryOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "idempotent":true + }, "UpdatePreparedStatement":{ "name":"UpdatePreparedStatement", "http":{ @@ -1201,6 +1215,11 @@ "WorkGroup":{"shape":"WorkGroupName"} } }, + "NamedQueryDescriptionString":{ + "type":"string", + "max":1024, + "min":0 + }, "NamedQueryId":{"type":"string"}, "NamedQueryIdList":{ "type":"list", @@ -1557,6 +1576,25 @@ "members":{ } }, + "UpdateNamedQueryInput":{ + "type":"structure", + "required":[ + "NamedQueryId", + "Name", + "QueryString" + ], + "members":{ + "NamedQueryId":{"shape":"NamedQueryId"}, + "Name":{"shape":"NameString"}, + "Description":{"shape":"NamedQueryDescriptionString"}, + "QueryString":{"shape":"QueryString"} + } + }, + "UpdateNamedQueryOutput":{ + "type":"structure", + "members":{ + } + }, "UpdatePreparedStatementInput":{ "type":"structure", "required":[ diff --git a/models/apis/athena/2017-05-18/docs-2.json b/models/apis/athena/2017-05-18/docs-2.json index 670c42e236f..c3ee8057092 100644 --- a/models/apis/athena/2017-05-18/docs-2.json +++ b/models/apis/athena/2017-05-18/docs-2.json @@ -34,6 +34,7 @@ "TagResource": "Adds one or more tags to an Athena resource. A tag is a label that you assign to a resource. In Athena, a resource can be a workgroup or data catalog. Each tag consists of a key and an optional value, both of which you define. For example, you can use tags to categorize Athena workgroups or data catalogs by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups or data catalogs in your account. For best practices, see Tagging Best Practices. Tag keys can be from 1 to 128 UTF-8 Unicode characters, and tag values can be from 0 to 256 UTF-8 Unicode characters. Tags can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one tag, separate them by commas.
", "UntagResource": "Removes one or more tags from a data catalog or workgroup resource.
", "UpdateDataCatalog": "Updates the data catalog that has the specified name.
", + "UpdateNamedQuery": "Updates a NamedQuery object. The database or workgroup cannot be updated.
", "UpdatePreparedStatement": "Updates a prepared statement.
", "UpdateWorkGroup": "Updates the workgroup with the specified name. The workgroup's name cannot be changed.
" }, @@ -48,7 +49,7 @@ } }, "AthenaError": { - "base": "Provides information about an Athena query error. The AthenaError feature provides standardized error information to help you understand failed queries and take steps after a query failure occurs. AthenaError includes an ErrorCategory field that specifies whether the cause of the failed query is due to system error, user error, or unknown error.
Provides information about an Athena query error. The AthenaError feature provides standardized error information to help you understand failed queries and take steps after a query failure occurs. AthenaError includes an ErrorCategory field that specifies whether the cause of the failed query is due to system error, user error, or other error.
Provides information about an Athena query error.
" } @@ -346,7 +347,7 @@ "ErrorCategory": { "base": null, "refs": { - "AthenaError$ErrorCategory": "An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.
1 - System
2 - User
3 - Unknown
" + "AthenaError$ErrorCategory": "An integer value that specifies the category of a query failure error. The following list shows the category for each integer value.
1 - System
2 - User
3 - Other
" } }, "ErrorCode": { @@ -671,16 +672,23 @@ "GetTableMetadataInput$TableName": "The name of the table for which metadata is returned.
", "ListTableMetadataInput$DatabaseName": "The name of the database for which table metadata should be returned.
", "NamedQuery$Name": "The query name.
", - "TableMetadata$Name": "The name of the table.
" + "TableMetadata$Name": "The name of the table.
", + "UpdateNamedQueryInput$Name": "The name of the query.
" } }, "NamedQuery": { - "base": "A query, where QueryString is the list of SQL query statements that comprise the query.
A query, where QueryString contains the SQL statements that make up the query.
Information about the query.
", "NamedQueryList$member": null } }, + "NamedQueryDescriptionString": { + "base": null, + "refs": { + "UpdateNamedQueryInput$Description": "The query description.
" + } + }, "NamedQueryId": { "base": null, "refs": { @@ -689,7 +697,8 @@ "GetNamedQueryInput$NamedQueryId": "The unique ID of the query. Use ListNamedQueries to get query IDs.
", "NamedQuery$NamedQueryId": "The unique identifier of the query.
", "NamedQueryIdList$member": null, - "UnprocessedNamedQueryId$NamedQueryId": "The unique identifier of the named query.
" + "UnprocessedNamedQueryId$NamedQueryId": "The unique identifier of the named query.
", + "UpdateNamedQueryInput$NamedQueryId": "The unique identifier (UUID) of the query.
" } }, "NamedQueryIdList": { @@ -801,10 +810,11 @@ "refs": { "CreateNamedQueryInput$QueryString": "The contents of the query with all query statements.
", "CreatePreparedStatementInput$QueryStatement": "The query string for the prepared statement.
", - "NamedQuery$QueryString": "The SQL query statements that comprise the query.
", + "NamedQuery$QueryString": "The SQL statements that make up the query.
", "PreparedStatement$QueryStatement": "The query string for the prepared statement.
", "QueryExecution$Query": "The SQL query statements which the query execution ran.
", "StartQueryExecutionInput$QueryString": "The SQL query statements to be executed.
", + "UpdateNamedQueryInput$QueryString": "The contents of the query with all query statements.
", "UpdatePreparedStatementInput$QueryStatement": "The query string for the prepared statement.
" } }, @@ -828,7 +838,7 @@ } }, "ResultSet": { - "base": "The metadata and rows that comprise a query result set. The metadata describes the column structure and data types. To return a ResultSet object, use GetQueryResults.
The metadata and rows that make up a query result set. The metadata describes the column structure and data types. To return a ResultSet object, use GetQueryResults.
The results of the query execution.
" } @@ -840,7 +850,7 @@ } }, "Row": { - "base": "The rows that comprise a query result table.
", + "base": "The rows that make up a query result table.
", "refs": { "RowList$member": null } @@ -1062,6 +1072,16 @@ "refs": { } }, + "UpdateNamedQueryInput": { + "base": null, + "refs": { + } + }, + "UpdateNamedQueryOutput": { + "base": null, + "refs": { + } + }, "UpdatePreparedStatementInput": { "base": null, "refs": { diff --git a/models/apis/ec2/2016-11-15/api-2.json b/models/apis/ec2/2016-11-15/api-2.json index 108d46fcbac..72fd7a69074 100755 --- a/models/apis/ec2/2016-11-15/api-2.json +++ b/models/apis/ec2/2016-11-15/api-2.json @@ -21379,6 +21379,10 @@ "BootMode":{ "shape":"AttributeValue", "locationName":"bootMode" + }, + "LastLaunchedTime":{ + "shape":"AttributeValue", + "locationName":"lastLaunchedTime" } } }, @@ -21392,7 +21396,8 @@ "productCodes", "blockDeviceMapping", "sriovNetSupport", - "bootMode" + "bootMode", + "lastLaunchedTime" ] }, "ImageDiskContainer":{ @@ -32655,6 +32660,7 @@ "spot-fleet-request", "spot-instances-request", "subnet", + "subnet-cidr-reservation", "traffic-mirror-filter", "traffic-mirror-session", "traffic-mirror-target", diff --git a/models/apis/ec2/2016-11-15/docs-2.json b/models/apis/ec2/2016-11-15/docs-2.json index 73a170e7fbb..aad6987a4e3 100755 --- a/models/apis/ec2/2016-11-15/docs-2.json +++ b/models/apis/ec2/2016-11-15/docs-2.json @@ -1367,7 +1367,8 @@ "ImageAttribute$KernelId": "The kernel ID.
", "ImageAttribute$RamdiskId": "The RAM disk ID.
", "ImageAttribute$SriovNetSupport": "Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
", - "ImageAttribute$BootMode": null, + "ImageAttribute$BootMode": "The boot mode.
", + "ImageAttribute$LastLaunchedTime": "The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used, there is a 24-hour delay before that usage is reported.
lastLaunchedTime data is available starting April 2017.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
", "InstanceAttribute$InstanceType": "The instance type.
", "InstanceAttribute$KernelId": "The kernel ID.
", diff --git a/models/apis/finspace-data/2020-07-13/api-2.json b/models/apis/finspace-data/2020-07-13/api-2.json index d7bf8d5a9d1..ed455e94d11 100644 --- a/models/apis/finspace-data/2020-07-13/api-2.json +++ b/models/apis/finspace-data/2020-07-13/api-2.json @@ -66,6 +66,40 @@ {"shape":"ResourceNotFoundException"} ] }, + "CreatePermissionGroup":{ + "name":"CreatePermissionGroup", + "http":{ + "method":"POST", + "requestUri":"/permission-group" + }, + "input":{"shape":"CreatePermissionGroupRequest"}, + "output":{"shape":"CreatePermissionGroupResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConflictException"} + ] + }, + "CreateUser":{ + "name":"CreateUser", + "http":{ + "method":"POST", + "requestUri":"/user" + }, + "input":{"shape":"CreateUserRequest"}, + "output":{"shape":"CreateUserResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConflictException"} + ] + }, "DeleteDataset":{ "name":"DeleteDataset", "http":{ @@ -84,6 +118,59 @@ {"shape":"ConflictException"} ] }, + "DeletePermissionGroup":{ + "name":"DeletePermissionGroup", + "http":{ + "method":"DELETE", + "requestUri":"/permission-group/{permissionGroupId}" + }, + "input":{"shape":"DeletePermissionGroupRequest"}, + "output":{"shape":"DeletePermissionGroupResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConflictException"} + ] + }, + "DisableUser":{ + "name":"DisableUser", + "http":{ + "method":"POST", + "requestUri":"/user/{userId}/disable" + }, + "input":{"shape":"DisableUserRequest"}, + "output":{"shape":"DisableUserResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ] + }, + "EnableUser":{ + "name":"EnableUser", + "http":{ + "method":"POST", + "requestUri":"/user/{userId}/enable" + }, + "input":{"shape":"EnableUserRequest"}, + "output":{"shape":"EnableUserResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConflictException"} + ] + }, "GetChangeset":{ "name":"GetChangeset", "http":{ @@ -149,6 +236,22 @@ {"shape":"AccessDeniedException"} ] }, + "GetUser":{ + "name":"GetUser", + "http":{ + "method":"GET", + "requestUri":"/user/{userId}" + }, + "input":{"shape":"GetUserRequest"}, + "output":{"shape":"GetUserResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, "GetWorkingLocation":{ "name":"GetWorkingLocation", "http":{ @@ -213,6 +316,53 @@ {"shape":"ResourceNotFoundException"} ] }, + "ListPermissionGroups":{ + "name":"ListPermissionGroups", + "http":{ + "method":"GET", + "requestUri":"/permission-group" + }, + "input":{"shape":"ListPermissionGroupsRequest"}, + "output":{"shape":"ListPermissionGroupsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "ListUsers":{ + "name":"ListUsers", + "http":{ + "method":"GET", + "requestUri":"/user" + }, + "input":{"shape":"ListUsersRequest"}, + "output":{"shape":"ListUsersResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "ResetUserPassword":{ + "name":"ResetUserPassword", + "http":{ + "method":"POST", + "requestUri":"/user/{userId}/password" + }, + "input":{"shape":"ResetUserPasswordRequest"}, + "output":{"shape":"ResetUserPasswordResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ] + }, "UpdateChangeset":{ "name":"UpdateChangeset", "http":{ @@ -246,6 +396,40 @@ {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"} ] + }, + "UpdatePermissionGroup":{ + "name":"UpdatePermissionGroup", + "http":{ + "method":"PUT", + "requestUri":"/permission-group/{permissionGroupId}" + }, + "input":{"shape":"UpdatePermissionGroupRequest"}, + "output":{"shape":"UpdatePermissionGroupResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ] + }, + "UpdateUser":{ + "name":"UpdateUser", + "http":{ + "method":"PUT", + "requestUri":"/user/{userId}" + }, + "input":{"shape":"UpdateUserRequest"}, + "output":{"shape":"UpdateUserResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ] } }, "shapes":{ @@ -263,6 +447,29 @@ "min":1, "pattern":"^alias\\/\\S+" }, + "ApiAccess":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "ApplicationPermission":{ + "type":"string", + "enum":[ + "CreateDataset", + "ManageClusters", + "ManageUsersAndGroups", + "ManageAttributeSets", + "ViewAuditData", + "AccessNotebooks", + "GetTemporaryCredentials" + ] + }, + "ApplicationPermissionList":{ + "type":"list", + "member":{"shape":"ApplicationPermission"} + }, "Boolean":{"type":"boolean"}, "ChangeType":{ "type":"string", @@ -365,7 +572,8 @@ "ConflictException":{ "type":"structure", "members":{ - "message":{"shape":"errorMessage"} + "message":{"shape":"errorMessage"}, + "reason":{"shape":"errorMessage"} }, "error":{"httpStatusCode":409}, "exception":true @@ -460,6 +668,53 @@ "datasetId":{"shape":"DatasetId"} } }, + "CreatePermissionGroupRequest":{ + "type":"structure", + "required":[ + "name", + "applicationPermissions" + ], + "members":{ + "name":{"shape":"PermissionGroupName"}, + "description":{"shape":"PermissionGroupDescription"}, + "applicationPermissions":{"shape":"ApplicationPermissionList"}, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + } + } + }, + "CreatePermissionGroupResponse":{ + "type":"structure", + "members":{ + "permissionGroupId":{"shape":"PermissionGroupId"} + } + }, + "CreateUserRequest":{ + "type":"structure", + "required":[ + "emailAddress", + "type" + ], + "members":{ + "emailAddress":{"shape":"Email"}, + "type":{"shape":"UserType"}, + "firstName":{"shape":"FirstName"}, + "lastName":{"shape":"LastName"}, + "ApiAccess":{"shape":"ApiAccess"}, + "apiAccessPrincipalArn":{"shape":"RoleArn"}, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + } + } + }, + "CreateUserResponse":{ + "type":"structure", + "members":{ + "userId":{"shape":"UserId"} + } + }, "Credentials":{ "type":"structure", "members":{ @@ -612,11 +867,77 @@ "datasetId":{"shape":"DatasetId"} } }, + "DeletePermissionGroupRequest":{ + "type":"structure", + "required":["permissionGroupId"], + "members":{ + "permissionGroupId":{ + "shape":"PermissionGroupId", + "location":"uri", + "locationName":"permissionGroupId" + }, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true, + "location":"querystring", + "locationName":"clientToken" + } + } + }, + "DeletePermissionGroupResponse":{ + "type":"structure", + "members":{ + "permissionGroupId":{"shape":"PermissionGroupId"} + } + }, + "DisableUserRequest":{ + "type":"structure", + "required":["userId"], + "members":{ + "userId":{ + "shape":"UserId", + "location":"uri", + "locationName":"userId" + }, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + } + } + }, + "DisableUserResponse":{ + "type":"structure", + "members":{ + "userId":{"shape":"UserId"} + } + }, "Email":{ "type":"string", "max":320, "min":4, - "pattern":"[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}" + "pattern":"[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}", + "sensitive":true + }, + "EnableUserRequest":{ + "type":"structure", + "required":["userId"], + "members":{ + "userId":{ + "shape":"UserId", + "location":"uri", + "locationName":"userId" + }, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + } + } + }, + "EnableUserResponse":{ + "type":"structure", + "members":{ + "userId":{"shape":"UserId"} + } }, "ErrorCategory":{ "type":"string", @@ -642,6 +963,13 @@ "DELIMITED_TEXT" ] }, + "FirstName":{ + "type":"string", + "max":50, + "min":1, + "pattern":".*\\S.*", + "sensitive":true + }, "FormatParams":{ "type":"map", "key":{"shape":"StringMapKey"}, @@ -778,6 +1106,35 @@ "durationInMinutes":{"shape":"SessionDuration"} } }, + "GetUserRequest":{ + "type":"structure", + "required":["userId"], + "members":{ + "userId":{ + "shape":"UserId", + "location":"uri", + "locationName":"userId" + } + } + }, + "GetUserResponse":{ + "type":"structure", + "members":{ + "userId":{"shape":"UserId"}, + "status":{"shape":"UserStatus"}, + "firstName":{"shape":"FirstName"}, + "lastName":{"shape":"LastName"}, + "emailAddress":{"shape":"Email"}, + "type":{"shape":"UserType"}, + "apiAccess":{"shape":"ApiAccess"}, + "apiAccessPrincipalArn":{"shape":"RoleArn"}, + "createTime":{"shape":"TimestampEpoch"}, + "lastEnabledTime":{"shape":"TimestampEpoch"}, + "lastDisabledTime":{"shape":"TimestampEpoch"}, + "lastModifiedTime":{"shape":"TimestampEpoch"}, + "lastLoginTime":{"shape":"TimestampEpoch"} + } + }, "GetWorkingLocationRequest":{ "type":"structure", "members":{ @@ -815,6 +1172,13 @@ "error":{"httpStatusCode":500}, "exception":true }, + "LastName":{ + "type":"string", + "max":50, + "min":1, + "pattern":".*\\S.*", + "sensitive":true + }, "LimitExceededException":{ "type":"structure", "members":{ @@ -904,6 +1268,52 @@ "nextToken":{"shape":"PaginationToken"} } }, + "ListPermissionGroupsRequest":{ + "type":"structure", + "required":["maxResults"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"ResultLimit", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListPermissionGroupsResponse":{ + "type":"structure", + "members":{ + "permissionGroups":{"shape":"PermissionGroupList"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListUsersRequest":{ + "type":"structure", + "required":["maxResults"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"ResultLimit", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListUsersResponse":{ + "type":"structure", + "members":{ + "users":{"shape":"UserList"}, + "nextToken":{"shape":"PaginationToken"} + } + }, "OwnerName":{ "type":"string", "max":250, @@ -915,10 +1325,47 @@ "type":"list", "member":{"shape":"StringValueLength1to255"} }, + "Password":{ + "type":"string", + "max":20, + "min":8, + "pattern":".*\\S.*", + "sensitive":true + }, + "PermissionGroup":{ + "type":"structure", + "members":{ + "permissionGroupId":{"shape":"PermissionGroupId"}, + "name":{"shape":"PermissionGroupName"}, + "description":{"shape":"PermissionGroupDescription"}, + "applicationPermissions":{"shape":"ApplicationPermissionList"}, + "createTime":{"shape":"TimestampEpoch"}, + "lastModifiedTime":{"shape":"TimestampEpoch"} + } + }, + "PermissionGroupDescription":{ + "type":"string", + "max":4000, + "min":1, + "pattern":".*\\S.*", + "sensitive":true + }, "PermissionGroupId":{ "type":"string", "max":26, - "min":1 + "min":1, + "pattern":".*\\S.*" + }, + "PermissionGroupList":{ + "type":"list", + "member":{"shape":"PermissionGroup"} + }, + "PermissionGroupName":{ + "type":"string", + "max":255, + "min":1, + "pattern":".*\\S.*", + "sensitive":true }, "PermissionGroupParams":{ "type":"structure", @@ -933,10 +1380,33 @@ "min":10, "pattern":"^[\\+0-9\\#\\,\\(][\\+0-9\\-\\.\\/\\(\\)\\,\\#\\s]+$" }, + "ResetUserPasswordRequest":{ + "type":"structure", + "required":["userId"], + "members":{ + "userId":{ + "shape":"UserId", + "location":"uri", + "locationName":"userId" + }, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + } + } + }, + "ResetUserPasswordResponse":{ + "type":"structure", + "members":{ + "userId":{"shape":"UserId"}, + "temporaryPassword":{"shape":"Password"} + } + }, "ResourceNotFoundException":{ "type":"structure", "members":{ - "message":{"shape":"errorMessage"} + "message":{"shape":"errorMessage"}, + "reason":{"shape":"errorMessage"} }, "error":{"httpStatusCode":404}, "exception":true @@ -956,6 +1426,12 @@ "max":100, "min":1 }, + "RoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" + }, "S3DestinationFormatOptions":{ "type":"map", "key":{"shape":"StringMapKey"}, @@ -1082,10 +1558,104 @@ "datasetId":{"shape":"DatasetId"} } }, + "UpdatePermissionGroupRequest":{ + "type":"structure", + "required":["permissionGroupId"], + "members":{ + "permissionGroupId":{ + "shape":"PermissionGroupId", + "location":"uri", + "locationName":"permissionGroupId" + }, + "name":{"shape":"PermissionGroupName"}, + "description":{"shape":"PermissionGroupDescription"}, + "applicationPermissions":{"shape":"ApplicationPermissionList"}, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + } + } + }, + "UpdatePermissionGroupResponse":{ + "type":"structure", + "members":{ + "permissionGroupId":{"shape":"PermissionGroupId"} + } + }, + "UpdateUserRequest":{ + "type":"structure", + "required":["userId"], + "members":{ + "userId":{ + "shape":"UserId", + "location":"uri", + "locationName":"userId" + }, + "type":{"shape":"UserType"}, + "firstName":{"shape":"FirstName"}, + "lastName":{"shape":"LastName"}, + "apiAccess":{"shape":"ApiAccess"}, + "apiAccessPrincipalArn":{"shape":"RoleArn"}, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + } + } + }, + "UpdateUserResponse":{ + "type":"structure", + "members":{ + "userId":{"shape":"UserId"} + } + }, + "User":{ + "type":"structure", + "members":{ + "userId":{"shape":"UserId"}, + "status":{"shape":"UserStatus"}, + "firstName":{"shape":"FirstName"}, + "lastName":{"shape":"LastName"}, + "emailAddress":{"shape":"Email"}, + "type":{"shape":"UserType"}, + "apiAccess":{"shape":"ApiAccess"}, + "apiAccessPrincipalArn":{"shape":"RoleArn"}, + "createTime":{"shape":"TimestampEpoch"}, + "lastEnabledTime":{"shape":"TimestampEpoch"}, + "lastDisabledTime":{"shape":"TimestampEpoch"}, + "lastModifiedTime":{"shape":"TimestampEpoch"}, + "lastLoginTime":{"shape":"TimestampEpoch"} + } + }, + "UserId":{ + "type":"string", + "max":26, + "min":1, + "pattern":".*\\S.*" + }, + "UserList":{ + "type":"list", + "member":{"shape":"User"} + }, + "UserStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ENABLED", + "DISABLED" + ] + }, + "UserType":{ + "type":"string", + "enum":[ + "SUPER_USER", + "APP_USER" + ] + }, "ValidationException":{ "type":"structure", "members":{ - "message":{"shape":"errorMessage"} + "message":{"shape":"errorMessage"}, + "reason":{"shape":"errorMessage"} }, "error":{"httpStatusCode":400}, "exception":true diff --git a/models/apis/finspace-data/2020-07-13/docs-2.json b/models/apis/finspace-data/2020-07-13/docs-2.json index efd0be4fa94..d9e1195d598 100644 --- a/models/apis/finspace-data/2020-07-13/docs-2.json +++ b/models/apis/finspace-data/2020-07-13/docs-2.json @@ -5,17 +5,28 @@ "CreateChangeset": "Creates a new Changeset in a FinSpace Dataset.
", "CreateDataView": "Creates a Dataview for a Dataset.
", "CreateDataset": "Creates a new FinSpace Dataset.
", + "CreatePermissionGroup": "Creates a group of permissions for various actions that a user can perform in FinSpace.
", + "CreateUser": "Creates a new user in FinSpace.
", "DeleteDataset": "Deletes a FinSpace Dataset.
", + "DeletePermissionGroup": "Deletes a permission group. This action is irreversible.
", + "DisableUser": "Denies access to the FinSpace web application and API for the specified user.
", + "EnableUser": "Allows the specified user to access the FinSpace web application and API.
", "GetChangeset": "Get information about a Changeset.
", "GetDataView": "Gets information about a Dataview.
", "GetDataset": "Returns information about a Dataset.
", "GetProgrammaticAccessCredentials": "Request programmatic credentials to use with FinSpace SDK.
", + "GetUser": "Retrieves details for a specific user.
", "GetWorkingLocation": "A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook.
", "ListChangesets": "Lists the FinSpace Changesets for a Dataset.
", "ListDataViews": "Lists all available Dataviews for a Dataset.
", "ListDatasets": "Lists all of the active Datasets that a user has access to.
", + "ListPermissionGroups": "Lists all available permission groups in FinSpace.
", + "ListUsers": "Lists all available user accounts in FinSpace.
", + "ResetUserPassword": "Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.
", "UpdateChangeset": "Updates a FinSpace Changeset.
", - "UpdateDataset": "Updates a FinSpace Dataset.
" + "UpdateDataset": "Updates a FinSpace Dataset.
", + "UpdatePermissionGroup": "Modifies the details of a permission group. You cannot modify a permissionGroupID.
Modifies the details of the specified user account. You cannot update the userId for a user.
The unique resource identifier for a Dataset.
" } }, + "ApiAccess": { + "base": null, + "refs": { + "CreateUserRequest$ApiAccess": "The option to indicate whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
ENABLED – The user has permissions to use the APIs.
DISABLED – The user does not have permissions to use any APIs.
Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
ENABLED – The user has permissions to use the APIs.
DISABLED – The user does not have permissions to use any APIs.
The option to indicate whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
ENABLED – The user has permissions to use the APIs.
DISABLED – The user does not have permissions to use any APIs.
Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
ENABLED – The user has permissions to use the APIs.
DISABLED – The user does not have permissions to use any APIs.
The option to indicate FinSpace application permissions that are granted to a specific group.
CreateDataset – Group members can create new datasets.
ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
ManageUsersAndGroups – Group members can manage users and permission groups.
ManageAttributeSets – Group members can manage attribute sets.
ViewAuditData – Group members can view audit data.
AccessNotebooks – Group members will have access to FinSpace notebooks.
GetTemporaryCredentials – Group members can get temporary API credentials.
Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
CreateDataset – Group members can create new datasets.
ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
ManageUsersAndGroups – Group members can manage users and permission groups.
ManageAttributeSets – Group members can manage attribute sets.
ViewAuditData – Group members can view audit data.
AccessNotebooks – Group members will have access to FinSpace notebooks.
GetTemporaryCredentials – Group members can get temporary API credentials.
The permissions that are granted to a specific group for accessing the FinSpace application.
CreateDataset – Group members can create new datasets.
ManageClusters – Group members can manage Apache Spark clusters from FinSpace notebooks.
ManageUsersAndGroups – Group members can manage users and permission groups.
ManageAttributeSets – Group members can manage attribute sets.
ViewAuditData – Group members can view audit data.
AccessNotebooks – Group members will have access to FinSpace notebooks.
GetTemporaryCredentials – Group members can get temporary API credentials.
Type that indicates how a Changeset is applied to a Dataset.
REPLACE - Changeset is considered as a replacement to all prior loaded Changesets.
APPEND - Changeset is considered as an addition to the end of all prior loaded Changesets.
MODIFY - Changeset is considered as a replacement to a specific prior ingested Changeset.
Option to indicate how a Changeset will be applied to a Dataset.
REPLACE - Changeset will be considered as a replacement to all prior loaded Changesets.
APPEND - Changeset will be considered as an addition to the end of all prior loaded Changesets.
MODIFY - Changeset is considered as a replacement to a specific prior ingested Changeset.
Type that indicates how a Changeset is applied to a Dataset.
REPLACE - Changeset is considered as a replacement to all prior loaded Changesets.
APPEND - Changeset is considered as an addition to the end of all prior loaded Changesets.
MODIFY - Changeset is considered as a replacement to a specific prior ingested Changeset.
Type that indicates how a Changeset is applied to a Dataset.
REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.
APPEND – Changeset is considered as an addition to the end of all prior loaded Changesets.
MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.
The option to indicate how a Changeset will be applied to a Dataset.
REPLACE – Changeset will be considered as a replacement to all prior loaded Changesets.
APPEND – Changeset will be considered as an addition to the end of all prior loaded Changesets.
MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.
Type that indicates how a Changeset is applied to a Dataset.
REPLACE – Changeset is considered as a replacement to all prior loaded Changesets.
APPEND – Changeset is considered as an addition to the end of all prior loaded Changesets.
MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.
A token that ensures idempotency. This token expires in 10 minutes.
", "CreateDataViewRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "CreateDatasetRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", + "CreatePermissionGroupRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", + "CreateUserRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "DeleteDatasetRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", + "DeletePermissionGroupRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", + "DisableUserRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", + "EnableUserRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", + "ResetUserPasswordRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", "UpdateChangesetRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", - "UpdateDatasetRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
" + "UpdateDatasetRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", + "UpdatePermissionGroupRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
", + "UpdateUserRequest$clientToken": "A token that ensures idempotency. This token expires in 10 minutes.
" } }, "ColumnDataType": { "base": "Data type of a column.", "refs": { - "ColumnDefinition$dataType": "Data type of a column.
STRING - A String data type.
CHAR - A char data type.
INTEGER - An integer data type.
TINYINT - A tinyint data type.
SMALLINT - A smallint data type.
BIGINT - A bigint data type.
FLOAT - A float data type.
DOUBLE - A double data type.
DATE - A date data type.
DATETIME - A datetime data type.
BOOLEAN - A boolean data type.
BINARY - A binary data type.
Data type of a column.
STRING – A String data type.
CHAR – A char data type.
INTEGER – An integer data type.
TINYINT – A tinyint data type.
SMALLINT – A smallint data type.
BIGINT – A bigint data type.
FLOAT – A float data type.
DOUBLE – A double data type.
DATE – A date data type.
DATETIME – A datetime data type.
BOOLEAN – A boolean data type.
BINARY – A binary data type.
Name for a column.
", + "ColumnDefinition$columnName": "The name of a column.
", "ColumnNameList$member": null } }, @@ -172,6 +214,26 @@ "refs": { } }, + "CreatePermissionGroupRequest": { + "base": null, + "refs": { + } + }, + "CreatePermissionGroupResponse": { + "base": null, + "refs": { + } + }, + "CreateUserRequest": { + "base": null, + "refs": { + } + }, + "CreateUserResponse": { + "base": null, + "refs": { + } + }, "Credentials": { "base": "Short term API credentials.
", "refs": { @@ -188,7 +250,7 @@ "DataViewDestinationType": { "base": "DataView Destination Type", "refs": { - "DataViewDestinationTypeParams$destinationType": "Destination type for a Dataview.
GLUE_TABLE - Glue table destination type.
S3 - S3 destination type.
Destination type for a Dataview.
GLUE_TABLE – Glue table destination type.
S3 – S3 destination type.
The status of a Dataview creation.
RUNNING - Dataview creation is running.
STARTING - Dataview creation is starting.
FAILED - Dataview creation has failed.
CANCELLED - Dataview creation has been cancelled.
TIMEOUT - Dataview creation has timed out.
SUCCESS - Dataview creation has succeeded.
PENDING - Dataview creation is pending.
FAILED_CLEANUP_FAILED - Dataview creation failed and resource cleanup failed.
The status of a Dataview creation.
RUNNING - Dataview creation is running.
STARTING - Dataview creation is starting.
FAILED - Dataview creation has failed.
CANCELLED - Dataview creation has been cancelled.
TIMEOUT - Dataview creation has timed out.
SUCCESS - Dataview creation has succeeded.
PENDING - Dataview creation is pending.
FAILED_CLEANUP_FAILED - Dataview creation failed and resource cleanup failed.
The status of a Dataview creation.
RUNNING – Dataview creation is running.
STARTING – Dataview creation is starting.
FAILED – Dataview creation has failed.
CANCELLED – Dataview creation has been cancelled.
TIMEOUT – Dataview creation has timed out.
SUCCESS – Dataview creation has succeeded.
PENDING – Dataview creation is pending.
FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.
The status of a Dataview creation.
RUNNING – Dataview creation is running.
STARTING – Dataview creation is starting.
FAILED – Dataview creation has failed.
CANCELLED – Dataview creation has been cancelled.
TIMEOUT – Dataview creation has timed out.
SUCCESS – Dataview creation has succeeded.
PENDING – Dataview creation is pending.
FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup failed.
The format in which Dataset data is structured.
TABULAR - Data is structured in a tabular format.
NON_TABULAR - Data is structured in a non-tabular format.
The format in which Dataset data is structured.
TABULAR - Data is structured in a tabular format.
NON_TABULAR - Data is structured in a non-tabular format.
The format in which Dataset data is structured.
TABULAR - Data is structured in a tabular format.
NON_TABULAR - Data is structured in a non-tabular format.
The format in which the Dataset data is structured.
TABULAR - Data is structured in a tabular format.
NON_TABULAR - Data is structured in a non-tabular format.
The format in which Dataset data is structured.
TABULAR – Data is structured in a tabular format.
NON_TABULAR – Data is structured in a non-tabular format.
The format in which Dataset data is structured.
TABULAR – Data is structured in a tabular format.
NON_TABULAR – Data is structured in a non-tabular format.
The format in which Dataset data is structured.
TABULAR – Data is structured in a tabular format.
NON_TABULAR – Data is structured in a non-tabular format.
The format in which the Dataset data is structured.
TABULAR – Data is structured in a tabular format.
NON_TABULAR – Data is structured in a non-tabular format.
Status of the Dataset creation.
PENDING - Dataset is pending creation.
FAILED - Dataset creation has failed.
SUCCESS - Dataset creation has succeeded.
RUNNING - Dataset creation is running.
Status of the Dataset creation.
PENDING – Dataset is pending creation.
FAILED – Dataset creation has failed.
SUCCESS – Dataset creation has succeeded.
RUNNING – Dataset creation is running.
The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.
", + "DatasetOwnerInfo$email": "Email address for the Dataset owner.
", + "GetUserResponse$emailAddress": "The email address that is associated with the user.
", + "User$emailAddress": "The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.
" + } + }, + "EnableUserRequest": { + "base": null, + "refs": { + } + }, + "EnableUserResponse": { + "base": null, "refs": { - "DatasetOwnerInfo$email": "Email address for the Dataset owner.
" } }, "ErrorCategory": { "base": "Changeset Error Category", "refs": { - "ChangesetErrorInfo$errorCategory": "The category of the error.
VALIDATION -The inputs to this request are invalid.
SERVICE_QUOTA_EXCEEDED - Service quotas have been exceeded. Please contact AWS support to increase quotas.
ACCESS_DENIED - Missing required permission to perform this request.
RESOURCE_NOT_FOUND - One or more inputs to this request were not found.
THROTTLING - The system temporarily lacks sufficient resources to process the request.
INTERNAL_SERVICE_EXCEPTION - An internal service error has occurred.
CANCELLED - Cancelled.
USER_RECOVERABLE - A user recoverable error has occurred.
The category of the error.
VALIDATION -The inputs to this request are invalid.
SERVICE_QUOTA_EXCEEDED - Service quotas have been exceeded. Please contact AWS support to increase quotas.
ACCESS_DENIED - Missing required permission to perform this request.
RESOURCE_NOT_FOUND - One or more inputs to this request were not found.
THROTTLING - The system temporarily lacks sufficient resources to process the request.
INTERNAL_SERVICE_EXCEPTION - An internal service error has occurred.
CANCELLED - Cancelled.
USER_RECOVERABLE - A user recoverable error has occurred.
The category of the error.
VALIDATION – The inputs to this request are invalid.
SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please contact AWS support to increase quotas.
ACCESS_DENIED – Missing required permission to perform this request.
RESOURCE_NOT_FOUND – One or more inputs to this request were not found.
THROTTLING – The system temporarily lacks sufficient resources to process the request.
INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred.
CANCELLED – Cancelled.
USER_RECOVERABLE – A user recoverable error has occurred.
The category of the error.
VALIDATION – The inputs to this request are invalid.
SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please contact AWS support to increase quotas.
ACCESS_DENIED – Missing required permission to perform this request.
RESOURCE_NOT_FOUND – One or more inputs to this request were not found.
THROTTLING – The system temporarily lacks sufficient resources to process the request.
INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred.
CANCELLED – Cancelled.
USER_RECOVERABLE – A user recoverable error has occurred.
Data view export file format.
PARQUET - Parquet export file format.
DELIMITED_TEXT - Delimited text export file format.
Data view export file format.
PARQUET – Parquet export file format.
DELIMITED_TEXT – Delimited text export file format.
The first name of the user that you want to register.
", + "GetUserResponse$firstName": "The first name of the user.
", + "UpdateUserRequest$firstName": "The first name of the user.
", + "User$firstName": "The first name of the user.
" } }, "FormatParams": { "base": "Format Parameters of a Changeset", "refs": { "ChangesetSummary$formatParams": "Options that define the structure of the source file(s).
", - "CreateChangesetRequest$formatParams": "Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression).
formatType is a required attribute and can have the following values:
PARQUET - Parquet source file format.
CSV - CSV source file format.
JSON - JSON source file format.
XML - XML source file format.
Here is an example of how you could specify the formatParams:
\"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" }
Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:
{ \"withHeader\": \"true\", \"separator\": \",\" }
For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.
", + "CreateChangesetRequest$formatParams": "Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression).
formatType is a required attribute and can have the following values:
PARQUET – Parquet source file format.
CSV – CSV source file format.
JSON – JSON source file format.
XML – XML source file format.
Here is an example of how you could specify the formatParams:
\"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" }
Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:
{ \"withHeader\": \"true\", \"separator\": \",\" }
For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.
", "GetChangesetResponse$formatParams": "Structure of the source file(s).
", - "UpdateChangesetRequest$formatParams": "Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression).
formatType is a required attribute and can have the following values:
PARQUET - Parquet source file format.
CSV - CSV source file format.
JSON - JSON source file format.
XML - XML source file format.
Here is an example of how you could specify the formatParams:
\"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" }
Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:
{ \"withHeader\": \"true\", \"separator\": \",\" }
For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.
" + "UpdateChangesetRequest$formatParams": "Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression).
formatType is a required attribute and can have the following values:
PARQUET – Parquet source file format.
CSV – CSV source file format.
JSON – JSON source file format.
XML – XML source file format.
Here is an example of how you could specify the formatParams:
\"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" }
Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:
{ \"withHeader\": \"true\", \"separator\": \",\" }
For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.
" } }, "GetChangesetRequest": { @@ -404,6 +508,16 @@ "refs": { } }, + "GetUserRequest": { + "base": null, + "refs": { + } + }, + "GetUserResponse": { + "base": null, + "refs": { + } + }, "GetWorkingLocationRequest": { "base": null, "refs": { @@ -423,7 +537,7 @@ "IngestionStatus": { "base": "Status of the ingestion process returned from scheduler service.", "refs": { - "ChangesetSummary$status": "Status of the Changeset ingestion.
PENDING - Changeset is pending creation.
FAILED - Changeset creation has failed.
SUCCESS - Changeset creation has succeeded.
RUNNING - Changeset creation is running.
STOP_REQUESTED - User requested Changeset creation to stop.
Status of the Changeset ingestion.
PENDING – Changeset is pending creation.
FAILED – Changeset creation has failed.
SUCCESS – Changeset creation has succeeded.
RUNNING – Changeset creation is running.
STOP_REQUESTED – User requested Changeset creation to stop.
The status of Changeset creation operation.
" } }, @@ -432,6 +546,15 @@ "refs": { } }, + "LastName": { + "base": null, + "refs": { + "CreateUserRequest$lastName": "The last name of the user that you want to register.
", + "GetUserResponse$lastName": "The last name of the user.
", + "UpdateUserRequest$lastName": "The last name of the user.
", + "User$lastName": "The last name of the user.
" + } + }, "LimitExceededException": { "base": "A limit has exceeded.
", "refs": { @@ -467,21 +590,45 @@ "refs": { } }, + "ListPermissionGroupsRequest": { + "base": null, + "refs": { + } + }, + "ListPermissionGroupsResponse": { + "base": null, + "refs": { + } + }, + "ListUsersRequest": { + "base": null, + "refs": { + } + }, + "ListUsersResponse": { + "base": null, + "refs": { + } + }, "OwnerName": { "base": "1 - 250 character String", "refs": { - "DatasetOwnerInfo$name": "Name of the Dataset owner.
" + "DatasetOwnerInfo$name": "The name of the Dataset owner.
" } }, "PaginationToken": { "base": "Pagination token for list operations", "refs": { - "ListChangesetsRequest$nextToken": "A token indicating where a results page should begin.
", - "ListChangesetsResponse$nextToken": "A token indicating where a results page should begin.
", - "ListDataViewsRequest$nextToken": "A token indicating where a results page should begin.
", - "ListDataViewsResponse$nextToken": "A token indicating where a results page should begin.
", - "ListDatasetsRequest$nextToken": "A token indicating where a results page should begin.
", - "ListDatasetsResponse$nextToken": "A token indicating where a results page should begin.
" + "ListChangesetsRequest$nextToken": "A token that indicates where a results page should begin.
", + "ListChangesetsResponse$nextToken": "A token that indicates where a results page should begin.
", + "ListDataViewsRequest$nextToken": "A token that indicates where a results page should begin.
", + "ListDataViewsResponse$nextToken": "A token that indicates where a results page should begin.
", + "ListDatasetsRequest$nextToken": "A token that indicates where a results page should begin.
", + "ListDatasetsResponse$nextToken": "A token that indicates where a results page should begin.
", + "ListPermissionGroupsRequest$nextToken": "A token that indicates where a results page should begin.
", + "ListPermissionGroupsResponse$nextToken": "A token that indicates where a results page should begin.
", + "ListUsersRequest$nextToken": "A token that indicates where a results page should begin.
", + "ListUsersResponse$nextToken": "A token that indicates where a results page should begin.
" } }, "PartitionColumnList": { @@ -492,10 +639,50 @@ "GetDataViewResponse$partitionColumns": "Ordered set of column names used to partition data.
" } }, + "Password": { + "base": null, + "refs": { + "ResetUserPasswordResponse$temporaryPassword": "A randomly generated temporary password for the requested user account. This password expires in 7 days.
" + } + }, + "PermissionGroup": { + "base": "The structure for a permission group.
", + "refs": { + "PermissionGroupList$member": null + } + }, + "PermissionGroupDescription": { + "base": null, + "refs": { + "CreatePermissionGroupRequest$description": "A brief description for the permission group.
", + "PermissionGroup$description": "A brief description for the permission group.
", + "UpdatePermissionGroupRequest$description": "A brief description for the permission group.
" + } + }, "PermissionGroupId": { - "base": "Id of the associated PermissionGroup", + "base": null, + "refs": { + "CreatePermissionGroupResponse$permissionGroupId": "The unique identifier for the permission group.
", + "DeletePermissionGroupRequest$permissionGroupId": "The unique identifier for the permission group that you want to delete.
", + "DeletePermissionGroupResponse$permissionGroupId": "The unique identifier for the deleted permission group.
", + "PermissionGroup$permissionGroupId": "The unique identifier for the permission group.
", + "PermissionGroupParams$permissionGroupId": "The unique identifier for the PermissionGroup.
The unique identifier for the permission group to update.
", + "UpdatePermissionGroupResponse$permissionGroupId": "The unique identifier for the updated permission group.
" + } + }, + "PermissionGroupList": { + "base": null, "refs": { - "PermissionGroupParams$permissionGroupId": "The unique identifier of the PermissionGroup.
" + "ListPermissionGroupsResponse$permissionGroups": "A list of all the permission groups.
" + } + }, + "PermissionGroupName": { + "base": null, + "refs": { + "CreatePermissionGroupRequest$name": "The name of the permission group.
", + "PermissionGroup$name": "The name of the permission group.
", + "UpdatePermissionGroupRequest$name": "The name of the permission group.
" } }, "PermissionGroupParams": { @@ -510,13 +697,23 @@ "DatasetOwnerInfo$phoneNumber": "Phone number for the Dataset owner.
" } }, + "ResetUserPasswordRequest": { + "base": null, + "refs": { + } + }, + "ResetUserPasswordResponse": { + "base": null, + "refs": { + } + }, "ResourceNotFoundException": { "base": "One or more resources can't be found.
", "refs": { } }, "ResourcePermission": { - "base": "Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.
The following is a list of valid dataset permissions that you can apply:
ViewDatasetDetails
ReadDatasetDetails
AddDatasetData
CreateSnapshot
EditDatasetMetadata
DeleteDataset
For more information on the ataset permissions, see Supported Dataset Permissions in the FinSpace User Guide.
", + "base": "Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.
The following is a list of valid dataset permissions that you can apply:
ViewDatasetDetails
ReadDatasetDetails
AddDatasetData
CreateSnapshot
EditDatasetMetadata
DeleteDataset
For more information on the dataset permissions, see Supported Dataset Permissions in the FinSpace User Guide.
", "refs": { "ResourcePermissionsList$member": null } @@ -532,7 +729,18 @@ "refs": { "ListChangesetsRequest$maxResults": "The maximum number of results per page.
", "ListDataViewsRequest$maxResults": "The maximum number of results per page.
", - "ListDatasetsRequest$maxResults": "The maximum number of results per page.
" + "ListDatasetsRequest$maxResults": "The maximum number of results per page.
", + "ListPermissionGroupsRequest$maxResults": "The maximum number of results per page.
", + "ListUsersRequest$maxResults": "The maximum number of results per page.
" + } + }, + "RoleArn": { + "base": null, + "refs": { + "CreateUserRequest$apiAccessPrincipalArn": "The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
Options that define the location of the data being ingested.
", - "CreateChangesetRequest$sourceParams": "Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).
Both s3SourcePath and sourceType are required attributes.
Here is an example of how you could specify the sourceParams:
\"sourceParams\": { \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\", \"sourceType\": \"S3\" }
The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace APIsection.
", + "CreateChangesetRequest$sourceParams": "Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).
Both s3SourcePath and sourceType are required attributes.
Here is an example of how you could specify the sourceParams:
\"sourceParams\": { \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\", \"sourceType\": \"S3\" }
The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace API section.
", "GetChangesetResponse$sourceParams": "Options that define the location of the data being ingested.
", "UpdateChangesetRequest$sourceParams": "Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).
Both s3SourcePath and sourceType are required attributes.
Here is an example of how you could specify the sourceParams:
\"sourceParams\": { \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\", \"sourceType\": \"S3\" }
The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace APIsection.
" } @@ -618,23 +826,35 @@ "TimestampEpoch": { "base": "Milliseconds since UTC epoch", "refs": { - "ChangesetSummary$createTime": "The timestamp at which the Changeset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "ChangesetSummary$activeUntilTimestamp": "Time until which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "ChangesetSummary$activeFromTimestamp": "Beginning time from which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "CreateDataViewRequest$asOfTimestamp": "Beginning time to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "DataViewSummary$asOfTimestamp": "Time range to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "DataViewSummary$createTime": "The timestamp at which the Dataview was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "DataViewSummary$lastModifiedTime": "The last time that a Dataview was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "Dataset$createTime": "The timestamp at which the Dataset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "Dataset$lastModifiedTime": "The last time that the Dataset was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "GetChangesetResponse$createTime": "The timestamp at which the Changeset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "GetChangesetResponse$activeUntilTimestamp": "Time until which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "GetChangesetResponse$activeFromTimestamp": "Beginning time from which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "GetDataViewResponse$asOfTimestamp": "Time range to use for the Dataview. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "GetDataViewResponse$lastModifiedTime": "The last time that a Dataview was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "GetDataViewResponse$createTime": "The timestamp at which the Dataview was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "GetDatasetResponse$createTime": "The timestamp at which the Dataset was created in FinSpace. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", - "GetDatasetResponse$lastModifiedTime": "The last time that the Dataset was modified. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" + "ChangesetSummary$createTime": "The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "ChangesetSummary$activeUntilTimestamp": "Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "ChangesetSummary$activeFromTimestamp": "Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "CreateDataViewRequest$asOfTimestamp": "Beginning time to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "DataViewSummary$asOfTimestamp": "Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "DataViewSummary$createTime": "The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "DataViewSummary$lastModifiedTime": "The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "Dataset$createTime": "The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "Dataset$lastModifiedTime": "The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "GetChangesetResponse$createTime": "The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "GetChangesetResponse$activeUntilTimestamp": "Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "GetChangesetResponse$activeFromTimestamp": "Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "GetDataViewResponse$asOfTimestamp": "Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "GetDataViewResponse$lastModifiedTime": "The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "GetDataViewResponse$createTime": "The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "GetDatasetResponse$createTime": "The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "GetDatasetResponse$lastModifiedTime": "The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
", + "GetUserResponse$createTime": "The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
", + "GetUserResponse$lastEnabledTime": "Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
", + "GetUserResponse$lastDisabledTime": "Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
", + "GetUserResponse$lastModifiedTime": "Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
", + "GetUserResponse$lastLoginTime": "Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
", + "PermissionGroup$createTime": "The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
", + "PermissionGroup$lastModifiedTime": "Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
", + "User$createTime": "The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
", + "User$lastEnabledTime": "Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
", + "User$lastDisabledTime": "Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
", + "User$lastModifiedTime": "Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
", + "User$lastLoginTime": "Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
" } }, "UpdateChangesetRequest": { @@ -657,6 +877,71 @@ "refs": { } }, + "UpdatePermissionGroupRequest": { + "base": null, + "refs": { + } + }, + "UpdatePermissionGroupResponse": { + "base": null, + "refs": { + } + }, + "UpdateUserRequest": { + "base": null, + "refs": { + } + }, + "UpdateUserResponse": { + "base": null, + "refs": { + } + }, + "User": { + "base": "The details of the user account.
", + "refs": { + "UserList$member": null + } + }, + "UserId": { + "base": null, + "refs": { + "CreateUserResponse$userId": "The unique identifier for the user.
", + "DisableUserRequest$userId": "The unique identifier for the user account that you want to disable.
", + "DisableUserResponse$userId": "The unique identifier for the disabled user account.
", + "EnableUserRequest$userId": "The unique identifier for the user account that you want to enable.
", + "EnableUserResponse$userId": "The unique identifier for the enabled user account.
", + "GetUserRequest$userId": "The unique identifier of the user to get data for.
", + "GetUserResponse$userId": "The unique identifier for the user account that is retrieved.
", + "ResetUserPasswordRequest$userId": "The unique identifier of the user that a temporary password is requested for.
", + "ResetUserPasswordResponse$userId": "The unique identifier of the user that a new password is generated for.
", + "UpdateUserRequest$userId": "The unique identifier for the user account to update.
", + "UpdateUserResponse$userId": "The unique identifier of the updated user account.
", + "User$userId": "The unique identifier for the user.
" + } + }, + "UserList": { + "base": null, + "refs": { + "ListUsersResponse$users": "A list of all the user accounts.
" + } + }, + "UserStatus": { + "base": null, + "refs": { + "GetUserResponse$status": "The current status of the user account.
CREATING – The user account creation is in progress.
ENABLED – The user account is created and is currently active.
DISABLED – The user account is currently inactive.
The current status of the user account.
CREATING – The user account creation is in progress.
ENABLED – The user account is created and is currently active.
DISABLED – The user account is currently inactive.
The option to indicate the type of user. Use one of the following options to specify this parameter:
SUPER_USER – A user with permission to all the functionality and data in FinSpace.
APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
Indicates the type of user.
SUPER_USER – A user with permission to all the functionality and data in FinSpace.
APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permissions group.
The option to indicate the type of user.
SUPER_USER– A user with permission to all the functionality and data in FinSpace.
APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permissions group.
Indicates the type of user.
SUPER_USER – A user with permission to all the functionality and data in FinSpace.
APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permissions group.
The input fails to satisfy the constraints specified by an AWS service.
", "refs": { @@ -667,16 +952,19 @@ "refs": { "AccessDeniedException$message": null, "ConflictException$message": null, + "ConflictException$reason": null, "InternalServerException$message": null, "LimitExceededException$message": null, "ResourceNotFoundException$message": null, - "ValidationException$message": null + "ResourceNotFoundException$reason": null, + "ValidationException$message": null, + "ValidationException$reason": null } }, "locationType": { "base": null, "refs": { - "GetWorkingLocationRequest$locationType": "Specify the type of the working location.
SAGEMAKER - Use the Amazon S3 location as a temporary location to store data content when working with FinSpace Notebooks that run on SageMaker studio.
INGESTION - Use the Amazon S3 location as a staging location to copy your data content and then use the location with the Changeset creation operation.
Specify the type of the working location.
SAGEMAKER – Use the Amazon S3 location as a temporary location to store data content when working with FinSpace Notebooks that run on SageMaker studio.
INGESTION – Use the Amazon S3 location as a staging location to copy your data content and then use the location with the Changeset creation operation.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" } }, + "CloudWatchLogGroupArn": { + "base": null, + "refs": { + "ExperimentCloudWatchLogsLogConfiguration$logGroupArn": "The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
", + "ExperimentTemplateCloudWatchLogsLogConfiguration$logGroupArn": "The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
", + "ExperimentTemplateCloudWatchLogsLogConfigurationInput$logGroupArn": "The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs log group.
" + } + }, "ConflictException": { "base": "The request could not be processed because of a conflict.
", "refs": { @@ -130,6 +138,12 @@ "CreateExperimentTemplateRequest$actions": "The actions for the experiment.
" } }, + "CreateExperimentTemplateLogConfigurationInput": { + "base": "Specifies the configuration for experiment logging.
", + "refs": { + "CreateExperimentTemplateRequest$logConfiguration": "The configuration for experiment logging.
" + } + }, "CreateExperimentTemplateRequest": { "base": null, "refs": { @@ -296,6 +310,12 @@ "ExperimentActionTargetMap$key": null } }, + "ExperimentCloudWatchLogsLogConfiguration": { + "base": "Describes the configuration for experiment logging to Amazon CloudWatch Logs.
", + "refs": { + "ExperimentLogConfiguration$cloudWatchLogsConfiguration": "The configuration for experiment logging to Amazon CloudWatch Logs.
" + } + }, "ExperimentEndTime": { "base": null, "refs": { @@ -311,6 +331,18 @@ "StopExperimentRequest$id": "The ID of the experiment.
" } }, + "ExperimentLogConfiguration": { + "base": "Describes the configuration for experiment logging.
", + "refs": { + "Experiment$logConfiguration": "The configuration for experiment logging.
" + } + }, + "ExperimentS3LogConfiguration": { + "base": "Describes the configuration for experiment logging to Amazon S3.
", + "refs": { + "ExperimentLogConfiguration$s3Configuration": "The configuration for experiment logging to Amazon S3.
" + } + }, "ExperimentStartTime": { "base": null, "refs": { @@ -518,6 +550,19 @@ "ExperimentTemplateActionTargetMap$key": null } }, + "ExperimentTemplateCloudWatchLogsLogConfiguration": { + "base": "Describes the configuration for experiment logging to Amazon CloudWatch Logs.
", + "refs": { + "ExperimentTemplateLogConfiguration$cloudWatchLogsConfiguration": "The configuration for experiment logging to Amazon CloudWatch Logs.
" + } + }, + "ExperimentTemplateCloudWatchLogsLogConfigurationInput": { + "base": "Specifies the configuration for experiment logging to Amazon CloudWatch Logs.
", + "refs": { + "CreateExperimentTemplateLogConfigurationInput$cloudWatchLogsConfiguration": "The configuration for experiment logging to Amazon CloudWatch Logs.
", + "UpdateExperimentTemplateLogConfigurationInput$cloudWatchLogsConfiguration": "The configuration for experiment logging to Amazon CloudWatch Logs.
" + } + }, "ExperimentTemplateDescription": { "base": null, "refs": { @@ -540,6 +585,25 @@ "UpdateExperimentTemplateRequest$id": "The ID of the experiment template.
" } }, + "ExperimentTemplateLogConfiguration": { + "base": "Describes the configuration for experiment logging.
", + "refs": { + "ExperimentTemplate$logConfiguration": "The configuration for experiment logging.
" + } + }, + "ExperimentTemplateS3LogConfiguration": { + "base": "Describes the configuration for experiment logging to Amazon S3.
", + "refs": { + "ExperimentTemplateLogConfiguration$s3Configuration": "The configuration for experiment logging to Amazon S3.
" + } + }, + "ExperimentTemplateS3LogConfigurationInput": { + "base": "Specifies the configuration for experiment logging to Amazon S3.
", + "refs": { + "CreateExperimentTemplateLogConfigurationInput$s3Configuration": "The configuration for experiment logging to Amazon S3.
", + "UpdateExperimentTemplateLogConfigurationInput$s3Configuration": "The configuration for experiment logging to Amazon S3.
" + } + }, "ExperimentTemplateStopCondition": { "base": "Describes a stop condition for an experiment template.
", "refs": { @@ -779,6 +843,15 @@ "refs": { } }, + "LogSchemaVersion": { + "base": null, + "refs": { + "CreateExperimentTemplateLogConfigurationInput$logSchemaVersion": "The schema version.
", + "ExperimentLogConfiguration$logSchemaVersion": "The schema version.
", + "ExperimentTemplateLogConfiguration$logSchemaVersion": "The schema version.
", + "UpdateExperimentTemplateLogConfigurationInput$logSchemaVersion": "The schema version.
" + } + }, "NextToken": { "base": null, "refs": { @@ -824,6 +897,22 @@ "UpdateExperimentTemplateRequest$roleArn": "The Amazon Resource Name (ARN) of an IAM role that grants the FIS service permission to perform service actions on your behalf.
" } }, + "S3BucketName": { + "base": null, + "refs": { + "ExperimentS3LogConfiguration$bucketName": "The name of the destination bucket.
", + "ExperimentTemplateS3LogConfiguration$bucketName": "The name of the destination bucket.
", + "ExperimentTemplateS3LogConfigurationInput$bucketName": "The name of the destination bucket.
" + } + }, + "S3ObjectKey": { + "base": null, + "refs": { + "ExperimentS3LogConfiguration$prefix": "The bucket prefix.
", + "ExperimentTemplateS3LogConfiguration$prefix": "The bucket prefix.
", + "ExperimentTemplateS3LogConfigurationInput$prefix": "The bucket prefix.
" + } + }, "ServiceQuotaExceededException": { "base": "You have exceeded your service quota.
", "refs": { @@ -1005,6 +1094,12 @@ "UpdateExperimentTemplateRequest$actions": "The actions for the experiment.
" } }, + "UpdateExperimentTemplateLogConfigurationInput": { + "base": "Specifies the configuration for experiment logging.
", + "refs": { + "UpdateExperimentTemplateRequest$logConfiguration": "The configuration for experiment logging.
" + } + }, "UpdateExperimentTemplateRequest": { "base": null, "refs": { diff --git a/models/apis/fsx/2018-03-01/api-2.json b/models/apis/fsx/2018-03-01/api-2.json index 2fef76a53e5..9dd1cf0b9a2 100644 --- a/models/apis/fsx/2018-03-01/api-2.json +++ b/models/apis/fsx/2018-03-01/api-2.json @@ -1201,8 +1201,9 @@ "required":["ParentVolumeId"], "members":{ "ParentVolumeId":{"shape":"VolumeId"}, - "StorageCapacityReservationGiB":{"shape":"IntegerNoMax"}, - "StorageCapacityQuotaGiB":{"shape":"IntegerNoMax"}, + "StorageCapacityReservationGiB":{"shape":"IntegerNoMaxFromNegativeOne"}, + "StorageCapacityQuotaGiB":{"shape":"IntegerNoMaxFromNegativeOne"}, + "RecordSizeKiB":{"shape":"IntegerRecordSizeKiB"}, "DataCompressionType":{"shape":"OpenZFSDataCompressionType"}, "CopyTagsToSnapshots":{"shape":"Flag"}, "OriginSnapshot":{"shape":"CreateOpenZFSOriginSnapshotConfiguration"}, @@ -1587,9 +1588,19 @@ "type":"structure", "members":{ "SkipFinalBackup":{"shape":"Flag"}, - "FinalBackupTags":{"shape":"Tags"} + "FinalBackupTags":{"shape":"Tags"}, + "Options":{"shape":"DeleteFileSystemOpenZFSOptions"} } }, + "DeleteFileSystemOpenZFSOption":{ + "type":"string", + "enum":["DELETE_CHILD_VOLUMES_AND_SNAPSHOTS"] + }, + "DeleteFileSystemOpenZFSOptions":{ + "type":"list", + "member":{"shape":"DeleteFileSystemOpenZFSOption"}, + "max":1 + }, "DeleteFileSystemOpenZFSResponse":{ "type":"structure", "members":{ @@ -2121,6 +2132,16 @@ "max":2147483647, "min":0 }, + "IntegerNoMaxFromNegativeOne":{ + "type":"integer", + "max":2147483647, + "min":-1 + }, + "IntegerRecordSizeKiB":{ + "type":"integer", + "max":1024, + "min":4 + }, "InternalServerError":{ "type":"structure", "members":{ @@ -2448,6 +2469,7 @@ "OpenZFSCreateRootVolumeConfiguration":{ "type":"structure", "members":{ + "RecordSizeKiB":{"shape":"IntegerRecordSizeKiB"}, "DataCompressionType":{"shape":"OpenZFSDataCompressionType"}, "NfsExports":{"shape":"OpenZFSNfsExports"}, "UserAndGroupQuotas":{"shape":"OpenZFSUserAndGroupQuotas"}, @@ -2459,7 +2481,8 @@ "type":"string", "enum":[ "NONE", - "ZSTD" + "ZSTD", + "LZ4" ] }, "OpenZFSDeploymentType":{ @@ -2543,6 +2566,7 @@ "VolumePath":{"shape":"VolumePath"}, "StorageCapacityReservationGiB":{"shape":"IntegerNoMax"}, "StorageCapacityQuotaGiB":{"shape":"IntegerNoMax"}, + "RecordSizeKiB":{"shape":"IntegerRecordSizeKiB"}, "DataCompressionType":{"shape":"OpenZFSDataCompressionType"}, "CopyTagsToSnapshots":{"shape":"Flag"}, "OriginSnapshot":{"shape":"OpenZFSOriginSnapshotConfiguration"}, @@ -2774,6 +2798,7 @@ "VolumeId":{"shape":"VolumeId"}, "CreationTime":{"shape":"CreationTime"}, "Lifecycle":{"shape":"SnapshotLifecycle"}, + "LifecycleTransitionReason":{"shape":"LifecycleTransitionReason"}, "Tags":{"shape":"Tags"}, "AdministrativeActions":{"shape":"AdministrativeActions"} } @@ -3225,8 +3250,9 @@ "UpdateOpenZFSVolumeConfiguration":{ "type":"structure", "members":{ - "StorageCapacityReservationGiB":{"shape":"IntegerNoMax"}, - "StorageCapacityQuotaGiB":{"shape":"IntegerNoMax"}, + "StorageCapacityReservationGiB":{"shape":"IntegerNoMaxFromNegativeOne"}, + "StorageCapacityQuotaGiB":{"shape":"IntegerNoMaxFromNegativeOne"}, + "RecordSizeKiB":{"shape":"IntegerRecordSizeKiB"}, "DataCompressionType":{"shape":"OpenZFSDataCompressionType"}, "NfsExports":{"shape":"OpenZFSNfsExports"}, "UserAndGroupQuotas":{"shape":"OpenZFSUserAndGroupQuotas"}, diff --git a/models/apis/fsx/2018-03-01/docs-2.json b/models/apis/fsx/2018-03-01/docs-2.json index 66ccd500efb..91cc53b6a77 100644 --- a/models/apis/fsx/2018-03-01/docs-2.json +++ b/models/apis/fsx/2018-03-01/docs-2.json @@ -9,15 +9,15 @@ "CreateDataRepositoryAssociation": "Creates an Amazon FSx for Lustre data repository association (DRA). A data repository association is a link between a directory on the file system and an Amazon S3 bucket or prefix. You can have a maximum of 8 data repository associations on a file system. Data repository associations are supported only for file systems with the Persistent_2 deployment type.
Each data repository association must have a unique Amazon FSx file system directory and a unique S3 bucket or prefix associated with it. You can configure a data repository association for automatic import only, for automatic export only, or for both. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.
", "CreateDataRepositoryTask": "Creates an Amazon FSx for Lustre data repository task. You use data repository tasks to perform bulk operations between your Amazon FSx file system and its linked data repositories. An example of a data repository task is exporting any data and metadata changes, including POSIX metadata, to files, directories, and symbolic links (symlinks) from your FSx file system to a linked data repository. A CreateDataRepositoryTask operation will fail if a data repository is not linked to the FSx file system. To learn more about data repository tasks, see Data Repository Tasks. To learn more about linking a data repository to your file system, see Linking your file system to an S3 bucket.
Creates a new, empty Amazon FSx file system. You can create the following supported Amazon FSx file systems using the CreateFileSystem API operation:
Amazon FSx for Lustre
Amazon FSx for NetApp ONTAP
Amazon FSx for OpenZFS
Amazon FSx for Windows File Server
This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.
If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system with the specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:
Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system.
This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport-level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same.
The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.
If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a client request token with the specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:
Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system.
Parameters like the Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.
By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same.
The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
Creates a snapshot of an existing Amazon FSx for OpenZFS file system. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.
If a snapshot with the specified client request token exists, and the parameters match, this operation returns the description of the existing snapshot. If a snapshot with the specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a snapshot with the specified client request token doesn't exist, CreateSnapshot does the following:
Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the snapshot.
By using the idempotent operation, you can retry a CreateSnapshot operation without the risk of creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear whether a snapshot was created. If you use the same client request token and the initial call created a snapshot, the operation returns a successful result because all the parameters are the same.
The CreateSnapshot operation returns while the snapshot's lifecycle state is still CREATING. You can check the snapshot creation status by calling the DescribeSnapshots operation, which returns the snapshot state along with other information.
Creates a new Amazon FSx for Lustre, Amazon FSx for Windows File Server, or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup.
If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a file system with the specified client request token exists but the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:
Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the file system.
Parameters like the Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.
By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives a success message as long as the parameters are the same.
The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.
Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.
If a snapshot with the specified client request token exists, and the parameters match, this operation returns the description of the existing snapshot. If a snapshot with the specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a snapshot with the specified client request token doesn't exist, CreateSnapshot does the following:
Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of CREATING.
Returns the description of the snapshot.
By using the idempotent operation, you can retry a CreateSnapshot operation without the risk of creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear whether a snapshot was created. If you use the same client request token and the initial call created a snapshot, the operation returns a successful result because all the parameters are the same.
The CreateSnapshot operation returns while the snapshot's lifecycle state is still CREATING. You can check the snapshot creation status by calling the DescribeSnapshots operation, which returns the snapshot state along with other information.
Creates a storage virtual machine (SVM) for an Amazon FSx for ONTAP file system.
", "CreateVolume": "Creates an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS storage volume.
", "CreateVolumeFromBackup": "Creates a new Amazon FSx for NetApp ONTAP volume from an existing Amazon FSx volume backup.
", "DeleteBackup": "Deletes an Amazon FSx backup. After deletion, the backup no longer exists, and its data is gone.
The DeleteBackup call returns instantly. The backup won't show up in later DescribeBackups calls.
The data in a deleted backup is also deleted and can't be recovered by any means.
Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported only for file systems with the Persistent_2 deployment type.
Deletes a file system. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups and snapshots are also deleted.
To delete an Amazon FSx for NetApp ONTAP file system, first delete all the volumes and storage virtual machines (SVMs) on the file system. Then provide a FileSystemId value to the DeleFileSystem operation.
By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup isn't subject to the file system's retention policy, and must be manually deleted.
The DeleteFileSystem operation returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems operation returns a FileSystemNotFound error.
If a data repository task is in a PENDING or EXECUTING state, deleting an Amazon FSx for Lustre file system will fail with an HTTP status code 400 (Bad Request).
The data in a deleted file system is also deleted and can't be recovered by any means.
Deletes the Amazon FSx snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup.
The DeleteSnapshot operation returns instantly. The snapshot appears with the lifecycle status of DELETING until the deletion is complete.
Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot no longer exists, and its data is gone. Deleting a snapshot doesn't affect snapshots stored in a file system backup.
The DeleteSnapshot operation returns instantly. The snapshot appears with the lifecycle status of DELETING until the deletion is complete.
Deletes an existing Amazon FSx for ONTAP storage virtual machine (SVM). Prior to deleting an SVM, you must delete all non-root volumes in the SVM, otherwise the operation will fail.
", "DeleteVolume": "Deletes an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
", "DescribeBackups": "Returns the description of a specific Amazon FSx backup, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of the NextToken value from the last response.
This operation is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of backup descriptions while still including a NextToken value.
The order of the backups returned in the response of one DescribeBackups call and the order of the backups returned across the responses of a multi-call iteration is unspecified.
Returns the description of specific Amazon FSx for Lustre data repository tasks, if one or more TaskIds values are provided in the request, or if filters are used in the request. You can use filters to narrow the response to include just tasks for specific file systems, or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all tasks, you can paginate the response by using the optional MaxResults parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction provided in the DescribeFileSystems operation response.
", "DescribeFileSystems": "Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
This operation is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.
When using this operation, keep the following in mind:
The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.
The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.
Returns the description of specific Amazon FSx snapshots, if a SnapshotIds value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the number of snapshots in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of snapshot descriptions while still including a NextToken value.
The order of snapshots returned in the response of one DescribeSnapshots call and the order of backups returned across the responses of a multi-call iteration is unspecified.
Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the number of snapshots in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.
Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots is called first without a NextToken value. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken value.
When using this operation, keep the following in mind:
The operation might return fewer than the MaxResults value of snapshot descriptions while still including a NextToken value.
The order of snapshots returned in the response of one DescribeSnapshots call and the order of backups returned across the responses of a multi-call iteration is unspecified.
Describes one or more Amazon FSx for NetApp ONTAP storage virtual machines (SVMs).
", "DescribeVolumes": "Describes one or more Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volumes.
", "DisassociateFileSystemAliases": "Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not associated with the file system, Amazon FSx responds with a 400 Bad Request. For more information, see Working with DNS Aliases.
The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. Use the API operation to monitor the status of the aliases Amazon FSx is disassociating with the file system.
", @@ -36,7 +36,7 @@ "UntagResource": "This action removes a tag from an Amazon FSx resource.
", "UpdateDataRepositoryAssociation": "Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported only for file systems with the Persistent_2 deployment type.
Use this operation to update the configuration of an existing Amazon FSx file system. You can update multiple properties in a single request.
For Amazon FSx for Windows File Server file systems, you can update the following properties:
AuditLogConfiguration
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
SelfManagedActiveDirectoryConfiguration
StorageCapacity
ThroughputCapacity
WeeklyMaintenanceStartTime
For Amazon FSx for Lustre file systems, you can update the following properties:
AutoImportPolicy
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DataCompressionType
StorageCapacity
WeeklyMaintenanceStartTime
For Amazon FSx for NetApp ONTAP file systems, you can update the following properties:
AutomaticBackupRetentionDays
DailyAutomaticBackupStartTime
DiskIopsConfiguration
FsxAdminPassword
StorageCapacity
WeeklyMaintenanceStartTime
For the Amazon FSx for OpenZFS file systems, you can update the following properties:
AutomaticBackupRetentionDays
CopyTagsToBackups
CopyTagsToVolumes
DailyAutomaticBackupStartTime
ThroughputCapacity
WeeklyMaintenanceStartTime
Updates the name of a snapshot.
", + "UpdateSnapshot": "Updates the name of an Amazon FSx for OpenZFS snapshot.
", "UpdateStorageVirtualMachine": "Updates an Amazon FSx for ONTAP storage virtual machine (SVM).
", "UpdateVolume": "Updates the configuration of an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS volume.
" }, @@ -410,7 +410,7 @@ } }, "CreateFileSystemOpenZFSConfiguration": { - "base": "The OpenZFS configuration properties for the file system that you are creating.
", + "base": "The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
", "refs": { "CreateFileSystemFromBackupRequest$OpenZFSConfiguration": "The OpenZFS configuration for the file system that's being created.
", "CreateFileSystemRequest$OpenZFSConfiguration": "The OpenZFS configuration for the file system that's being created.
" @@ -447,7 +447,7 @@ } }, "CreateOpenZFSVolumeConfiguration": { - "base": "Specifies the configuration of the OpenZFS volume that you are creating.
", + "base": "Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.
", "refs": { "CreateVolumeRequest$OpenZFSConfiguration": "Specifies the configuration to use when creating the OpenZFS volume.
" } @@ -737,11 +737,23 @@ } }, "DeleteFileSystemOpenZFSConfiguration": { - "base": "The configuration object for the OpenZFS file system used in the DeleteFileSystem operation.
The configuration object for the Amazon FSx for OpenZFS file system used in the DeleteFileSystem operation.
The configuration object for the OpenZFS file system used in the DeleteFileSystem operation.
To delete a file system if there are child volumes present below the root volume, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. If your file system has child volumes and you don't use this option, the delete request will fail.
The response object for the Amazon FSx for OpenZFS file system that's being deleted in the DeleteFileSystem operation.
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
", "CreateOntapVolumeConfiguration$StorageEfficiencyEnabled": "Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume.
", - "CreateOpenZFSVolumeConfiguration$CopyTagsToSnapshots": "A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
Set SkipFinalBackup to false if you want to take a final backup of the file system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the DeleteFileSystem operation is invoked. (Default = true)
The fsx:CreateBackup permission is required if you set SkipFinalBackup to false in order to delete the file system and take a final backup.
By default, Amazon FSx for OpenZFS takes a final backup on your behalf when the DeleteFileSystem operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip this backup, use this value to do so.
By default, Amazon FSx for OpenZFS takes a final backup on your behalf when the DeleteFileSystem operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip taking a final backup, set this value to true.
By default, Amazon FSx for Windows takes a final backup on your behalf when the DeleteFileSystem operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip this backup, use this flag to do so.
Set to true if you want to skip taking a final backup of the volume you are deleting.
", "LustreFileSystemConfiguration$CopyTagsToBackups": "A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)
", "OntapVolumeConfiguration$StorageEfficiencyEnabled": "The volume's storage efficiency setting.
", "OntapVolumeConfiguration$StorageVirtualMachineRoot": "A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume.
This flag is useful when you're deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
Default is false. Set to true to enable the deduplication, compression, and compaction storage efficiency features on the volume.
A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
" } @@ -1244,14 +1256,28 @@ "IntegerNoMax": { "base": null, "refs": { - "CreateOpenZFSVolumeConfiguration$StorageCapacityReservationGiB": "The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
", - "CreateOpenZFSVolumeConfiguration$StorageCapacityQuotaGiB": "The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
", "OpenZFSUserOrGroupQuota$Id": "The ID of the user or group.
", "OpenZFSUserOrGroupQuota$StorageCapacityQuotaGiB": "The amount of storage that the user or group can use in gibibytes (GiB).
", "OpenZFSVolumeConfiguration$StorageCapacityReservationGiB": "The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
", - "OpenZFSVolumeConfiguration$StorageCapacityQuotaGiB": "The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
", - "UpdateOpenZFSVolumeConfiguration$StorageCapacityReservationGiB": "The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
", - "UpdateOpenZFSVolumeConfiguration$StorageCapacityQuotaGiB": "The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
" + "OpenZFSVolumeConfiguration$StorageCapacityQuotaGiB": "The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
" + } + }, + "IntegerNoMaxFromNegativeOne": { + "base": null, + "refs": { + "CreateOpenZFSVolumeConfiguration$StorageCapacityReservationGiB": "The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. To not specify a storage capacity reservation, set this to -1.
The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can't specify a quota larger than the storage on the parent volume. To not specify a storage capacity quota, set this to -1.
The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. You can specify a value of -1 to unset a volume's storage capacity reservation.
The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. You can specify a value of -1 to unset a volume's storage capacity quota.
Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on when to set a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.
", + "OpenZFSCreateRootVolumeConfiguration$RecordSizeKiB": "Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.
", + "OpenZFSVolumeConfiguration$RecordSizeKiB": "The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.
", + "UpdateOpenZFSVolumeConfiguration$RecordSizeKiB": "Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on when to set a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.
" } }, "InternalServerError": { @@ -1347,6 +1373,7 @@ "LifecycleTransitionReason": { "base": "Describes why a resource lifecycle state changed.
", "refs": { + "Snapshot$LifecycleTransitionReason": null, "StorageVirtualMachine$LifecycleTransitionReason": "Describes why the SVM lifecycle state changed.
", "Volume$LifecycleTransitionReason": "The reason why the volume lifecycle status changed.
" } @@ -1436,8 +1463,8 @@ "CreateFileSystemOpenZFSConfiguration$ThroughputCapacity": "Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. You pay for additional throughput capacity that you provision.
", "CreateFileSystemWindowsConfiguration$ThroughputCapacity": "Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).
", "OntapFileSystemConfiguration$ThroughputCapacity": null, - "OpenZFSFileSystemConfiguration$ThroughputCapacity": "The throughput of an Amazon FSx file system, measured in megabytes per second (MBps), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).
", - "UpdateFileSystemOpenZFSConfiguration$ThroughputCapacity": "The throughput of an Amazon FSx file system, measured in megabytes per second (MBps), in 2 to the nth increments, between 2^3 (8) and 2^12 (4096).
", + "OpenZFSFileSystemConfiguration$ThroughputCapacity": "The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.
", + "UpdateFileSystemOpenZFSConfiguration$ThroughputCapacity": "The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s.
", "UpdateFileSystemWindowsConfiguration$ThroughputCapacity": "Sets the target value for a file system's throughput capacity, in MB/s, that you are updating the file system to. Valid values are 8, 16, 32, 64, 128, 256, 512, 1024, 2048. You cannot make a throughput capacity update request if there is an existing throughput capacity update request in progress. For more information, see Managing Throughput Capacity.
", "WindowsFileSystemConfiguration$ThroughputCapacity": "The throughput of the Amazon FSx file system, measured in megabytes per second.
" } @@ -1553,7 +1580,7 @@ "OpenZFSClients": { "base": null, "refs": { - "OpenZFSClientConfiguration$Clients": "A value that specifies who can mount the file system. You can provide a wildcard character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24. By default, Amazon FSx uses the wildcard character when specifying the client.
A value that specifies who can mount the file system. You can provide a wildcard character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24). By default, Amazon FSx uses the wildcard character when specifying the client.
Specifies the method used to compress the data on the volume. Unless the compression type is specified, volumes inherit the DataCompressionType value of their parent volume.
NONE - Doesn't compress the data on the volume.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.
Specifies the method used to compress the data on the volume. Unless the compression type is specified, volumes inherit the DataCompressionType value of their parent volume.
NONE - Doesn't compress the data on the volume.
ZSTD - Compresses the data in the volume using the ZStandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.
The method used to compress the data on the volume. Unless a compression type is specified, volumes inherit the DataCompressionType value of their parent volume.
NONE - Doesn't compress the data on the volume.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.
Specifies the method used to compress the data on the volume. Unless the compression type is specified, volumes inherit the DataCompressionType value of their parent volume.
NONE - Doesn't compress the data on the volume.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.
Specifies the method used to compress the data on the volume. The compression type is NONE by default.
NONE - Doesn't compress the data on the volume. NONE is the default.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
Specifies the method used to compress the data on the volume. The compression type is NONE by default.
NONE - Doesn't compress the data on the volume. NONE is the default.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
Specifies the method used to compress the data on the volume. The compression type is NONE by default.
NONE - Doesn't compress the data on the volume. NONE is the default.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
Specifies the method used to compress the data on the volume. The compression type is NONE by default.
NONE - Doesn't compress the data on the volume. NONE is the default.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following:
crossmount is used by default. If you don't specify crossmount when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.
sync is used by default. If you instead specify async, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.
The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page. When choosing your options, consider the following:
crossmnt is used by default. If you don't specify crossmnt when changing the client configuration, you won't be able to see or access snapshots in your file system's snapshot directory.
sync is used by default. If you instead specify async, the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.
The configuration object for mounting a Network File System (NFS) file system.
", + "CreateOpenZFSVolumeConfiguration$NfsExports": "The configuration object for mounting a Network File System (NFS) file system.
", "OpenZFSCreateRootVolumeConfiguration$NfsExports": "The configuration object for mounting a file system.
", "OpenZFSVolumeConfiguration$NfsExports": "The configuration object for mounting a Network File System (NFS) file system.
", "UpdateOpenZFSVolumeConfiguration$NfsExports": "The configuration object for mounting a Network File System (NFS) file system.
" @@ -1633,9 +1660,9 @@ "OpenZFSUserAndGroupQuotas": { "base": null, "refs": { - "CreateOpenZFSVolumeConfiguration$UserAndGroupQuotas": "An object specifying how much storage users or groups can use on the volume.
", + "CreateOpenZFSVolumeConfiguration$UserAndGroupQuotas": "An object specifying how much storage users or groups can use on the volume.
", "OpenZFSCreateRootVolumeConfiguration$UserAndGroupQuotas": "An object specifying how much storage users or groups can use on the volume.
", - "OpenZFSVolumeConfiguration$UserAndGroupQuotas": "An object specifying how much storage users or groups can use on the volume.
", + "OpenZFSVolumeConfiguration$UserAndGroupQuotas": "An object specifying how much storage users or groups can use on the volume.
", "UpdateOpenZFSVolumeConfiguration$UserAndGroupQuotas": "An object specifying how much storage users or groups can use on the volume.
" } }, @@ -1681,7 +1708,7 @@ "ReadOnly": { "base": null, "refs": { - "CreateOpenZFSVolumeConfiguration$ReadOnly": "A Boolean value indicating whether the volume is read-only.
", + "CreateOpenZFSVolumeConfiguration$ReadOnly": "A Boolean value indicating whether the volume is read-only.
", "OpenZFSCreateRootVolumeConfiguration$ReadOnly": "A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.
A Boolean value indicating whether the volume is read-only.
", "UpdateOpenZFSVolumeConfiguration$ReadOnly": "A Boolean value indicating whether the volume is read-only.
" @@ -1925,7 +1952,7 @@ "refs": { "CreateSnapshotRequest$Name": "The name of the snapshot.
", "Snapshot$Name": "The name of the snapshot.
", - "UpdateSnapshotRequest$Name": "The name of the snapshot to update.
" + "UpdateSnapshotRequest$Name": "The name of the snapshot to update.
" } }, "SnapshotNotFound": { @@ -2171,7 +2198,7 @@ "DataRepositoryTask$Tags": null, "DeleteFileSystemLustreConfiguration$FinalBackupTags": "Use if SkipFinalBackup is set to false, and you want to apply an array of tags to the final backup. If you have set the file system property CopyTagsToBackups to true, and you specify one or more FinalBackupTags when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup.
The set of tags applied to the final backup.
", - "DeleteFileSystemOpenZFSConfiguration$FinalBackupTags": null, + "DeleteFileSystemOpenZFSConfiguration$FinalBackupTags": "A list of tags to apply to the file system's final backup.
", "DeleteFileSystemOpenZFSResponse$FinalBackupTags": null, "DeleteFileSystemWindowsConfiguration$FinalBackupTags": "A set of tags for your final backup.
", "DeleteFileSystemWindowsResponse$FinalBackupTags": "The set of tags applied to the final backup.
", @@ -2387,7 +2414,7 @@ "base": null, "refs": { "CreateBackupRequest$VolumeId": "(Optional) The ID of the FSx for ONTAP volume to back up.
", - "CreateOpenZFSVolumeConfiguration$ParentVolumeId": "The ID of the volume to use as the parent volume.
", + "CreateOpenZFSVolumeConfiguration$ParentVolumeId": "The ID of the volume to use as the parent volume.
", "CreateSnapshotRequest$VolumeId": "The ID of the volume that you are taking a snapshot of.
", "DeleteVolumeRequest$VolumeId": "The ID of the volume that you are deleting.
", "DeleteVolumeResponse$VolumeId": "The ID of the volume that's being deleted.
", @@ -2425,7 +2452,7 @@ } }, "VolumeNotFound": { - "base": "No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied parameters.
", + "base": "No Amazon FSx volumes were found based upon the supplied parameters.
", "refs": { } }, diff --git a/models/apis/route53-recovery-cluster/2019-12-02/api-2.json b/models/apis/route53-recovery-cluster/2019-12-02/api-2.json index 3dcc36cfb37..d005650aa3b 100644 --- a/models/apis/route53-recovery-cluster/2019-12-02/api-2.json +++ b/models/apis/route53-recovery-cluster/2019-12-02/api-2.json @@ -80,7 +80,11 @@ "type":"string", "max":255, "min":1, - "pattern":"^[A-Za-z0-9:\\/_-]*$" + "pattern":"^[A-Za-z0-9:.\\/_-]*$" + }, + "Arns":{ + "type":"list", + "member":{"shape":"Arn"} }, "ConflictException":{ "type":"structure", @@ -187,7 +191,8 @@ ], "members":{ "RoutingControlArn":{"shape":"Arn"}, - "RoutingControlState":{"shape":"RoutingControlState"} + "RoutingControlState":{"shape":"RoutingControlState"}, + "SafetyRulesToOverride":{"shape":"Arns"} } }, "UpdateRoutingControlStateResponse":{ @@ -199,7 +204,8 @@ "type":"structure", "required":["UpdateRoutingControlStateEntries"], "members":{ - "UpdateRoutingControlStateEntries":{"shape":"UpdateRoutingControlStateEntries"} + "UpdateRoutingControlStateEntries":{"shape":"UpdateRoutingControlStateEntries"}, + "SafetyRulesToOverride":{"shape":"Arns"} } }, "UpdateRoutingControlStatesResponse":{ diff --git a/models/apis/route53-recovery-cluster/2019-12-02/docs-2.json b/models/apis/route53-recovery-cluster/2019-12-02/docs-2.json index 11c166d3400..025b2e5a0de 100644 --- a/models/apis/route53-recovery-cluster/2019-12-02/docs-2.json +++ b/models/apis/route53-recovery-cluster/2019-12-02/docs-2.json @@ -1,10 +1,10 @@ { "version": "2.0", - "service": "Welcome to the Amazon Route 53 Application Recovery Controller API Reference Guide for Recovery Control Data Plane .
Recovery control in Route 53 Application Recovery Controller includes extremely reliable routing controls that enable you to recover applications by rerouting traffic, for example, across Availability Zones or AWS Regions. Routing controls are simple on/off switches hosted on a cluster. A cluster is a set of five redundant regional endpoints against which you can execute API calls to update or get the state of routing controls. You use routing controls to failover traffic to recover your application across Availability Zones or Regions.
This API guide includes information about how to get and update routing control states in Route 53 Application Recovery Controller.
For more information about Route 53 Application Recovery Controller, see the following:
You can create clusters, routing controls, and control panels by using the control plane API for Recovery Control. For more information, see Amazon Route 53 Application Recovery Controller Recovery Control API Reference.
Route 53 Application Recovery Controller also provides continuous readiness checks to ensure that your applications are scaled to handle failover traffic. For more information about the related API actions, see Amazon Route 53 Application Recovery Controller Recovery Readiness API Reference.
For more information about creating resilient applications and preparing for recovery readiness with Route 53 Application Recovery Controller, see the Amazon Route 53 Application Recovery Controller Developer Guide.
Welcome to the Routing Control (Recovery Cluster) API Reference Guide for Amazon Route 53 Application Recovery Controller.
With Amazon Route 53 Application Recovery Controller, you can use routing control with extreme reliability to recover applications by rerouting traffic across Availability Zones or AWS Regions. Routing controls are simple on/off switches hosted on a highly available cluster in Application Recovery Controller. A cluster provides a set of five redundant Regional endpoints against which you can run API calls to get or update the state of routing controls. To implement failover, you set one routing control on and another one off, to reroute traffic from one Availability Zone or Amazon Web Services Region to another.
Be aware that you must specify the Regional endpoints for a cluster when you work with API cluster operations to get or update routing control states in Application Recovery Controller. In addition, you must specify the US West (Oregon) Region for Application Recovery Controller API calls. For example, use the parameter region us-west-2 with AWS CLI commands. For more information, see Get and update routing control states using the API in the Amazon Route 53 Application Recovery Controller Developer Guide.
This API guide includes information about the API operations for how to get and update routing control states in Application Recovery Controller. You also must set up the structures to support routing controls: clusters and control panels.
For more information about working with routing control in Application Recovery Controller, see the following:
To create clusters, routing controls, and control panels by using the control plane API for routing control, see the Recovery Control Configuration API Reference Guide for Amazon Route 53 Application Recovery Controller.
Learn about the components in recovery control configuration, including clusters, routing controls, and control panels. For more information, see Recovery control components in the Amazon Route 53 Application Recovery Controller Developer Guide.
Application Recovery Controller also provides readiness checks that run continually to help make sure that your applications are scaled and ready to handle failover traffic. For more information about the related API actions, see the Recovery Readiness API Reference Guide for Amazon Route 53 Application Recovery Controller.
For more information about creating resilient applications and preparing for recovery readiness with Application Recovery Controller, see the Amazon Route 53 Application Recovery Controller Developer Guide.
Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When the state is On, traffic flows to a cell. When it's off, traffic does not flow.
Before you can create a routing control, you first must create a cluster to host the control. For more information, see CreateCluster. Access one of the endpoints for the cluster to get or update the routing control state to redirect traffic.
For more information about working with routing controls, see Routing control in the Route 53 Application Recovery Controller Developer Guide.
", - "UpdateRoutingControlState": "Set the state of the routing control to reroute traffic. You can set the value to be On or Off. When the state is On, traffic flows to a cell. When it's off, traffic does not flow.
For more information about working with routing controls, see Routing control in the Route 53 Application Recovery Controller Developer Guide.
", - "UpdateRoutingControlStates": "Set multiple routing control states. You can set the value for each state to be On or Off. When the state is On, traffic flows to a cell. When it's off, traffic does not flow.
For more information about working with routing controls, see Routing control in the Route 53 Application Recovery Controller Developer Guide.
" + "GetRoutingControlState": "Get the state for a routing control. A routing control is a simple on/off switch that you can use to route traffic to cells. When the state is On, traffic flows to a cell. When it's Off, traffic does not flow.
Before you can create a routing control, you must first create a cluster to host the control in a control panel. For more information, see Create routing control structures in the Amazon Route 53 Application Recovery Controller Developer Guide. Then you access one of the endpoints for the cluster to get or update the routing control state to redirect traffic.
You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Application Recovery Controller.
To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide.
Learn more about working with routing controls in the following topics in the Amazon Route 53 Application Recovery Controller Developer Guide:
", + "UpdateRoutingControlState": "Set the state of the routing control to reroute traffic. You can set the value to be On or Off. When the state is On, traffic flows to a cell. When it's Off, traffic does not flow.
With Application Recovery Controller, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a \"break glass\" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application.
The SafetyRulesToOverride property enables you override one or more safety rules and update routing control states. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.
You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Application Recovery Controller.
To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide.
", + "UpdateRoutingControlStates": "Set multiple routing control states. You can set the value for each state to be On or Off. When the state is On, traffic flows to a cell. When it's Off, traffic does not flow.
With Application Recovery Controller, you can add safety rules for routing controls, which are safeguards for routing control state updates that help prevent unexpected outcomes, like fail open traffic routing. However, there are scenarios when you might want to bypass the routing control safeguards that are enforced with safety rules that you've configured. For example, you might want to fail over quickly for disaster recovery, and one or more safety rules might be unexpectedly preventing you from updating a routing control state to reroute traffic. In a \"break glass\" scenario like this, you can override one or more safety rules to change a routing control state and fail over your application.
The SafetyRulesToOverride property enables you override one or more safety rules and update routing control states. For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.
You must specify Regional endpoints when you work with API cluster operations to get or update routing control states in Application Recovery Controller.
To see a code example for getting a routing control state, including accessing Regional cluster endpoints in sequence, see API examples in the Amazon Route 53 Application Recovery Controller Developer Guide.
" }, "shapes": { "AccessDeniedException": { @@ -15,12 +15,20 @@ "Arn": { "base": null, "refs": { + "Arns$member": null, "GetRoutingControlStateRequest$RoutingControlArn": "The Amazon Resource Number (ARN) for the routing control that you want to get the state for.
", "GetRoutingControlStateResponse$RoutingControlArn": "The Amazon Resource Number (ARN) of the response.
", - "UpdateRoutingControlStateEntry$RoutingControlArn": "The Amazon Resource Number (ARN) for the routing control state entry.
", + "UpdateRoutingControlStateEntry$RoutingControlArn": "The Amazon Resource Number (ARN) for a routing control state entry.
", "UpdateRoutingControlStateRequest$RoutingControlArn": "The Amazon Resource Number (ARN) for the routing control that you want to update the state for.
" } }, + "Arns": { + "base": null, + "refs": { + "UpdateRoutingControlStateRequest$SafetyRulesToOverride": "The Amazon Resource Numbers (ARNs) for the safety rules that you want to override when you're updating the state of a routing control. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas.
For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.
", + "UpdateRoutingControlStatesRequest$SafetyRulesToOverride": "The Amazon Resource Numbers (ARNs) for the safety rules that you want to override when you're updating routing control states. You can override one safety rule or multiple safety rules by including one or more ARNs, separated by commas.
For more information, see Override safety rules to reroute traffic in the Amazon Route 53 Application Recovery Controller Developer Guide.
" + } + }, "ConflictException": { "base": "There was a conflict with this request. Try again.
", "refs": { @@ -96,7 +104,7 @@ } }, "UpdateRoutingControlStateEntry": { - "base": "A routing control state.
", + "base": "A routing control state entry.
", "refs": { "UpdateRoutingControlStateEntries$member": null } diff --git a/models/apis/servicecatalog-appregistry/2020-06-24/api-2.json b/models/apis/servicecatalog-appregistry/2020-06-24/api-2.json index c138c430376..ac7875ec56f 100644 --- a/models/apis/servicecatalog-appregistry/2020-06-24/api-2.json +++ b/models/apis/servicecatalog-appregistry/2020-06-24/api-2.json @@ -1061,7 +1061,11 @@ "location":"uri", "locationName":"application" }, - "name":{"shape":"Name"}, + "name":{ + "shape":"Name", + "deprecated":true, + "deprecatedMessage":"Name update for application is deprecated." + }, "description":{"shape":"Description"} } }, @@ -1080,7 +1084,11 @@ "location":"uri", "locationName":"attributeGroup" }, - "name":{"shape":"Name"}, + "name":{ + "shape":"Name", + "deprecated":true, + "deprecatedMessage":"Name update for attribute group is deprecated." + }, "description":{"shape":"Description"}, "attributes":{"shape":"Attributes"} } diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 32ccdb69a08..3e2e236f017 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -1599,6 +1599,7 @@ }, "braket" : { "endpoints" : { + "eu-west-2" : { }, "us-east-1" : { }, "us-west-1" : { }, "us-west-2" : { } diff --git a/service/amplify/api.go b/service/amplify/api.go index 6964b1e38ed..a3047212e8c 100644 --- a/service/amplify/api.go +++ b/service/amplify/api.go @@ -3355,7 +3355,11 @@ type App struct { // Describes the content of the build specification (build spec) for the Amplify // app. - BuildSpec *string `locationName:"buildSpec" min:"1" type:"string"` + // + // BuildSpec is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by App's + // String and GoString methods. + BuildSpec *string `locationName:"buildSpec" min:"1" type:"string" sensitive:"true"` // Creates a date and time for the Amplify app. // @@ -3363,7 +3367,7 @@ type App struct { CreateTime *time.Time `locationName:"createTime" type:"timestamp" required:"true"` // Describes the custom HTTP headers for the Amplify app. - CustomHeaders *string `locationName:"customHeaders" min:"1" type:"string"` + CustomHeaders *string `locationName:"customHeaders" type:"string"` // Describes the custom redirect and rewrite rules for the Amplify app. CustomRules []*CustomRule `locationName:"customRules" type:"list"` @@ -3402,7 +3406,7 @@ type App struct { // The AWS Identity and Access Management (IAM) service role for the Amazon // Resource Name (ARN) of the Amplify app. - IamServiceRoleArn *string `locationName:"iamServiceRoleArn" min:"1" type:"string"` + IamServiceRoleArn *string `locationName:"iamServiceRoleArn" type:"string"` // The name for the Amplify app. // @@ -3417,13 +3421,19 @@ type App struct { // Describes the information about a production branch of the Amplify app. ProductionBranch *ProductionBranch `locationName:"productionBranch" type:"structure"` - // The repository for the Amplify app. + // The Git repository for the Amplify app. // // Repository is a required field Repository *string `locationName:"repository" type:"string" required:"true"` + // The authentication protocol to use to access the Git repository for an Amplify + // app. For a GitHub repository, specify TOKEN. For an Amazon Web Services CodeCommit + // repository, specify SIGV4. For GitLab and Bitbucket repositories, specify + // SSH. + RepositoryCloneMethod *string `locationName:"repositoryCloneMethod" type:"string" enum:"RepositoryCloneMethod"` + // The tag for the Amplify app. - Tags map[string]*string `locationName:"tags" min:"1" type:"map"` + Tags map[string]*string `locationName:"tags" type:"map"` // Updates the date and time for the Amplify app. // @@ -3575,6 +3585,12 @@ func (s *App) SetRepository(v string) *App { return s } +// SetRepositoryCloneMethod sets the RepositoryCloneMethod field's value. +func (s *App) SetRepositoryCloneMethod(v string) *App { + s.RepositoryCloneMethod = &v + return s +} + // SetTags sets the Tags field's value. func (s *App) SetTags(v map[string]*string) *App { s.Tags = v @@ -3646,7 +3662,11 @@ type AutoBranchCreationConfig struct { BasicAuthCredentials *string `locationName:"basicAuthCredentials" type:"string" sensitive:"true"` // The build specification (build spec) for the autocreated branch. - BuildSpec *string `locationName:"buildSpec" min:"1" type:"string"` + // + // BuildSpec is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by AutoBranchCreationConfig's + // String and GoString methods. + BuildSpec *string `locationName:"buildSpec" min:"1" type:"string" sensitive:"true"` // Enables auto building for the autocreated branch. EnableAutoBuild *bool `locationName:"enableAutoBuild" type:"boolean"` @@ -3776,7 +3796,7 @@ type BackendEnvironment struct { // an Amplify app. // // BackendEnvironmentArn is a required field - BackendEnvironmentArn *string `locationName:"backendEnvironmentArn" min:"1" type:"string" required:"true"` + BackendEnvironmentArn *string `locationName:"backendEnvironmentArn" type:"string" required:"true"` // The creation date and time for a backend environment that is part of an Amplify // app. @@ -3934,7 +3954,7 @@ type Branch struct { // The Amazon Resource Name (ARN) for a backend environment that is part of // an Amplify app. - BackendEnvironmentArn *string `locationName:"backendEnvironmentArn" min:"1" type:"string"` + BackendEnvironmentArn *string `locationName:"backendEnvironmentArn" type:"string"` // The basic authorization credentials for a branch of an Amplify app. You must // base64-encode the authorization credentials and provide them in the format @@ -3957,7 +3977,11 @@ type Branch struct { // The build specification (build spec) content for the branch of an Amplify // app. - BuildSpec *string `locationName:"buildSpec" min:"1" type:"string"` + // + // BuildSpec is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by Branch's + // String and GoString methods. + BuildSpec *string `locationName:"buildSpec" min:"1" type:"string" sensitive:"true"` // The creation date and time for a branch that is part of an Amplify app. // @@ -4031,7 +4055,7 @@ type Branch struct { Stage *string `locationName:"stage" type:"string" required:"true" enum:"Stage"` // The tag for the branch of an Amplify app. - Tags map[string]*string `locationName:"tags" min:"1" type:"map"` + Tags map[string]*string `locationName:"tags" type:"map"` // The thumbnail URL for the branch of an Amplify app. ThumbnailUrl *string `locationName:"thumbnailUrl" min:"1" type:"string"` @@ -4260,10 +4284,14 @@ type CreateAppInput struct { BasicAuthCredentials *string `locationName:"basicAuthCredentials" type:"string" sensitive:"true"` // The build specification (build spec) for an Amplify app. - BuildSpec *string `locationName:"buildSpec" min:"1" type:"string"` + // + // BuildSpec is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateAppInput's + // String and GoString methods. + BuildSpec *string `locationName:"buildSpec" min:"1" type:"string" sensitive:"true"` // The custom HTTP headers for an Amplify app. - CustomHeaders *string `locationName:"customHeaders" min:"1" type:"string"` + CustomHeaders *string `locationName:"customHeaders" type:"string"` // The custom rewrite and redirect rules for an Amplify app. CustomRules []*CustomRule `locationName:"customRules" type:"list"` @@ -4290,7 +4318,7 @@ type CreateAppInput struct { // The AWS Identity and Access Management (IAM) service role for an Amplify // app. - IamServiceRoleArn *string `locationName:"iamServiceRoleArn" min:"1" type:"string"` + IamServiceRoleArn *string `locationName:"iamServiceRoleArn" type:"string"` // The name for an Amplify app. // @@ -4313,7 +4341,7 @@ type CreateAppInput struct { Repository *string `locationName:"repository" type:"string"` // The tag for an Amplify app. - Tags map[string]*string `locationName:"tags" min:"1" type:"map"` + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation. @@ -4343,21 +4371,12 @@ func (s *CreateAppInput) Validate() error { if s.BuildSpec != nil && len(*s.BuildSpec) < 1 { invalidParams.Add(request.NewErrParamMinLen("BuildSpec", 1)) } - if s.CustomHeaders != nil && len(*s.CustomHeaders) < 1 { - invalidParams.Add(request.NewErrParamMinLen("CustomHeaders", 1)) - } - if s.IamServiceRoleArn != nil && len(*s.IamServiceRoleArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("IamServiceRoleArn", 1)) - } if s.Name == nil { invalidParams.Add(request.NewErrParamRequired("Name")) } if s.Name != nil && len(*s.Name) < 1 { invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } - if s.Tags != nil && len(s.Tags) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) - } if s.AutoBranchCreationConfig != nil { if err := s.AutoBranchCreationConfig.Validate(); err != nil { invalidParams.AddNested("AutoBranchCreationConfig", err.(request.ErrInvalidParams)) @@ -4664,7 +4683,7 @@ type CreateBranchInput struct { // The Amazon Resource Name (ARN) for a backend environment that is part of // an Amplify app. - BackendEnvironmentArn *string `locationName:"backendEnvironmentArn" min:"1" type:"string"` + BackendEnvironmentArn *string `locationName:"backendEnvironmentArn" type:"string"` // The basic authorization credentials for the branch. You must base64-encode // the authorization credentials and provide them in the format user:password. @@ -4680,7 +4699,11 @@ type CreateBranchInput struct { BranchName *string `locationName:"branchName" min:"1" type:"string" required:"true"` // The build specification (build spec) for the branch. - BuildSpec *string `locationName:"buildSpec" min:"1" type:"string"` + // + // BuildSpec is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateBranchInput's + // String and GoString methods. + BuildSpec *string `locationName:"buildSpec" min:"1" type:"string" sensitive:"true"` // The description for the branch. Description *string `locationName:"description" type:"string"` @@ -4720,7 +4743,7 @@ type CreateBranchInput struct { Stage *string `locationName:"stage" type:"string" enum:"Stage"` // The tag for the branch. - Tags map[string]*string `locationName:"tags" min:"1" type:"map"` + Tags map[string]*string `locationName:"tags" type:"map"` // The content Time To Live (TTL) for the website in seconds. Ttl *string `locationName:"ttl" type:"string"` @@ -4753,9 +4776,6 @@ func (s *CreateBranchInput) Validate() error { if s.AppId != nil && len(*s.AppId) < 1 { invalidParams.Add(request.NewErrParamMinLen("AppId", 1)) } - if s.BackendEnvironmentArn != nil && len(*s.BackendEnvironmentArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("BackendEnvironmentArn", 1)) - } if s.BranchName == nil { invalidParams.Add(request.NewErrParamRequired("BranchName")) } @@ -4765,9 +4785,6 @@ func (s *CreateBranchInput) Validate() error { if s.BuildSpec != nil && len(*s.BuildSpec) < 1 { invalidParams.Add(request.NewErrParamMinLen("BuildSpec", 1)) } - if s.Tags != nil && len(s.Tags) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) - } if invalidParams.Len() > 0 { return invalidParams @@ -5319,7 +5336,7 @@ type CustomRule struct { _ struct{} `type:"structure"` // The condition for a URL rewrite or redirect rule, such as a country code. - Condition *string `locationName:"condition" min:"1" type:"string"` + Condition *string `locationName:"condition" type:"string"` // The source pattern for a URL rewrite or redirect rule. // @@ -5377,9 +5394,6 @@ func (s CustomRule) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *CustomRule) Validate() error { invalidParams := request.ErrInvalidParams{Context: "CustomRule"} - if s.Condition != nil && len(*s.Condition) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Condition", 1)) - } if s.Source == nil { invalidParams.Add(request.NewErrParamRequired("Source")) } @@ -8068,7 +8082,7 @@ type ListTagsForResourceOutput struct { _ struct{} `type:"structure"` // A list of tags for the specified The Amazon Resource Name (ARN). - Tags map[string]*string `locationName:"tags" min:"1" type:"map"` + Tags map[string]*string `locationName:"tags" type:"map"` } // String returns the string representation. @@ -9063,7 +9077,7 @@ type TagResourceInput struct { // The tags used to tag the resource. // // Tags is a required field - Tags map[string]*string `locationName:"tags" min:"1" type:"map" required:"true"` + Tags map[string]*string `locationName:"tags" type:"map" required:"true"` } // String returns the string representation. @@ -9096,9 +9110,6 @@ func (s *TagResourceInput) Validate() error { if s.Tags == nil { invalidParams.Add(request.NewErrParamRequired("Tags")) } - if s.Tags != nil && len(s.Tags) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) - } if invalidParams.Len() > 0 { return invalidParams @@ -9328,10 +9339,14 @@ type UpdateAppInput struct { BasicAuthCredentials *string `locationName:"basicAuthCredentials" type:"string" sensitive:"true"` // The build specification (build spec) for an Amplify app. - BuildSpec *string `locationName:"buildSpec" min:"1" type:"string"` + // + // BuildSpec is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UpdateAppInput's + // String and GoString methods. + BuildSpec *string `locationName:"buildSpec" min:"1" type:"string" sensitive:"true"` // The custom HTTP headers for an Amplify app. - CustomHeaders *string `locationName:"customHeaders" min:"1" type:"string"` + CustomHeaders *string `locationName:"customHeaders" type:"string"` // The custom redirect and rewrite rules for an Amplify app. CustomRules []*CustomRule `locationName:"customRules" type:"list"` @@ -9357,7 +9372,7 @@ type UpdateAppInput struct { // The AWS Identity and Access Management (IAM) service role for an Amplify // app. - IamServiceRoleArn *string `locationName:"iamServiceRoleArn" min:"1" type:"string"` + IamServiceRoleArn *string `locationName:"iamServiceRoleArn" type:"string"` // The name for an Amplify app. Name *string `locationName:"name" min:"1" type:"string"` @@ -9411,12 +9426,6 @@ func (s *UpdateAppInput) Validate() error { if s.BuildSpec != nil && len(*s.BuildSpec) < 1 { invalidParams.Add(request.NewErrParamMinLen("BuildSpec", 1)) } - if s.CustomHeaders != nil && len(*s.CustomHeaders) < 1 { - invalidParams.Add(request.NewErrParamMinLen("CustomHeaders", 1)) - } - if s.IamServiceRoleArn != nil && len(*s.IamServiceRoleArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("IamServiceRoleArn", 1)) - } if s.Name != nil && len(*s.Name) < 1 { invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } @@ -9601,7 +9610,7 @@ type UpdateBranchInput struct { // The Amazon Resource Name (ARN) for a backend environment that is part of // an Amplify app. - BackendEnvironmentArn *string `locationName:"backendEnvironmentArn" min:"1" type:"string"` + BackendEnvironmentArn *string `locationName:"backendEnvironmentArn" type:"string"` // The basic authorization credentials for the branch. You must base64-encode // the authorization credentials and provide them in the format user:password. @@ -9617,7 +9626,11 @@ type UpdateBranchInput struct { BranchName *string `location:"uri" locationName:"branchName" min:"1" type:"string" required:"true"` // The build specification (build spec) for the branch. - BuildSpec *string `locationName:"buildSpec" min:"1" type:"string"` + // + // BuildSpec is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UpdateBranchInput's + // String and GoString methods. + BuildSpec *string `locationName:"buildSpec" min:"1" type:"string" sensitive:"true"` // The description for the branch. Description *string `locationName:"description" type:"string"` @@ -9687,9 +9700,6 @@ func (s *UpdateBranchInput) Validate() error { if s.AppId != nil && len(*s.AppId) < 1 { invalidParams.Add(request.NewErrParamMinLen("AppId", 1)) } - if s.BackendEnvironmentArn != nil && len(*s.BackendEnvironmentArn) < 1 { - invalidParams.Add(request.NewErrParamMinLen("BackendEnvironmentArn", 1)) - } if s.BranchName == nil { invalidParams.Add(request.NewErrParamRequired("BranchName")) } @@ -9867,9 +9877,7 @@ type UpdateDomainAssociationInput struct { EnableAutoSubDomain *bool `locationName:"enableAutoSubDomain" type:"boolean"` // Describes the settings for the subdomain. - // - // SubDomainSettings is a required field - SubDomainSettings []*SubDomainSetting `locationName:"subDomainSettings" type:"list" required:"true"` + SubDomainSettings []*SubDomainSetting `locationName:"subDomainSettings" type:"list"` } // String returns the string representation. @@ -9905,9 +9913,6 @@ func (s *UpdateDomainAssociationInput) Validate() error { if s.DomainName != nil && len(*s.DomainName) < 1 { invalidParams.Add(request.NewErrParamMinLen("DomainName", 1)) } - if s.SubDomainSettings == nil { - invalidParams.Add(request.NewErrParamRequired("SubDomainSettings")) - } if s.SubDomainSettings != nil { for i, v := range s.SubDomainSettings { if v == nil { @@ -10304,12 +10309,36 @@ func JobType_Values() []string { const ( // PlatformWeb is a Platform enum value PlatformWeb = "WEB" + + // PlatformWebDynamic is a Platform enum value + PlatformWebDynamic = "WEB_DYNAMIC" ) // Platform_Values returns all elements of the Platform enum func Platform_Values() []string { return []string{ PlatformWeb, + PlatformWebDynamic, + } +} + +const ( + // RepositoryCloneMethodSsh is a RepositoryCloneMethod enum value + RepositoryCloneMethodSsh = "SSH" + + // RepositoryCloneMethodToken is a RepositoryCloneMethod enum value + RepositoryCloneMethodToken = "TOKEN" + + // RepositoryCloneMethodSigv4 is a RepositoryCloneMethod enum value + RepositoryCloneMethodSigv4 = "SIGV4" +) + +// RepositoryCloneMethod_Values returns all elements of the RepositoryCloneMethod enum +func RepositoryCloneMethod_Values() []string { + return []string{ + RepositoryCloneMethodSsh, + RepositoryCloneMethodToken, + RepositoryCloneMethodSigv4, } } diff --git a/service/amplifyuibuilder/amplifyuibuilderiface/interface.go b/service/amplifyuibuilder/amplifyuibuilderiface/interface.go index ffa03543a1f..7789a232ad6 100644 --- a/service/amplifyuibuilder/amplifyuibuilderiface/interface.go +++ b/service/amplifyuibuilder/amplifyuibuilderiface/interface.go @@ -84,10 +84,16 @@ type AmplifyUIBuilderAPI interface { ExportComponentsWithContext(aws.Context, *amplifyuibuilder.ExportComponentsInput, ...request.Option) (*amplifyuibuilder.ExportComponentsOutput, error) ExportComponentsRequest(*amplifyuibuilder.ExportComponentsInput) (*request.Request, *amplifyuibuilder.ExportComponentsOutput) + ExportComponentsPages(*amplifyuibuilder.ExportComponentsInput, func(*amplifyuibuilder.ExportComponentsOutput, bool) bool) error + ExportComponentsPagesWithContext(aws.Context, *amplifyuibuilder.ExportComponentsInput, func(*amplifyuibuilder.ExportComponentsOutput, bool) bool, ...request.Option) error + ExportThemes(*amplifyuibuilder.ExportThemesInput) (*amplifyuibuilder.ExportThemesOutput, error) ExportThemesWithContext(aws.Context, *amplifyuibuilder.ExportThemesInput, ...request.Option) (*amplifyuibuilder.ExportThemesOutput, error) ExportThemesRequest(*amplifyuibuilder.ExportThemesInput) (*request.Request, *amplifyuibuilder.ExportThemesOutput) + ExportThemesPages(*amplifyuibuilder.ExportThemesInput, func(*amplifyuibuilder.ExportThemesOutput, bool) bool) error + ExportThemesPagesWithContext(aws.Context, *amplifyuibuilder.ExportThemesInput, func(*amplifyuibuilder.ExportThemesOutput, bool) bool, ...request.Option) error + GetComponent(*amplifyuibuilder.GetComponentInput) (*amplifyuibuilder.GetComponentOutput, error) GetComponentWithContext(aws.Context, *amplifyuibuilder.GetComponentInput, ...request.Option) (*amplifyuibuilder.GetComponentOutput, error) GetComponentRequest(*amplifyuibuilder.GetComponentInput) (*request.Request, *amplifyuibuilder.GetComponentOutput) diff --git a/service/amplifyuibuilder/api.go b/service/amplifyuibuilder/api.go index ac8e991a148..5a7e1f43010 100644 --- a/service/amplifyuibuilder/api.go +++ b/service/amplifyuibuilder/api.go @@ -475,6 +475,12 @@ func (c *AmplifyUIBuilder) ExportComponentsRequest(input *ExportComponentsInput) Name: opExportComponents, HTTPMethod: "GET", HTTPPath: "/export/app/{appId}/environment/{environmentName}/components", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "", + TruncationToken: "", + }, } if input == nil { @@ -527,6 +533,58 @@ func (c *AmplifyUIBuilder) ExportComponentsWithContext(ctx aws.Context, input *E return out, req.Send() } +// ExportComponentsPages iterates over the pages of a ExportComponents operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ExportComponents 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 ExportComponents operation. +// pageNum := 0 +// err := client.ExportComponentsPages(params, +// func(page *amplifyuibuilder.ExportComponentsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AmplifyUIBuilder) ExportComponentsPages(input *ExportComponentsInput, fn func(*ExportComponentsOutput, bool) bool) error { + return c.ExportComponentsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ExportComponentsPagesWithContext same as ExportComponentsPages 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 *AmplifyUIBuilder) ExportComponentsPagesWithContext(ctx aws.Context, input *ExportComponentsInput, fn func(*ExportComponentsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ExportComponentsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ExportComponentsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ExportComponentsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opExportThemes = "ExportThemes" // ExportThemesRequest generates a "aws/request.Request" representing the @@ -558,6 +616,12 @@ func (c *AmplifyUIBuilder) ExportThemesRequest(input *ExportThemesInput) (req *r Name: opExportThemes, HTTPMethod: "GET", HTTPPath: "/export/app/{appId}/environment/{environmentName}/themes", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "", + TruncationToken: "", + }, } if input == nil { @@ -610,6 +674,58 @@ func (c *AmplifyUIBuilder) ExportThemesWithContext(ctx aws.Context, input *Expor return out, req.Send() } +// ExportThemesPages iterates over the pages of a ExportThemes operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ExportThemes 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 ExportThemes operation. +// pageNum := 0 +// err := client.ExportThemesPages(params, +// func(page *amplifyuibuilder.ExportThemesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AmplifyUIBuilder) ExportThemesPages(input *ExportThemesInput, fn func(*ExportThemesOutput, bool) bool) error { + return c.ExportThemesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ExportThemesPagesWithContext same as ExportThemesPages 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 *AmplifyUIBuilder) ExportThemesPagesWithContext(ctx aws.Context, input *ExportThemesInput, fn func(*ExportThemesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ExportThemesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ExportThemesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ExportThemesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opGetComponent = "GetComponent" // GetComponentRequest generates a "aws/request.Request" representing the @@ -1309,6 +1425,174 @@ func (c *AmplifyUIBuilder) UpdateThemeWithContext(ctx aws.Context, input *Update return out, req.Send() } +// Represents the event action configuration for an element of a Component or +// ComponentChild. Use for the workflow feature in Amplify Studio that allows +// you to bind events and actions to components. ActionParameters defines the +// action that is performed when an event occurs on the component. +type ActionParameters struct { + _ struct{} `type:"structure"` + + // The HTML anchor link to the location to open. Specify this value for a navigation + // action. + Anchor *ComponentProperty `locationName:"anchor" type:"structure"` + + // A dictionary of key-value pairs mapping Amplify Studio properties to fields + // in a data model. Use when the action performs an operation on an Amplify + // DataStore model. + Fields map[string]*ComponentProperty `locationName:"fields" type:"map"` + + // Specifies whether the user should be signed out globally. Specify this value + // for an auth sign out action. + Global *ComponentProperty `locationName:"global" type:"structure"` + + // The unique ID of the component that the ActionParameters apply to. + Id *ComponentProperty `locationName:"id" type:"structure"` + + // The name of the data model. Use when the action performs an operation on + // an Amplify DataStore model. + Model *string `locationName:"model" type:"string"` + + // A key-value pair that specifies the state property name and its initial value. + State *MutationActionSetStateParameter `locationName:"state" type:"structure"` + + // The element within the same component to modify when the action occurs. + Target *ComponentProperty `locationName:"target" type:"structure"` + + // The type of navigation action. Valid values are url and anchor. This value + // is required for a navigation action. + Type *ComponentProperty `locationName:"type" type:"structure"` + + // The URL to the location to open. Specify this value for a navigation action. + Url *ComponentProperty `locationName:"url" 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 ActionParameters) 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 ActionParameters) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ActionParameters) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ActionParameters"} + if s.Anchor != nil { + if err := s.Anchor.Validate(); err != nil { + invalidParams.AddNested("Anchor", err.(request.ErrInvalidParams)) + } + } + if s.Fields != nil { + for i, v := range s.Fields { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Fields", i), err.(request.ErrInvalidParams)) + } + } + } + if s.Global != nil { + if err := s.Global.Validate(); err != nil { + invalidParams.AddNested("Global", err.(request.ErrInvalidParams)) + } + } + if s.Id != nil { + if err := s.Id.Validate(); err != nil { + invalidParams.AddNested("Id", err.(request.ErrInvalidParams)) + } + } + if s.State != nil { + if err := s.State.Validate(); err != nil { + invalidParams.AddNested("State", err.(request.ErrInvalidParams)) + } + } + if s.Target != nil { + if err := s.Target.Validate(); err != nil { + invalidParams.AddNested("Target", err.(request.ErrInvalidParams)) + } + } + if s.Type != nil { + if err := s.Type.Validate(); err != nil { + invalidParams.AddNested("Type", err.(request.ErrInvalidParams)) + } + } + if s.Url != nil { + if err := s.Url.Validate(); err != nil { + invalidParams.AddNested("Url", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAnchor sets the Anchor field's value. +func (s *ActionParameters) SetAnchor(v *ComponentProperty) *ActionParameters { + s.Anchor = v + return s +} + +// SetFields sets the Fields field's value. +func (s *ActionParameters) SetFields(v map[string]*ComponentProperty) *ActionParameters { + s.Fields = v + return s +} + +// SetGlobal sets the Global field's value. +func (s *ActionParameters) SetGlobal(v *ComponentProperty) *ActionParameters { + s.Global = v + return s +} + +// SetId sets the Id field's value. +func (s *ActionParameters) SetId(v *ComponentProperty) *ActionParameters { + s.Id = v + return s +} + +// SetModel sets the Model field's value. +func (s *ActionParameters) SetModel(v string) *ActionParameters { + s.Model = &v + return s +} + +// SetState sets the State field's value. +func (s *ActionParameters) SetState(v *MutationActionSetStateParameter) *ActionParameters { + s.State = v + return s +} + +// SetTarget sets the Target field's value. +func (s *ActionParameters) SetTarget(v *ComponentProperty) *ActionParameters { + s.Target = v + return s +} + +// SetType sets the Type field's value. +func (s *ActionParameters) SetType(v *ComponentProperty) *ActionParameters { + s.Type = v + return s +} + +// SetUrl sets the Url field's value. +func (s *ActionParameters) SetUrl(v *ComponentProperty) *ActionParameters { + s.Url = v + return s +} + // Contains the configuration settings for a user interface (UI) element for // an Amplify app. A component is configured as a primary, stand-alone UI element. // Use ComponentChild to configure an instance of a Component. A ComponentChild @@ -1321,7 +1605,8 @@ type Component struct { // AppId is a required field AppId *string `locationName:"appId" type:"string" required:"true"` - // The information to connect a component's properties to data at runtime. + // The information to connect a component's properties to data at runtime. You + // can't specify tags as a valid property for bindingProperties. // // BindingProperties is a required field BindingProperties map[string]*ComponentBindingPropertiesValue `locationName:"bindingProperties" type:"map" required:"true"` @@ -1330,7 +1615,7 @@ type Component struct { Children []*ComponentChild `locationName:"children" type:"list"` // The data binding configuration for the component's properties. Use this for - // a collection component. + // a collection component. You can't specify tags as a valid property for collectionProperties. CollectionProperties map[string]*ComponentDataConfiguration `locationName:"collectionProperties" type:"map"` // The type of the component. This can be an Amplify custom UI component or @@ -1349,6 +1634,10 @@ type Component struct { // EnvironmentName is a required field EnvironmentName *string `locationName:"environmentName" type:"string" required:"true"` + // Describes the events that can be raised on the component. Use for the workflow + // feature in Amplify Studio that allows you to bind events and actions to components. + Events map[string]*ComponentEvent `locationName:"events" type:"map"` + // The unique ID of the component. // // Id is a required field @@ -1363,16 +1652,21 @@ type Component struct { Name *string `locationName:"name" min:"1" type:"string" required:"true"` // Describes the component's properties that can be overriden in a customized - // instance of the component. + // instance of the component. You can't specify tags as a valid property for + // overrides. // // Overrides is a required field Overrides map[string]map[string]*string `locationName:"overrides" type:"map" required:"true"` - // Describes the component's properties. + // Describes the component's properties. You can't specify tags as a valid property + // for properties. // // Properties is a required field Properties map[string]*ComponentProperty `locationName:"properties" type:"map" required:"true"` + // The schema version of the component when it was imported. + SchemaVersion *string `locationName:"schemaVersion" type:"string"` + // The unique ID of the component in its original source system, such as Figma. SourceId *string `locationName:"sourceId" type:"string"` @@ -1446,6 +1740,12 @@ func (s *Component) SetEnvironmentName(v string) *Component { return s } +// SetEvents sets the Events field's value. +func (s *Component) SetEvents(v map[string]*ComponentEvent) *Component { + s.Events = v + return s +} + // SetId sets the Id field's value. func (s *Component) SetId(v string) *Component { s.Id = &v @@ -1476,6 +1776,12 @@ func (s *Component) SetProperties(v map[string]*ComponentProperty) *Component { return s } +// SetSchemaVersion sets the SchemaVersion field's value. +func (s *Component) SetSchemaVersion(v string) *Component { + s.SchemaVersion = &v + return s +} + // SetSourceId sets the SourceId field's value. func (s *Component) SetSourceId(v string) *Component { s.SourceId = &v @@ -1648,12 +1954,18 @@ type ComponentChild struct { // ComponentType is a required field ComponentType *string `locationName:"componentType" type:"string" required:"true"` + // Describes the events that can be raised on the child component. Use for the + // workflow feature in Amplify Studio that allows you to bind events and actions + // to components. + Events map[string]*ComponentEvent `locationName:"events" type:"map"` + // The name of the child component. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` - // Describes the properties of the child component. + // Describes the properties of the child component. You can't specify tags as + // a valid property for properties. // // Properties is a required field Properties map[string]*ComponentProperty `locationName:"properties" type:"map" required:"true"` @@ -1699,6 +2011,16 @@ func (s *ComponentChild) Validate() error { } } } + if s.Events != nil { + for i, v := range s.Events { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Events", i), err.(request.ErrInvalidParams)) + } + } + } if s.Properties != nil { for i, v := range s.Properties { if v == nil { @@ -1728,6 +2050,12 @@ func (s *ComponentChild) SetComponentType(v string) *ComponentChild { return s } +// SetEvents sets the Events field's value. +func (s *ComponentChild) SetEvents(v map[string]*ComponentEvent) *ComponentChild { + s.Events = v + return s +} + // SetName sets the Name field's value. func (s *ComponentChild) SetName(v string) *ComponentChild { s.Name = &v @@ -1755,6 +2083,9 @@ type ComponentConditionProperty struct { // The value of the property to evaluate. Operand *string `locationName:"operand" type:"string"` + // The type of the property to evaluate. + OperandType *string `locationName:"operandType" type:"string"` + // The operator to use to perform the evaluation, such as eq to represent equals. Operator *string `locationName:"operator" type:"string"` @@ -1821,6 +2152,12 @@ func (s *ComponentConditionProperty) SetOperand(v string) *ComponentConditionPro return s } +// SetOperandType sets the OperandType field's value. +func (s *ComponentConditionProperty) SetOperandType(v string) *ComponentConditionProperty { + s.OperandType = &v + return s +} + // SetOperator sets the Operator field's value. func (s *ComponentConditionProperty) SetOperator(v string) *ComponentConditionProperty { s.Operator = &v @@ -1925,6 +2262,64 @@ func (s *ComponentDataConfiguration) SetSort(v []*SortProperty) *ComponentDataCo return s } +// Describes the configuration of an event. You can bind an event and a corresponding +// action to a Component or a ComponentChild. A button click is an example of +// an event. +type ComponentEvent struct { + _ struct{} `type:"structure"` + + // The action to perform when a specific event is raised. + Action *string `locationName:"action" type:"string"` + + // Describes information about the action. + Parameters *ActionParameters `locationName:"parameters" 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 ComponentEvent) 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 ComponentEvent) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ComponentEvent) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ComponentEvent"} + if s.Parameters != nil { + if err := s.Parameters.Validate(); err != nil { + invalidParams.AddNested("Parameters", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAction sets the Action field's value. +func (s *ComponentEvent) SetAction(v string) *ComponentEvent { + s.Action = &v + return s +} + +// SetParameters sets the Parameters field's value. +func (s *ComponentEvent) SetParameters(v *ActionParameters) *ComponentEvent { + s.Parameters = v + return s +} + // Describes the configuration for all of a component's properties. Use ComponentProperty // to specify the values to render or bind by default. type ComponentProperty struct { @@ -1940,11 +2335,14 @@ type ComponentProperty struct { // for collection components. CollectionBindingProperties *ComponentPropertyBindingProperties `locationName:"collectionBindingProperties" type:"structure"` + // The name of the component that is affected by an event. + ComponentName *string `locationName:"componentName" type:"string"` + // A list of component properties to concatenate to create the value to assign // to this component property. Concat []*ComponentProperty `locationName:"concat" type:"list"` - // The conditional expression to use to assign a value to the component property.. + // The conditional expression to use to assign a value to the component property. Condition *ComponentConditionProperty `locationName:"condition" type:"structure"` // Specifies whether the user configured the property in Amplify Studio after @@ -1957,13 +2355,16 @@ type ComponentProperty struct { // An event that occurs in your app. Use this for workflow data binding. Event *string `locationName:"event" type:"string"` - // The default value assigned to property when the component is imported into - // an app. + // The default value assigned to the property when the component is imported + // into an app. ImportedValue *string `locationName:"importedValue" type:"string"` // The data model to use to assign a value to the component property. Model *string `locationName:"model" type:"string"` + // The name of the component's property that is affected by an event. + Property *string `locationName:"property" type:"string"` + // The component type. Type *string `locationName:"type" type:"string"` @@ -2056,6 +2457,12 @@ func (s *ComponentProperty) SetCollectionBindingProperties(v *ComponentPropertyB return s } +// SetComponentName sets the ComponentName field's value. +func (s *ComponentProperty) SetComponentName(v string) *ComponentProperty { + s.ComponentName = &v + return s +} + // SetConcat sets the Concat field's value. func (s *ComponentProperty) SetConcat(v []*ComponentProperty) *ComponentProperty { s.Concat = v @@ -2098,6 +2505,12 @@ func (s *ComponentProperty) SetModel(v string) *ComponentProperty { return s } +// SetProperty sets the Property field's value. +func (s *ComponentProperty) SetProperty(v string) *ComponentProperty { + s.Property = &v + return s +} + // SetType sets the Type field's value. func (s *ComponentProperty) SetType(v string) *ComponentProperty { s.Type = &v @@ -2258,10 +2671,12 @@ type ComponentVariant struct { _ struct{} `type:"structure"` // The properties of the component variant that can be overriden when customizing - // an instance of the component. + // an instance of the component. You can't specify tags as a valid property + // for overrides. Overrides map[string]map[string]*string `locationName:"overrides" type:"map"` - // The combination of variants that comprise this variant. + // The combination of variants that comprise this variant. You can't specify + // tags as a valid property for variantValues. VariantValues map[string]*string `locationName:"variantValues" type:"map"` } @@ -2317,6 +2732,10 @@ type CreateComponentData struct { // ComponentType is a required field ComponentType *string `locationName:"componentType" min:"1" type:"string" required:"true"` + // The event configuration for the component. Use for the workflow feature in + // Amplify Studio that allows you to bind events and actions to components. + Events map[string]*ComponentEvent `locationName:"events" type:"map"` + // The name of the component // // Name is a required field @@ -2333,6 +2752,9 @@ type CreateComponentData struct { // Properties is a required field Properties map[string]*ComponentProperty `locationName:"properties" type:"map" required:"true"` + // The schema version of the component when it was imported. + SchemaVersion *string `locationName:"schemaVersion" type:"string"` + // The unique ID of the component in its original source system, such as Figma. SourceId *string `locationName:"sourceId" type:"string"` @@ -2410,6 +2832,16 @@ func (s *CreateComponentData) Validate() error { } } } + if s.Events != nil { + for i, v := range s.Events { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Events", i), err.(request.ErrInvalidParams)) + } + } + } if s.Properties != nil { for i, v := range s.Properties { if v == nil { @@ -2451,6 +2883,12 @@ func (s *CreateComponentData) SetComponentType(v string) *CreateComponentData { return s } +// SetEvents sets the Events field's value. +func (s *CreateComponentData) SetEvents(v map[string]*ComponentEvent) *CreateComponentData { + s.Events = v + return s +} + // SetName sets the Name field's value. func (s *CreateComponentData) SetName(v string) *CreateComponentData { s.Name = &v @@ -2469,6 +2907,12 @@ func (s *CreateComponentData) SetProperties(v map[string]*ComponentProperty) *Cr return s } +// SetSchemaVersion sets the SchemaVersion field's value. +func (s *CreateComponentData) SetSchemaVersion(v string) *CreateComponentData { + s.SchemaVersion = &v + return s +} + // SetSourceId sets the SourceId field's value. func (s *CreateComponentData) SetSourceId(v string) *CreateComponentData { s.SourceId = &v @@ -3240,6 +3684,9 @@ type ExportComponentsInput struct { // // EnvironmentName is a required field EnvironmentName *string `location:"uri" locationName:"environmentName" type:"string" required:"true"` + + // The token to request the next page of results. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } // String returns the string representation. @@ -3294,6 +3741,12 @@ func (s *ExportComponentsInput) SetEnvironmentName(v string) *ExportComponentsIn return s } +// SetNextToken sets the NextToken field's value. +func (s *ExportComponentsInput) SetNextToken(v string) *ExportComponentsInput { + s.NextToken = &v + return s +} + type ExportComponentsOutput struct { _ struct{} `type:"structure"` @@ -3301,6 +3754,9 @@ type ExportComponentsOutput struct { // // Entities is a required field Entities []*Component `locationName:"entities" type:"list" required:"true"` + + // The pagination token that's included if more results are available. + NextToken *string `locationName:"nextToken" type:"string"` } // String returns the string representation. @@ -3327,6 +3783,12 @@ func (s *ExportComponentsOutput) SetEntities(v []*Component) *ExportComponentsOu return s } +// SetNextToken sets the NextToken field's value. +func (s *ExportComponentsOutput) SetNextToken(v string) *ExportComponentsOutput { + s.NextToken = &v + return s +} + type ExportThemesInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -3339,6 +3801,9 @@ type ExportThemesInput struct { // // EnvironmentName is a required field EnvironmentName *string `location:"uri" locationName:"environmentName" type:"string" required:"true"` + + // The token to request the next page of results. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } // String returns the string representation. @@ -3393,6 +3858,12 @@ func (s *ExportThemesInput) SetEnvironmentName(v string) *ExportThemesInput { return s } +// SetNextToken sets the NextToken field's value. +func (s *ExportThemesInput) SetNextToken(v string) *ExportThemesInput { + s.NextToken = &v + return s +} + type ExportThemesOutput struct { _ struct{} `type:"structure"` @@ -3400,6 +3871,9 @@ type ExportThemesOutput struct { // // Entities is a required field Entities []*Theme `locationName:"entities" type:"list" required:"true"` + + // The pagination token that's included if more results are available. + NextToken *string `locationName:"nextToken" type:"string"` } // String returns the string representation. @@ -3426,6 +3900,12 @@ func (s *ExportThemesOutput) SetEntities(v []*Theme) *ExportThemesOutput { return s } +// SetNextToken sets the NextToken field's value. +func (s *ExportThemesOutput) SetNextToken(v string) *ExportThemesOutput { + s.NextToken = &v + return s +} + // Describes how to bind a component property to form data. type FormBindingElement struct { _ struct{} `type:"structure"` @@ -4101,6 +4581,87 @@ func (s *ListThemesOutput) SetNextToken(v string) *ListThemesOutput { return s } +// Represents the state configuration when an action modifies a property of +// another element within the same component. +type MutationActionSetStateParameter struct { + _ struct{} `type:"structure"` + + // The name of the component that is being modified. + // + // ComponentName is a required field + ComponentName *string `locationName:"componentName" type:"string" required:"true"` + + // The name of the component property to apply the state configuration to. + // + // Property is a required field + Property *string `locationName:"property" type:"string" required:"true"` + + // The state configuration to assign to the property. + // + // Set is a required field + Set *ComponentProperty `locationName:"set" type:"structure" 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 MutationActionSetStateParameter) 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 MutationActionSetStateParameter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *MutationActionSetStateParameter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "MutationActionSetStateParameter"} + if s.ComponentName == nil { + invalidParams.Add(request.NewErrParamRequired("ComponentName")) + } + if s.Property == nil { + invalidParams.Add(request.NewErrParamRequired("Property")) + } + if s.Set == nil { + invalidParams.Add(request.NewErrParamRequired("Set")) + } + if s.Set != nil { + if err := s.Set.Validate(); err != nil { + invalidParams.AddNested("Set", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetComponentName sets the ComponentName field's value. +func (s *MutationActionSetStateParameter) SetComponentName(v string) *MutationActionSetStateParameter { + s.ComponentName = &v + return s +} + +// SetProperty sets the Property field's value. +func (s *MutationActionSetStateParameter) SetProperty(v string) *MutationActionSetStateParameter { + s.Property = &v + return s +} + +// SetSet sets the Set field's value. +func (s *MutationActionSetStateParameter) SetSet(v *ComponentProperty) *MutationActionSetStateParameter { + s.Set = v + return s +} + // Stores information for generating Amplify DataStore queries. Use a Predicate // to retrieve a subset of the data in a collection. type Predicate struct { @@ -4878,6 +5439,10 @@ type UpdateComponentData struct { // another custom component. ComponentType *string `locationName:"componentType" min:"1" type:"string"` + // The event configuration for the component. Use for the workflow feature in + // Amplify Studio that allows you to bind events and actions to components. + Events map[string]*ComponentEvent `locationName:"events" type:"map"` + // The unique ID of the component to update. Id *string `locationName:"id" type:"string"` @@ -4890,6 +5455,9 @@ type UpdateComponentData struct { // Describes the component's properties. Properties map[string]*ComponentProperty `locationName:"properties" type:"map"` + // The schema version of the component when it was imported. + SchemaVersion *string `locationName:"schemaVersion" type:"string"` + // The unique ID of the component in its original source system, such as Figma. SourceId *string `locationName:"sourceId" type:"string"` @@ -4944,6 +5512,16 @@ func (s *UpdateComponentData) Validate() error { } } } + if s.Events != nil { + for i, v := range s.Events { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Events", i), err.(request.ErrInvalidParams)) + } + } + } if s.Properties != nil { for i, v := range s.Properties { if v == nil { @@ -4985,6 +5563,12 @@ func (s *UpdateComponentData) SetComponentType(v string) *UpdateComponentData { return s } +// SetEvents sets the Events field's value. +func (s *UpdateComponentData) SetEvents(v map[string]*ComponentEvent) *UpdateComponentData { + s.Events = v + return s +} + // SetId sets the Id field's value. func (s *UpdateComponentData) SetId(v string) *UpdateComponentData { s.Id = &v @@ -5009,6 +5593,12 @@ func (s *UpdateComponentData) SetProperties(v map[string]*ComponentProperty) *Up return s } +// SetSchemaVersion sets the SchemaVersion field's value. +func (s *UpdateComponentData) SetSchemaVersion(v string) *UpdateComponentData { + s.SchemaVersion = &v + return s +} + // SetSourceId sets the SourceId field's value. func (s *UpdateComponentData) SetSourceId(v string) *UpdateComponentData { s.SourceId = &v diff --git a/service/amplifyuibuilder/doc.go b/service/amplifyuibuilder/doc.go index f395bd29e21..5958a11f072 100644 --- a/service/amplifyuibuilder/doc.go +++ b/service/amplifyuibuilder/doc.go @@ -15,8 +15,8 @@ // The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and // documentation for client app development. For more information, see the Amplify // Framework (https://docs.amplify.aws/). For more information about deploying -// an Amplify application to Amazon Web Services, see the Amplify Console User -// Guide (https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html). +// an Amplify application to Amazon Web Services, see the Amplify User Guide +// (https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html). // // See https://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11 for more information on this service. // diff --git a/service/appregistry/api.go b/service/appregistry/api.go index 071b48f1563..c2e069f3825 100644 --- a/service/appregistry/api.go +++ b/service/appregistry/api.go @@ -4988,7 +4988,9 @@ type UpdateApplicationInput struct { // The new name of the application. The name must be unique in the region in // which you are updating the application. - Name *string `locationName:"name" min:"1" type:"string"` + // + // Deprecated: Name update for application is deprecated. + Name *string `locationName:"name" min:"1" deprecated:"true" type:"string"` } // String returns the string representation. @@ -5095,7 +5097,9 @@ type UpdateAttributeGroupInput struct { // The new name of the attribute group. The name must be unique in the region // in which you are updating the attribute group. - Name *string `locationName:"name" min:"1" type:"string"` + // + // Deprecated: Name update for attribute group is deprecated. + Name *string `locationName:"name" min:"1" deprecated:"true" type:"string"` } // String returns the string representation. diff --git a/service/athena/api.go b/service/athena/api.go index 20416c74e85..efdd5d73ed2 100644 --- a/service/athena/api.go +++ b/service/athena/api.go @@ -3360,6 +3360,91 @@ func (c *Athena) UpdateDataCatalogWithContext(ctx aws.Context, input *UpdateData return out, req.Send() } +const opUpdateNamedQuery = "UpdateNamedQuery" + +// UpdateNamedQueryRequest generates a "aws/request.Request" representing the +// client's request for the UpdateNamedQuery 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 UpdateNamedQuery for more information on using the UpdateNamedQuery +// 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 UpdateNamedQueryRequest method. +// req, resp := client.UpdateNamedQueryRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateNamedQuery +func (c *Athena) UpdateNamedQueryRequest(input *UpdateNamedQueryInput) (req *request.Request, output *UpdateNamedQueryOutput) { + op := &request.Operation{ + Name: opUpdateNamedQuery, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateNamedQueryInput{} + } + + output = &UpdateNamedQueryOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateNamedQuery API operation for Amazon Athena. +// +// Updates a NamedQuery object. The database or workgroup cannot be updated. +// +// 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 Athena's +// API operation UpdateNamedQuery for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// Indicates a platform issue, which may be due to a transient condition or +// outage. +// +// * InvalidRequestException +// Indicates that something is wrong with the input to the request. For example, +// a required parameter may be missing or out of range. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/athena-2017-05-18/UpdateNamedQuery +func (c *Athena) UpdateNamedQuery(input *UpdateNamedQueryInput) (*UpdateNamedQueryOutput, error) { + req, out := c.UpdateNamedQueryRequest(input) + return out, req.Send() +} + +// UpdateNamedQueryWithContext is the same as UpdateNamedQuery with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateNamedQuery 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 *Athena) UpdateNamedQueryWithContext(ctx aws.Context, input *UpdateNamedQueryInput, opts ...request.Option) (*UpdateNamedQueryOutput, error) { + req, out := c.UpdateNamedQueryRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opUpdatePreparedStatement = "UpdatePreparedStatement" // UpdatePreparedStatementRequest generates a "aws/request.Request" representing the @@ -3538,7 +3623,7 @@ func (c *Athena) UpdateWorkGroupWithContext(ctx aws.Context, input *UpdateWorkGr // provides standardized error information to help you understand failed queries // and take steps after a query failure occurs. AthenaError includes an ErrorCategory // field that specifies whether the cause of the failed query is due to system -// error, user error, or unknown error. +// error, user error, or other error. type AthenaError struct { _ struct{} `type:"structure"` @@ -3549,7 +3634,7 @@ type AthenaError struct { // // 2 - User // - // 3 - Unknown + // 3 - Other ErrorCategory *int64 `min:"1" type:"integer"` // An integer value that provides specific information about an Athena query @@ -7067,8 +7152,7 @@ func (s *MetadataException) RequestID() string { return s.RespMetadata.RequestID } -// A query, where QueryString is the list of SQL query statements that comprise -// the query. +// A query, where QueryString contains the SQL statements that make up the query. type NamedQuery struct { _ struct{} `type:"structure"` @@ -7088,7 +7172,7 @@ type NamedQuery struct { // The unique identifier of the query. NamedQueryId *string `type:"string"` - // The SQL query statements that comprise the query. + // The SQL statements that make up the query. // // QueryString is a required field QueryString *string `min:"1" type:"string" required:"true"` @@ -7895,7 +7979,7 @@ func (s *ResultConfigurationUpdates) SetRemoveOutputLocation(v bool) *ResultConf return s } -// The metadata and rows that comprise a query result set. The metadata describes +// The metadata and rows that make up a query result set. The metadata describes // the column structure and data types. To return a ResultSet object, use GetQueryResults. type ResultSet struct { _ struct{} `type:"structure"` @@ -7971,7 +8055,7 @@ func (s *ResultSetMetadata) SetColumnInfo(v []*ColumnInfo) *ResultSetMetadata { return s } -// The rows that comprise a query result table. +// The rows that make up a query result table. type Row struct { _ struct{} `type:"structure"` @@ -8830,6 +8914,117 @@ func (s UpdateDataCatalogOutput) GoString() string { return s.String() } +type UpdateNamedQueryInput struct { + _ struct{} `type:"structure"` + + // The query description. + Description *string `type:"string"` + + // The name of the query. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // The unique identifier (UUID) of the query. + // + // NamedQueryId is a required field + NamedQueryId *string `type:"string" required:"true"` + + // The contents of the query with all query statements. + // + // QueryString is a required field + QueryString *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 UpdateNamedQueryInput) 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 UpdateNamedQueryInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateNamedQueryInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateNamedQueryInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.NamedQueryId == nil { + invalidParams.Add(request.NewErrParamRequired("NamedQueryId")) + } + if s.QueryString == nil { + invalidParams.Add(request.NewErrParamRequired("QueryString")) + } + if s.QueryString != nil && len(*s.QueryString) < 1 { + invalidParams.Add(request.NewErrParamMinLen("QueryString", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDescription sets the Description field's value. +func (s *UpdateNamedQueryInput) SetDescription(v string) *UpdateNamedQueryInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *UpdateNamedQueryInput) SetName(v string) *UpdateNamedQueryInput { + s.Name = &v + return s +} + +// SetNamedQueryId sets the NamedQueryId field's value. +func (s *UpdateNamedQueryInput) SetNamedQueryId(v string) *UpdateNamedQueryInput { + s.NamedQueryId = &v + return s +} + +// SetQueryString sets the QueryString field's value. +func (s *UpdateNamedQueryInput) SetQueryString(v string) *UpdateNamedQueryInput { + s.QueryString = &v + return s +} + +type UpdateNamedQueryOutput 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 UpdateNamedQueryOutput) 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 UpdateNamedQueryOutput) GoString() string { + return s.String() +} + type UpdatePreparedStatementInput struct { _ struct{} `type:"structure"` diff --git a/service/athena/athenaiface/interface.go b/service/athena/athenaiface/interface.go index 5c973467676..0a994cb5192 100644 --- a/service/athena/athenaiface/interface.go +++ b/service/athena/athenaiface/interface.go @@ -215,6 +215,10 @@ type AthenaAPI interface { UpdateDataCatalogWithContext(aws.Context, *athena.UpdateDataCatalogInput, ...request.Option) (*athena.UpdateDataCatalogOutput, error) UpdateDataCatalogRequest(*athena.UpdateDataCatalogInput) (*request.Request, *athena.UpdateDataCatalogOutput) + UpdateNamedQuery(*athena.UpdateNamedQueryInput) (*athena.UpdateNamedQueryOutput, error) + UpdateNamedQueryWithContext(aws.Context, *athena.UpdateNamedQueryInput, ...request.Option) (*athena.UpdateNamedQueryOutput, error) + UpdateNamedQueryRequest(*athena.UpdateNamedQueryInput) (*request.Request, *athena.UpdateNamedQueryOutput) + UpdatePreparedStatement(*athena.UpdatePreparedStatementInput) (*athena.UpdatePreparedStatementOutput, error) UpdatePreparedStatementWithContext(aws.Context, *athena.UpdatePreparedStatementInput, ...request.Option) (*athena.UpdatePreparedStatementOutput, error) UpdatePreparedStatementRequest(*athena.UpdatePreparedStatementInput) (*request.Request, *athena.UpdatePreparedStatementOutput) diff --git a/service/ec2/api.go b/service/ec2/api.go index b04750add1a..4cea26616e8 100644 --- a/service/ec2/api.go +++ b/service/ec2/api.go @@ -82303,7 +82303,7 @@ type DescribeImageAttributeOutput struct { // The block device mapping entries. BlockDeviceMappings []*BlockDeviceMapping `locationName:"blockDeviceMapping" locationNameList:"item" type:"list"` - // Describes a value for a resource attribute that is a String. + // The boot mode. BootMode *AttributeValue `locationName:"bootMode" type:"structure"` // A description for the AMI. @@ -82315,6 +82315,13 @@ type DescribeImageAttributeOutput struct { // The kernel ID. KernelId *AttributeValue `locationName:"kernel" type:"structure"` + // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601), + // when the AMI was last used to launch an EC2 instance. When the AMI is used, + // there is a 24-hour delay before that usage is reported. + // + // lastLaunchedTime data is available starting April 2017. + LastLaunchedTime *AttributeValue `locationName:"lastLaunchedTime" type:"structure"` + // The launch permissions. LaunchPermissions []*LaunchPermission `locationName:"launchPermission" locationNameList:"item" type:"list"` @@ -82377,6 +82384,12 @@ func (s *DescribeImageAttributeOutput) SetKernelId(v *AttributeValue) *DescribeI return s } +// SetLastLaunchedTime sets the LastLaunchedTime field's value. +func (s *DescribeImageAttributeOutput) SetLastLaunchedTime(v *AttributeValue) *DescribeImageAttributeOutput { + s.LastLaunchedTime = v + return s +} + // SetLaunchPermissions sets the LaunchPermissions field's value. func (s *DescribeImageAttributeOutput) SetLaunchPermissions(v []*LaunchPermission) *DescribeImageAttributeOutput { s.LaunchPermissions = v @@ -162064,6 +162077,9 @@ const ( // ImageAttributeNameBootMode is a ImageAttributeName enum value ImageAttributeNameBootMode = "bootMode" + + // ImageAttributeNameLastLaunchedTime is a ImageAttributeName enum value + ImageAttributeNameLastLaunchedTime = "lastLaunchedTime" ) // ImageAttributeName_Values returns all elements of the ImageAttributeName enum @@ -162077,6 +162093,7 @@ func ImageAttributeName_Values() []string { ImageAttributeNameBlockDeviceMapping, ImageAttributeNameSriovNetSupport, ImageAttributeNameBootMode, + ImageAttributeNameLastLaunchedTime, } } @@ -166134,6 +166151,9 @@ const ( // ResourceTypeSubnet is a ResourceType enum value ResourceTypeSubnet = "subnet" + // ResourceTypeSubnetCidrReservation is a ResourceType enum value + ResourceTypeSubnetCidrReservation = "subnet-cidr-reservation" + // ResourceTypeTrafficMirrorFilter is a ResourceType enum value ResourceTypeTrafficMirrorFilter = "traffic-mirror-filter" @@ -166237,6 +166257,7 @@ func ResourceType_Values() []string { ResourceTypeSpotFleetRequest, ResourceTypeSpotInstancesRequest, ResourceTypeSubnet, + ResourceTypeSubnetCidrReservation, ResourceTypeTrafficMirrorFilter, ResourceTypeTrafficMirrorSession, ResourceTypeTrafficMirrorTarget, diff --git a/service/finspacedata/api.go b/service/finspacedata/api.go index 6874df7f49b..4d9218295c0 100644 --- a/service/finspacedata/api.go +++ b/service/finspacedata/api.go @@ -302,58 +302,59 @@ func (c *FinSpaceData) CreateDatasetWithContext(ctx aws.Context, input *CreateDa return out, req.Send() } -const opDeleteDataset = "DeleteDataset" +const opCreatePermissionGroup = "CreatePermissionGroup" -// DeleteDatasetRequest generates a "aws/request.Request" representing the -// client's request for the DeleteDataset operation. The "output" return +// CreatePermissionGroupRequest generates a "aws/request.Request" representing the +// client's request for the CreatePermissionGroup 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 DeleteDataset for more information on using the DeleteDataset +// See CreatePermissionGroup for more information on using the CreatePermissionGroup // 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 DeleteDatasetRequest method. -// req, resp := client.DeleteDatasetRequest(params) +// // Example sending a request using the CreatePermissionGroupRequest method. +// req, resp := client.CreatePermissionGroupRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeleteDataset -func (c *FinSpaceData) DeleteDatasetRequest(input *DeleteDatasetInput) (req *request.Request, output *DeleteDatasetOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreatePermissionGroup +func (c *FinSpaceData) CreatePermissionGroupRequest(input *CreatePermissionGroupInput) (req *request.Request, output *CreatePermissionGroupOutput) { op := &request.Operation{ - Name: opDeleteDataset, - HTTPMethod: "DELETE", - HTTPPath: "/datasetsv2/{datasetId}", + Name: opCreatePermissionGroup, + HTTPMethod: "POST", + HTTPPath: "/permission-group", } if input == nil { - input = &DeleteDatasetInput{} + input = &CreatePermissionGroupInput{} } - output = &DeleteDatasetOutput{} + output = &CreatePermissionGroupOutput{} req = c.newRequest(op, input, output) return } -// DeleteDataset API operation for FinSpace Public API. +// CreatePermissionGroup API operation for FinSpace Public API. // -// Deletes a FinSpace Dataset. +// Creates a group of permissions for various actions that a user can perform +// in FinSpace. // // 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 FinSpace Public API's -// API operation DeleteDataset for usage and error information. +// API operation CreatePermissionGroup for usage and error information. // // Returned Error Types: // * InternalServerException @@ -369,94 +370,88 @@ func (c *FinSpaceData) DeleteDatasetRequest(input *DeleteDatasetInput) (req *req // * AccessDeniedException // You do not have sufficient access to perform this action. // -// * ResourceNotFoundException -// One or more resources can't be found. -// // * LimitExceededException // A limit has exceeded. // // * ConflictException // The request conflicts with an existing resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeleteDataset -func (c *FinSpaceData) DeleteDataset(input *DeleteDatasetInput) (*DeleteDatasetOutput, error) { - req, out := c.DeleteDatasetRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreatePermissionGroup +func (c *FinSpaceData) CreatePermissionGroup(input *CreatePermissionGroupInput) (*CreatePermissionGroupOutput, error) { + req, out := c.CreatePermissionGroupRequest(input) return out, req.Send() } -// DeleteDatasetWithContext is the same as DeleteDataset with the addition of +// CreatePermissionGroupWithContext is the same as CreatePermissionGroup with the addition of // the ability to pass a context and additional request options. // -// See DeleteDataset for details on how to use this API operation. +// See CreatePermissionGroup 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 *FinSpaceData) DeleteDatasetWithContext(ctx aws.Context, input *DeleteDatasetInput, opts ...request.Option) (*DeleteDatasetOutput, error) { - req, out := c.DeleteDatasetRequest(input) +func (c *FinSpaceData) CreatePermissionGroupWithContext(ctx aws.Context, input *CreatePermissionGroupInput, opts ...request.Option) (*CreatePermissionGroupOutput, error) { + req, out := c.CreatePermissionGroupRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opGetChangeset = "GetChangeset" +const opCreateUser = "CreateUser" -// GetChangesetRequest generates a "aws/request.Request" representing the -// client's request for the GetChangeset operation. The "output" return +// CreateUserRequest generates a "aws/request.Request" representing the +// client's request for the CreateUser 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 GetChangeset for more information on using the GetChangeset +// See CreateUser for more information on using the CreateUser // 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 GetChangesetRequest method. -// req, resp := client.GetChangesetRequest(params) +// // Example sending a request using the CreateUserRequest method. +// req, resp := client.CreateUserRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetChangeset -func (c *FinSpaceData) GetChangesetRequest(input *GetChangesetInput) (req *request.Request, output *GetChangesetOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateUser +func (c *FinSpaceData) CreateUserRequest(input *CreateUserInput) (req *request.Request, output *CreateUserOutput) { op := &request.Operation{ - Name: opGetChangeset, - HTTPMethod: "GET", - HTTPPath: "/datasets/{datasetId}/changesetsv2/{changesetId}", + Name: opCreateUser, + HTTPMethod: "POST", + HTTPPath: "/user", } if input == nil { - input = &GetChangesetInput{} + input = &CreateUserInput{} } - output = &GetChangesetOutput{} + output = &CreateUserOutput{} req = c.newRequest(op, input, output) return } -// GetChangeset API operation for FinSpace Public API. +// CreateUser API operation for FinSpace Public API. // -// Get information about a Changeset. +// Creates a new user in FinSpace. // // 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 FinSpace Public API's -// API operation GetChangeset for usage and error information. +// API operation CreateUser for usage and error information. // // Returned Error Types: -// * ResourceNotFoundException -// One or more resources can't be found. -// // * InternalServerException // The request processing has failed because of an unknown error, exception // or failure. @@ -470,175 +465,184 @@ func (c *FinSpaceData) GetChangesetRequest(input *GetChangesetInput) (req *reque // * AccessDeniedException // You do not have sufficient access to perform this action. // +// * LimitExceededException +// A limit has exceeded. +// // * ConflictException // The request conflicts with an existing resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetChangeset -func (c *FinSpaceData) GetChangeset(input *GetChangesetInput) (*GetChangesetOutput, error) { - req, out := c.GetChangesetRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/CreateUser +func (c *FinSpaceData) CreateUser(input *CreateUserInput) (*CreateUserOutput, error) { + req, out := c.CreateUserRequest(input) return out, req.Send() } -// GetChangesetWithContext is the same as GetChangeset with the addition of +// CreateUserWithContext is the same as CreateUser with the addition of // the ability to pass a context and additional request options. // -// See GetChangeset for details on how to use this API operation. +// See CreateUser 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 *FinSpaceData) GetChangesetWithContext(ctx aws.Context, input *GetChangesetInput, opts ...request.Option) (*GetChangesetOutput, error) { - req, out := c.GetChangesetRequest(input) +func (c *FinSpaceData) CreateUserWithContext(ctx aws.Context, input *CreateUserInput, opts ...request.Option) (*CreateUserOutput, error) { + req, out := c.CreateUserRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opGetDataView = "GetDataView" +const opDeleteDataset = "DeleteDataset" -// GetDataViewRequest generates a "aws/request.Request" representing the -// client's request for the GetDataView operation. The "output" return +// DeleteDatasetRequest generates a "aws/request.Request" representing the +// client's request for the DeleteDataset 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 GetDataView for more information on using the GetDataView +// See DeleteDataset for more information on using the DeleteDataset // 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 GetDataViewRequest method. -// req, resp := client.GetDataViewRequest(params) +// // Example sending a request using the DeleteDatasetRequest method. +// req, resp := client.DeleteDatasetRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataView -func (c *FinSpaceData) GetDataViewRequest(input *GetDataViewInput) (req *request.Request, output *GetDataViewOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeleteDataset +func (c *FinSpaceData) DeleteDatasetRequest(input *DeleteDatasetInput) (req *request.Request, output *DeleteDatasetOutput) { op := &request.Operation{ - Name: opGetDataView, - HTTPMethod: "GET", - HTTPPath: "/datasets/{datasetId}/dataviewsv2/{dataviewId}", + Name: opDeleteDataset, + HTTPMethod: "DELETE", + HTTPPath: "/datasetsv2/{datasetId}", } if input == nil { - input = &GetDataViewInput{} + input = &DeleteDatasetInput{} } - output = &GetDataViewOutput{} + output = &DeleteDatasetOutput{} req = c.newRequest(op, input, output) return } -// GetDataView API operation for FinSpace Public API. +// DeleteDataset API operation for FinSpace Public API. // -// Gets information about a Dataview. +// Deletes a FinSpace Dataset. // // 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 FinSpace Public API's -// API operation GetDataView for usage and error information. +// API operation DeleteDataset for usage and error information. // // Returned Error Types: -// * ResourceNotFoundException -// One or more resources can't be found. -// // * InternalServerException // The request processing has failed because of an unknown error, exception // or failure. // +// * ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// // * ThrottlingException // The request was denied due to request throttling. // -// * ValidationException -// The input fails to satisfy the constraints specified by an AWS service. +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * LimitExceededException +// A limit has exceeded. // // * ConflictException // The request conflicts with an existing resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataView -func (c *FinSpaceData) GetDataView(input *GetDataViewInput) (*GetDataViewOutput, error) { - req, out := c.GetDataViewRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeleteDataset +func (c *FinSpaceData) DeleteDataset(input *DeleteDatasetInput) (*DeleteDatasetOutput, error) { + req, out := c.DeleteDatasetRequest(input) return out, req.Send() } -// GetDataViewWithContext is the same as GetDataView with the addition of +// DeleteDatasetWithContext is the same as DeleteDataset with the addition of // the ability to pass a context and additional request options. // -// See GetDataView for details on how to use this API operation. +// See DeleteDataset 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 *FinSpaceData) GetDataViewWithContext(ctx aws.Context, input *GetDataViewInput, opts ...request.Option) (*GetDataViewOutput, error) { - req, out := c.GetDataViewRequest(input) +func (c *FinSpaceData) DeleteDatasetWithContext(ctx aws.Context, input *DeleteDatasetInput, opts ...request.Option) (*DeleteDatasetOutput, error) { + req, out := c.DeleteDatasetRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opGetDataset = "GetDataset" +const opDeletePermissionGroup = "DeletePermissionGroup" -// GetDatasetRequest generates a "aws/request.Request" representing the -// client's request for the GetDataset operation. The "output" return +// DeletePermissionGroupRequest generates a "aws/request.Request" representing the +// client's request for the DeletePermissionGroup 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 GetDataset for more information on using the GetDataset +// See DeletePermissionGroup for more information on using the DeletePermissionGroup // 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 GetDatasetRequest method. -// req, resp := client.GetDatasetRequest(params) +// // Example sending a request using the DeletePermissionGroupRequest method. +// req, resp := client.DeletePermissionGroupRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataset -func (c *FinSpaceData) GetDatasetRequest(input *GetDatasetInput) (req *request.Request, output *GetDatasetOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeletePermissionGroup +func (c *FinSpaceData) DeletePermissionGroupRequest(input *DeletePermissionGroupInput) (req *request.Request, output *DeletePermissionGroupOutput) { op := &request.Operation{ - Name: opGetDataset, - HTTPMethod: "GET", - HTTPPath: "/datasetsv2/{datasetId}", + Name: opDeletePermissionGroup, + HTTPMethod: "DELETE", + HTTPPath: "/permission-group/{permissionGroupId}", } if input == nil { - input = &GetDatasetInput{} + input = &DeletePermissionGroupInput{} } - output = &GetDatasetOutput{} + output = &DeletePermissionGroupOutput{} req = c.newRequest(op, input, output) return } -// GetDataset API operation for FinSpace Public API. +// DeletePermissionGroup API operation for FinSpace Public API. // -// Returns information about a Dataset. +// Deletes a permission group. This action is irreversible. // // 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 FinSpace Public API's -// API operation GetDataset for usage and error information. +// API operation DeletePermissionGroup for usage and error information. // // Returned Error Types: // * InternalServerException @@ -657,83 +661,86 @@ func (c *FinSpaceData) GetDatasetRequest(input *GetDatasetInput) (req *request.R // * ResourceNotFoundException // One or more resources can't be found. // +// * LimitExceededException +// A limit has exceeded. +// // * ConflictException // The request conflicts with an existing resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataset -func (c *FinSpaceData) GetDataset(input *GetDatasetInput) (*GetDatasetOutput, error) { - req, out := c.GetDatasetRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DeletePermissionGroup +func (c *FinSpaceData) DeletePermissionGroup(input *DeletePermissionGroupInput) (*DeletePermissionGroupOutput, error) { + req, out := c.DeletePermissionGroupRequest(input) return out, req.Send() } -// GetDatasetWithContext is the same as GetDataset with the addition of +// DeletePermissionGroupWithContext is the same as DeletePermissionGroup with the addition of // the ability to pass a context and additional request options. // -// See GetDataset for details on how to use this API operation. +// See DeletePermissionGroup 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 *FinSpaceData) GetDatasetWithContext(ctx aws.Context, input *GetDatasetInput, opts ...request.Option) (*GetDatasetOutput, error) { - req, out := c.GetDatasetRequest(input) +func (c *FinSpaceData) DeletePermissionGroupWithContext(ctx aws.Context, input *DeletePermissionGroupInput, opts ...request.Option) (*DeletePermissionGroupOutput, error) { + req, out := c.DeletePermissionGroupRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opGetProgrammaticAccessCredentials = "GetProgrammaticAccessCredentials" +const opDisableUser = "DisableUser" -// GetProgrammaticAccessCredentialsRequest generates a "aws/request.Request" representing the -// client's request for the GetProgrammaticAccessCredentials operation. The "output" return +// DisableUserRequest generates a "aws/request.Request" representing the +// client's request for the DisableUser 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 GetProgrammaticAccessCredentials for more information on using the GetProgrammaticAccessCredentials +// See DisableUser for more information on using the DisableUser // 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 GetProgrammaticAccessCredentialsRequest method. -// req, resp := client.GetProgrammaticAccessCredentialsRequest(params) +// // Example sending a request using the DisableUserRequest method. +// req, resp := client.DisableUserRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetProgrammaticAccessCredentials -func (c *FinSpaceData) GetProgrammaticAccessCredentialsRequest(input *GetProgrammaticAccessCredentialsInput) (req *request.Request, output *GetProgrammaticAccessCredentialsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisableUser +func (c *FinSpaceData) DisableUserRequest(input *DisableUserInput) (req *request.Request, output *DisableUserOutput) { op := &request.Operation{ - Name: opGetProgrammaticAccessCredentials, - HTTPMethod: "GET", - HTTPPath: "/credentials/programmatic", + Name: opDisableUser, + HTTPMethod: "POST", + HTTPPath: "/user/{userId}/disable", } if input == nil { - input = &GetProgrammaticAccessCredentialsInput{} + input = &DisableUserInput{} } - output = &GetProgrammaticAccessCredentialsOutput{} + output = &DisableUserOutput{} req = c.newRequest(op, input, output) return } -// GetProgrammaticAccessCredentials API operation for FinSpace Public API. +// DisableUser API operation for FinSpace Public API. // -// Request programmatic credentials to use with FinSpace SDK. +// Denies access to the FinSpace web application and API for the specified user. // // 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 FinSpace Public API's -// API operation GetProgrammaticAccessCredentials for usage and error information. +// API operation DisableUser for usage and error information. // // Returned Error Types: // * InternalServerException @@ -749,176 +756,184 @@ func (c *FinSpaceData) GetProgrammaticAccessCredentialsRequest(input *GetProgram // * AccessDeniedException // You do not have sufficient access to perform this action. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetProgrammaticAccessCredentials -func (c *FinSpaceData) GetProgrammaticAccessCredentials(input *GetProgrammaticAccessCredentialsInput) (*GetProgrammaticAccessCredentialsOutput, error) { - req, out := c.GetProgrammaticAccessCredentialsRequest(input) +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ConflictException +// The request conflicts with an existing resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisableUser +func (c *FinSpaceData) DisableUser(input *DisableUserInput) (*DisableUserOutput, error) { + req, out := c.DisableUserRequest(input) return out, req.Send() } -// GetProgrammaticAccessCredentialsWithContext is the same as GetProgrammaticAccessCredentials with the addition of +// DisableUserWithContext is the same as DisableUser with the addition of // the ability to pass a context and additional request options. // -// See GetProgrammaticAccessCredentials for details on how to use this API operation. +// See DisableUser 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 *FinSpaceData) GetProgrammaticAccessCredentialsWithContext(ctx aws.Context, input *GetProgrammaticAccessCredentialsInput, opts ...request.Option) (*GetProgrammaticAccessCredentialsOutput, error) { - req, out := c.GetProgrammaticAccessCredentialsRequest(input) +func (c *FinSpaceData) DisableUserWithContext(ctx aws.Context, input *DisableUserInput, opts ...request.Option) (*DisableUserOutput, error) { + req, out := c.DisableUserRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opGetWorkingLocation = "GetWorkingLocation" +const opEnableUser = "EnableUser" -// GetWorkingLocationRequest generates a "aws/request.Request" representing the -// client's request for the GetWorkingLocation operation. The "output" return +// EnableUserRequest generates a "aws/request.Request" representing the +// client's request for the EnableUser 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 GetWorkingLocation for more information on using the GetWorkingLocation +// See EnableUser for more information on using the EnableUser // 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 GetWorkingLocationRequest method. -// req, resp := client.GetWorkingLocationRequest(params) +// // Example sending a request using the EnableUserRequest method. +// req, resp := client.EnableUserRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetWorkingLocation -func (c *FinSpaceData) GetWorkingLocationRequest(input *GetWorkingLocationInput) (req *request.Request, output *GetWorkingLocationOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/EnableUser +func (c *FinSpaceData) EnableUserRequest(input *EnableUserInput) (req *request.Request, output *EnableUserOutput) { op := &request.Operation{ - Name: opGetWorkingLocation, + Name: opEnableUser, HTTPMethod: "POST", - HTTPPath: "/workingLocationV1", + HTTPPath: "/user/{userId}/enable", } if input == nil { - input = &GetWorkingLocationInput{} + input = &EnableUserInput{} } - output = &GetWorkingLocationOutput{} + output = &EnableUserOutput{} req = c.newRequest(op, input, output) return } -// GetWorkingLocation API operation for FinSpace Public API. +// EnableUser API operation for FinSpace Public API. // -// A temporary Amazon S3 location, where you can copy your files from a source -// location to stage or use as a scratch space in FinSpace notebook. +// Allows the specified user to access the FinSpace web application and API. // // 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 FinSpace Public API's -// API operation GetWorkingLocation for usage and error information. +// API operation EnableUser for usage and error information. // // Returned Error Types: // * InternalServerException // The request processing has failed because of an unknown error, exception // or failure. // -// * AccessDeniedException -// You do not have sufficient access to perform this action. +// * ValidationException +// The input fails to satisfy the constraints specified by an AWS service. // // * ThrottlingException // The request was denied due to request throttling. // -// * ValidationException -// The input fails to satisfy the constraints specified by an AWS service. +// * AccessDeniedException +// You do not have sufficient access to perform this action. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetWorkingLocation -func (c *FinSpaceData) GetWorkingLocation(input *GetWorkingLocationInput) (*GetWorkingLocationOutput, error) { - req, out := c.GetWorkingLocationRequest(input) +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * LimitExceededException +// A limit has exceeded. +// +// * ConflictException +// The request conflicts with an existing resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/EnableUser +func (c *FinSpaceData) EnableUser(input *EnableUserInput) (*EnableUserOutput, error) { + req, out := c.EnableUserRequest(input) return out, req.Send() } -// GetWorkingLocationWithContext is the same as GetWorkingLocation with the addition of +// EnableUserWithContext is the same as EnableUser with the addition of // the ability to pass a context and additional request options. // -// See GetWorkingLocation for details on how to use this API operation. +// See EnableUser 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 *FinSpaceData) GetWorkingLocationWithContext(ctx aws.Context, input *GetWorkingLocationInput, opts ...request.Option) (*GetWorkingLocationOutput, error) { - req, out := c.GetWorkingLocationRequest(input) +func (c *FinSpaceData) EnableUserWithContext(ctx aws.Context, input *EnableUserInput, opts ...request.Option) (*EnableUserOutput, error) { + req, out := c.EnableUserRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opListChangesets = "ListChangesets" +const opGetChangeset = "GetChangeset" -// ListChangesetsRequest generates a "aws/request.Request" representing the -// client's request for the ListChangesets operation. The "output" return +// GetChangesetRequest generates a "aws/request.Request" representing the +// client's request for the GetChangeset 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 ListChangesets for more information on using the ListChangesets +// See GetChangeset for more information on using the GetChangeset // 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 ListChangesetsRequest method. -// req, resp := client.ListChangesetsRequest(params) +// // Example sending a request using the GetChangesetRequest method. +// req, resp := client.GetChangesetRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListChangesets -func (c *FinSpaceData) ListChangesetsRequest(input *ListChangesetsInput) (req *request.Request, output *ListChangesetsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetChangeset +func (c *FinSpaceData) GetChangesetRequest(input *GetChangesetInput) (req *request.Request, output *GetChangesetOutput) { op := &request.Operation{ - Name: opListChangesets, + Name: opGetChangeset, HTTPMethod: "GET", - HTTPPath: "/datasets/{datasetId}/changesetsv2", - Paginator: &request.Paginator{ - InputTokens: []string{"nextToken"}, - OutputTokens: []string{"nextToken"}, - LimitToken: "maxResults", - TruncationToken: "", - }, + HTTPPath: "/datasets/{datasetId}/changesetsv2/{changesetId}", } if input == nil { - input = &ListChangesetsInput{} + input = &GetChangesetInput{} } - output = &ListChangesetsOutput{} + output = &GetChangesetOutput{} req = c.newRequest(op, input, output) return } -// ListChangesets API operation for FinSpace Public API. +// GetChangeset API operation for FinSpace Public API. // -// Lists the FinSpace Changesets for a Dataset. +// Get information about a Changeset. // // 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 FinSpace Public API's -// API operation ListChangesets for usage and error information. +// API operation GetChangeset for usage and error information. // // Returned Error Types: // * ResourceNotFoundException @@ -940,138 +955,80 @@ func (c *FinSpaceData) ListChangesetsRequest(input *ListChangesetsInput) (req *r // * ConflictException // The request conflicts with an existing resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListChangesets -func (c *FinSpaceData) ListChangesets(input *ListChangesetsInput) (*ListChangesetsOutput, error) { - req, out := c.ListChangesetsRequest(input) - return out, req.Send() +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetChangeset +func (c *FinSpaceData) GetChangeset(input *GetChangesetInput) (*GetChangesetOutput, error) { + req, out := c.GetChangesetRequest(input) + return out, req.Send() } -// ListChangesetsWithContext is the same as ListChangesets with the addition of +// GetChangesetWithContext is the same as GetChangeset with the addition of // the ability to pass a context and additional request options. // -// See ListChangesets for details on how to use this API operation. +// See GetChangeset 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 *FinSpaceData) ListChangesetsWithContext(ctx aws.Context, input *ListChangesetsInput, opts ...request.Option) (*ListChangesetsOutput, error) { - req, out := c.ListChangesetsRequest(input) +func (c *FinSpaceData) GetChangesetWithContext(ctx aws.Context, input *GetChangesetInput, opts ...request.Option) (*GetChangesetOutput, error) { + req, out := c.GetChangesetRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListChangesetsPages iterates over the pages of a ListChangesets operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. -// -// See ListChangesets 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 ListChangesets operation. -// pageNum := 0 -// err := client.ListChangesetsPages(params, -// func(page *finspacedata.ListChangesetsOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) -// -func (c *FinSpaceData) ListChangesetsPages(input *ListChangesetsInput, fn func(*ListChangesetsOutput, bool) bool) error { - return c.ListChangesetsPagesWithContext(aws.BackgroundContext(), input, fn) -} - -// ListChangesetsPagesWithContext same as ListChangesetsPages 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 *FinSpaceData) ListChangesetsPagesWithContext(ctx aws.Context, input *ListChangesetsInput, fn func(*ListChangesetsOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *ListChangesetsInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.ListChangesetsRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*ListChangesetsOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - -const opListDataViews = "ListDataViews" +const opGetDataView = "GetDataView" -// ListDataViewsRequest generates a "aws/request.Request" representing the -// client's request for the ListDataViews operation. The "output" return +// GetDataViewRequest generates a "aws/request.Request" representing the +// client's request for the GetDataView 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 ListDataViews for more information on using the ListDataViews +// See GetDataView for more information on using the GetDataView // 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 ListDataViewsRequest method. -// req, resp := client.ListDataViewsRequest(params) +// // Example sending a request using the GetDataViewRequest method. +// req, resp := client.GetDataViewRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDataViews -func (c *FinSpaceData) ListDataViewsRequest(input *ListDataViewsInput) (req *request.Request, output *ListDataViewsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataView +func (c *FinSpaceData) GetDataViewRequest(input *GetDataViewInput) (req *request.Request, output *GetDataViewOutput) { op := &request.Operation{ - Name: opListDataViews, + Name: opGetDataView, HTTPMethod: "GET", - HTTPPath: "/datasets/{datasetId}/dataviewsv2", - Paginator: &request.Paginator{ - InputTokens: []string{"nextToken"}, - OutputTokens: []string{"nextToken"}, - LimitToken: "maxResults", - TruncationToken: "", - }, + HTTPPath: "/datasets/{datasetId}/dataviewsv2/{dataviewId}", } if input == nil { - input = &ListDataViewsInput{} + input = &GetDataViewInput{} } - output = &ListDataViewsOutput{} + output = &GetDataViewOutput{} req = c.newRequest(op, input, output) return } -// ListDataViews API operation for FinSpace Public API. +// GetDataView API operation for FinSpace Public API. // -// Lists all available Dataviews for a Dataset. +// Gets information about a Dataview. // // 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 FinSpace Public API's -// API operation ListDataViews for usage and error information. +// API operation GetDataView for usage and error information. // // Returned Error Types: // * ResourceNotFoundException @@ -1090,287 +1047,266 @@ func (c *FinSpaceData) ListDataViewsRequest(input *ListDataViewsInput) (req *req // * ConflictException // The request conflicts with an existing resource. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDataViews -func (c *FinSpaceData) ListDataViews(input *ListDataViewsInput) (*ListDataViewsOutput, error) { - req, out := c.ListDataViewsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataView +func (c *FinSpaceData) GetDataView(input *GetDataViewInput) (*GetDataViewOutput, error) { + req, out := c.GetDataViewRequest(input) return out, req.Send() } -// ListDataViewsWithContext is the same as ListDataViews with the addition of +// GetDataViewWithContext is the same as GetDataView with the addition of // the ability to pass a context and additional request options. // -// See ListDataViews for details on how to use this API operation. +// See GetDataView 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 *FinSpaceData) ListDataViewsWithContext(ctx aws.Context, input *ListDataViewsInput, opts ...request.Option) (*ListDataViewsOutput, error) { - req, out := c.ListDataViewsRequest(input) +func (c *FinSpaceData) GetDataViewWithContext(ctx aws.Context, input *GetDataViewInput, opts ...request.Option) (*GetDataViewOutput, error) { + req, out := c.GetDataViewRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListDataViewsPages iterates over the pages of a ListDataViews operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. -// -// See ListDataViews 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 ListDataViews operation. -// pageNum := 0 -// err := client.ListDataViewsPages(params, -// func(page *finspacedata.ListDataViewsOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) -// -func (c *FinSpaceData) ListDataViewsPages(input *ListDataViewsInput, fn func(*ListDataViewsOutput, bool) bool) error { - return c.ListDataViewsPagesWithContext(aws.BackgroundContext(), input, fn) -} - -// ListDataViewsPagesWithContext same as ListDataViewsPages 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 *FinSpaceData) ListDataViewsPagesWithContext(ctx aws.Context, input *ListDataViewsInput, fn func(*ListDataViewsOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *ListDataViewsInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.ListDataViewsRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*ListDataViewsOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - -const opListDatasets = "ListDatasets" +const opGetDataset = "GetDataset" -// ListDatasetsRequest generates a "aws/request.Request" representing the -// client's request for the ListDatasets operation. The "output" return +// GetDatasetRequest generates a "aws/request.Request" representing the +// client's request for the GetDataset 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 ListDatasets for more information on using the ListDatasets +// See GetDataset for more information on using the GetDataset // 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 ListDatasetsRequest method. -// req, resp := client.ListDatasetsRequest(params) +// // Example sending a request using the GetDatasetRequest method. +// req, resp := client.GetDatasetRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDatasets -func (c *FinSpaceData) ListDatasetsRequest(input *ListDatasetsInput) (req *request.Request, output *ListDatasetsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataset +func (c *FinSpaceData) GetDatasetRequest(input *GetDatasetInput) (req *request.Request, output *GetDatasetOutput) { op := &request.Operation{ - Name: opListDatasets, + Name: opGetDataset, HTTPMethod: "GET", - HTTPPath: "/datasetsv2", - Paginator: &request.Paginator{ - InputTokens: []string{"nextToken"}, - OutputTokens: []string{"nextToken"}, - LimitToken: "maxResults", - TruncationToken: "", - }, + HTTPPath: "/datasetsv2/{datasetId}", } if input == nil { - input = &ListDatasetsInput{} + input = &GetDatasetInput{} } - output = &ListDatasetsOutput{} + output = &GetDatasetOutput{} req = c.newRequest(op, input, output) return } -// ListDatasets API operation for FinSpace Public API. +// GetDataset API operation for FinSpace Public API. // -// Lists all of the active Datasets that a user has access to. +// Returns information about a Dataset. // // 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 FinSpace Public API's -// API operation ListDatasets for usage and error information. +// API operation GetDataset for usage and error information. // // Returned Error Types: // * InternalServerException // The request processing has failed because of an unknown error, exception // or failure. // -// * ThrottlingException -// The request was denied due to request throttling. -// // * ValidationException // The input fails to satisfy the constraints specified by an AWS service. // -// * ConflictException -// The request conflicts with an existing resource. +// * ThrottlingException +// The request was denied due to request throttling. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. // // * ResourceNotFoundException // One or more resources can't be found. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDatasets -func (c *FinSpaceData) ListDatasets(input *ListDatasetsInput) (*ListDatasetsOutput, error) { - req, out := c.ListDatasetsRequest(input) +// * ConflictException +// The request conflicts with an existing resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetDataset +func (c *FinSpaceData) GetDataset(input *GetDatasetInput) (*GetDatasetOutput, error) { + req, out := c.GetDatasetRequest(input) return out, req.Send() } -// ListDatasetsWithContext is the same as ListDatasets with the addition of +// GetDatasetWithContext is the same as GetDataset with the addition of // the ability to pass a context and additional request options. // -// See ListDatasets for details on how to use this API operation. +// See GetDataset 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 *FinSpaceData) ListDatasetsWithContext(ctx aws.Context, input *ListDatasetsInput, opts ...request.Option) (*ListDatasetsOutput, error) { - req, out := c.ListDatasetsRequest(input) +func (c *FinSpaceData) GetDatasetWithContext(ctx aws.Context, input *GetDatasetInput, opts ...request.Option) (*GetDatasetOutput, error) { + req, out := c.GetDatasetRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListDatasetsPages iterates over the pages of a ListDatasets operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. +const opGetProgrammaticAccessCredentials = "GetProgrammaticAccessCredentials" + +// GetProgrammaticAccessCredentialsRequest generates a "aws/request.Request" representing the +// client's request for the GetProgrammaticAccessCredentials operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. // -// See ListDatasets method for more information on how to use this operation. +// 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. // -// Note: This operation can generate multiple requests to a service. +// See GetProgrammaticAccessCredentials for more information on using the GetProgrammaticAccessCredentials +// API call, and error handling. // -// // Example iterating over at most 3 pages of a ListDatasets operation. -// pageNum := 0 -// err := client.ListDatasetsPages(params, -// func(page *finspacedata.ListDatasetsOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) +// 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. // -func (c *FinSpaceData) ListDatasetsPages(input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool) error { - return c.ListDatasetsPagesWithContext(aws.BackgroundContext(), input, fn) +// +// // Example sending a request using the GetProgrammaticAccessCredentialsRequest method. +// req, resp := client.GetProgrammaticAccessCredentialsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetProgrammaticAccessCredentials +func (c *FinSpaceData) GetProgrammaticAccessCredentialsRequest(input *GetProgrammaticAccessCredentialsInput) (req *request.Request, output *GetProgrammaticAccessCredentialsOutput) { + op := &request.Operation{ + Name: opGetProgrammaticAccessCredentials, + HTTPMethod: "GET", + HTTPPath: "/credentials/programmatic", + } + + if input == nil { + input = &GetProgrammaticAccessCredentialsInput{} + } + + output = &GetProgrammaticAccessCredentialsOutput{} + req = c.newRequest(op, input, output) + return } -// ListDatasetsPagesWithContext same as ListDatasetsPages except -// it takes a Context and allows setting request options on the pages. +// GetProgrammaticAccessCredentials API operation for FinSpace Public API. +// +// Request programmatic credentials to use with FinSpace SDK. +// +// 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 FinSpace Public API's +// API operation GetProgrammaticAccessCredentials for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// The request processing has failed because of an unknown error, exception +// or failure. +// +// * ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetProgrammaticAccessCredentials +func (c *FinSpaceData) GetProgrammaticAccessCredentials(input *GetProgrammaticAccessCredentialsInput) (*GetProgrammaticAccessCredentialsOutput, error) { + req, out := c.GetProgrammaticAccessCredentialsRequest(input) + return out, req.Send() +} + +// GetProgrammaticAccessCredentialsWithContext is the same as GetProgrammaticAccessCredentials with the addition of +// the ability to pass a context and additional request options. +// +// See GetProgrammaticAccessCredentials 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 *FinSpaceData) ListDatasetsPagesWithContext(ctx aws.Context, input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *ListDatasetsInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.ListDatasetsRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*ListDatasetsOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() +func (c *FinSpaceData) GetProgrammaticAccessCredentialsWithContext(ctx aws.Context, input *GetProgrammaticAccessCredentialsInput, opts ...request.Option) (*GetProgrammaticAccessCredentialsOutput, error) { + req, out := c.GetProgrammaticAccessCredentialsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() } -const opUpdateChangeset = "UpdateChangeset" +const opGetUser = "GetUser" -// UpdateChangesetRequest generates a "aws/request.Request" representing the -// client's request for the UpdateChangeset operation. The "output" return +// GetUserRequest generates a "aws/request.Request" representing the +// client's request for the GetUser 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 UpdateChangeset for more information on using the UpdateChangeset +// See GetUser for more information on using the GetUser // 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 UpdateChangesetRequest method. -// req, resp := client.UpdateChangesetRequest(params) +// // Example sending a request using the GetUserRequest method. +// req, resp := client.GetUserRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateChangeset -func (c *FinSpaceData) UpdateChangesetRequest(input *UpdateChangesetInput) (req *request.Request, output *UpdateChangesetOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetUser +func (c *FinSpaceData) GetUserRequest(input *GetUserInput) (req *request.Request, output *GetUserOutput) { op := &request.Operation{ - Name: opUpdateChangeset, - HTTPMethod: "PUT", - HTTPPath: "/datasets/{datasetId}/changesetsv2/{changesetId}", + Name: opGetUser, + HTTPMethod: "GET", + HTTPPath: "/user/{userId}", } if input == nil { - input = &UpdateChangesetInput{} + input = &GetUserInput{} } - output = &UpdateChangesetOutput{} + output = &GetUserOutput{} req = c.newRequest(op, input, output) return } -// UpdateChangeset API operation for FinSpace Public API. +// GetUser API operation for FinSpace Public API. // -// Updates a FinSpace Changeset. +// Retrieves details for a specific user. // // 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 FinSpace Public API's -// API operation UpdateChangeset for usage and error information. +// API operation GetUser for usage and error information. // // Returned Error Types: -// * ResourceNotFoundException -// One or more resources can't be found. -// // * InternalServerException // The request processing has failed because of an unknown error, exception // or failure. @@ -1384,213 +1320,2763 @@ func (c *FinSpaceData) UpdateChangesetRequest(input *UpdateChangesetInput) (req // * AccessDeniedException // You do not have sufficient access to perform this action. // -// * ConflictException -// The request conflicts with an existing resource. +// * ResourceNotFoundException +// One or more resources can't be found. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateChangeset -func (c *FinSpaceData) UpdateChangeset(input *UpdateChangesetInput) (*UpdateChangesetOutput, error) { - req, out := c.UpdateChangesetRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetUser +func (c *FinSpaceData) GetUser(input *GetUserInput) (*GetUserOutput, error) { + req, out := c.GetUserRequest(input) return out, req.Send() } -// UpdateChangesetWithContext is the same as UpdateChangeset with the addition of +// GetUserWithContext is the same as GetUser with the addition of // the ability to pass a context and additional request options. // -// See UpdateChangeset for details on how to use this API operation. +// See GetUser 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 *FinSpaceData) UpdateChangesetWithContext(ctx aws.Context, input *UpdateChangesetInput, opts ...request.Option) (*UpdateChangesetOutput, error) { - req, out := c.UpdateChangesetRequest(input) +func (c *FinSpaceData) GetUserWithContext(ctx aws.Context, input *GetUserInput, opts ...request.Option) (*GetUserOutput, error) { + req, out := c.GetUserRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateDataset = "UpdateDataset" +const opGetWorkingLocation = "GetWorkingLocation" -// UpdateDatasetRequest generates a "aws/request.Request" representing the -// client's request for the UpdateDataset operation. The "output" return +// GetWorkingLocationRequest generates a "aws/request.Request" representing the +// client's request for the GetWorkingLocation 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 UpdateDataset for more information on using the UpdateDataset +// See GetWorkingLocation for more information on using the GetWorkingLocation // 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 UpdateDatasetRequest method. -// req, resp := client.UpdateDatasetRequest(params) +// // Example sending a request using the GetWorkingLocationRequest method. +// req, resp := client.GetWorkingLocationRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateDataset -func (c *FinSpaceData) UpdateDatasetRequest(input *UpdateDatasetInput) (req *request.Request, output *UpdateDatasetOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetWorkingLocation +func (c *FinSpaceData) GetWorkingLocationRequest(input *GetWorkingLocationInput) (req *request.Request, output *GetWorkingLocationOutput) { op := &request.Operation{ - Name: opUpdateDataset, - HTTPMethod: "PUT", - HTTPPath: "/datasetsv2/{datasetId}", + Name: opGetWorkingLocation, + HTTPMethod: "POST", + HTTPPath: "/workingLocationV1", } if input == nil { - input = &UpdateDatasetInput{} + input = &GetWorkingLocationInput{} } - output = &UpdateDatasetOutput{} + output = &GetWorkingLocationOutput{} req = c.newRequest(op, input, output) return } -// UpdateDataset API operation for FinSpace Public API. +// GetWorkingLocation API operation for FinSpace Public API. // -// Updates a FinSpace Dataset. +// A temporary Amazon S3 location, where you can copy your files from a source +// location to stage or use as a scratch space in FinSpace notebook. // // 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 FinSpace Public API's -// API operation UpdateDataset for usage and error information. +// API operation GetWorkingLocation for usage and error information. // // Returned Error Types: // * InternalServerException // The request processing has failed because of an unknown error, exception // or failure. // -// * ValidationException -// The input fails to satisfy the constraints specified by an AWS service. -// -// * ThrottlingException -// The request was denied due to request throttling. -// // * AccessDeniedException // You do not have sufficient access to perform this action. // -// * ConflictException -// The request conflicts with an existing resource. +// * ThrottlingException +// The request was denied due to request throttling. // -// * ResourceNotFoundException -// One or more resources can't be found. +// * ValidationException +// The input fails to satisfy the constraints specified by an AWS service. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateDataset -func (c *FinSpaceData) UpdateDataset(input *UpdateDatasetInput) (*UpdateDatasetOutput, error) { - req, out := c.UpdateDatasetRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetWorkingLocation +func (c *FinSpaceData) GetWorkingLocation(input *GetWorkingLocationInput) (*GetWorkingLocationOutput, error) { + req, out := c.GetWorkingLocationRequest(input) return out, req.Send() } -// UpdateDatasetWithContext is the same as UpdateDataset with the addition of +// GetWorkingLocationWithContext is the same as GetWorkingLocation with the addition of // the ability to pass a context and additional request options. // -// See UpdateDataset for details on how to use this API operation. +// See GetWorkingLocation 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 *FinSpaceData) UpdateDatasetWithContext(ctx aws.Context, input *UpdateDatasetInput, opts ...request.Option) (*UpdateDatasetOutput, error) { - req, out := c.UpdateDatasetRequest(input) +func (c *FinSpaceData) GetWorkingLocationWithContext(ctx aws.Context, input *GetWorkingLocationInput, opts ...request.Option) (*GetWorkingLocationOutput, error) { + req, out := c.GetWorkingLocationRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// You do not have sufficient access to perform this action. -type AccessDeniedException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - - Message_ *string `locationName:"message" type:"string"` -} +const opListChangesets = "ListChangesets" -// String returns the string representation. +// ListChangesetsRequest generates a "aws/request.Request" representing the +// client's request for the ListChangesets operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. // -// 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 AccessDeniedException) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation. +// 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. // -// 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 AccessDeniedException) GoString() string { - return s.String() -} +// See ListChangesets for more information on using the ListChangesets +// 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 ListChangesetsRequest method. +// req, resp := client.ListChangesetsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListChangesets +func (c *FinSpaceData) ListChangesetsRequest(input *ListChangesetsInput) (req *request.Request, output *ListChangesetsOutput) { + op := &request.Operation{ + Name: opListChangesets, + HTTPMethod: "GET", + HTTPPath: "/datasets/{datasetId}/changesetsv2", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } -func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { - return &AccessDeniedException{ - RespMetadata: v, + if input == nil { + input = &ListChangesetsInput{} } -} -// Code returns the exception type name. -func (s *AccessDeniedException) Code() string { - return "AccessDeniedException" + output = &ListChangesetsOutput{} + req = c.newRequest(op, input, output) + return } -// Message returns the exception's message. -func (s *AccessDeniedException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" -} +// ListChangesets API operation for FinSpace Public API. +// +// Lists the FinSpace Changesets for a Dataset. +// +// 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 FinSpace Public API's +// API operation ListChangesets for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * InternalServerException +// The request processing has failed because of an unknown error, exception +// or failure. +// +// * ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ConflictException +// The request conflicts with an existing resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListChangesets +func (c *FinSpaceData) ListChangesets(input *ListChangesetsInput) (*ListChangesetsOutput, error) { + req, out := c.ListChangesetsRequest(input) + return out, req.Send() +} + +// ListChangesetsWithContext is the same as ListChangesets with the addition of +// the ability to pass a context and additional request options. +// +// See ListChangesets 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 *FinSpaceData) ListChangesetsWithContext(ctx aws.Context, input *ListChangesetsInput, opts ...request.Option) (*ListChangesetsOutput, error) { + req, out := c.ListChangesetsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListChangesetsPages iterates over the pages of a ListChangesets operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListChangesets 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 ListChangesets operation. +// pageNum := 0 +// err := client.ListChangesetsPages(params, +// func(page *finspacedata.ListChangesetsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *FinSpaceData) ListChangesetsPages(input *ListChangesetsInput, fn func(*ListChangesetsOutput, bool) bool) error { + return c.ListChangesetsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListChangesetsPagesWithContext same as ListChangesetsPages 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 *FinSpaceData) ListChangesetsPagesWithContext(ctx aws.Context, input *ListChangesetsInput, fn func(*ListChangesetsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListChangesetsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListChangesetsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListChangesetsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListDataViews = "ListDataViews" + +// ListDataViewsRequest generates a "aws/request.Request" representing the +// client's request for the ListDataViews 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 ListDataViews for more information on using the ListDataViews +// 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 ListDataViewsRequest method. +// req, resp := client.ListDataViewsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDataViews +func (c *FinSpaceData) ListDataViewsRequest(input *ListDataViewsInput) (req *request.Request, output *ListDataViewsOutput) { + op := &request.Operation{ + Name: opListDataViews, + HTTPMethod: "GET", + HTTPPath: "/datasets/{datasetId}/dataviewsv2", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListDataViewsInput{} + } + + output = &ListDataViewsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListDataViews API operation for FinSpace Public API. +// +// Lists all available Dataviews for a Dataset. +// +// 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 FinSpace Public API's +// API operation ListDataViews for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * InternalServerException +// The request processing has failed because of an unknown error, exception +// or failure. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// * ConflictException +// The request conflicts with an existing resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDataViews +func (c *FinSpaceData) ListDataViews(input *ListDataViewsInput) (*ListDataViewsOutput, error) { + req, out := c.ListDataViewsRequest(input) + return out, req.Send() +} + +// ListDataViewsWithContext is the same as ListDataViews with the addition of +// the ability to pass a context and additional request options. +// +// See ListDataViews 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 *FinSpaceData) ListDataViewsWithContext(ctx aws.Context, input *ListDataViewsInput, opts ...request.Option) (*ListDataViewsOutput, error) { + req, out := c.ListDataViewsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListDataViewsPages iterates over the pages of a ListDataViews operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListDataViews 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 ListDataViews operation. +// pageNum := 0 +// err := client.ListDataViewsPages(params, +// func(page *finspacedata.ListDataViewsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *FinSpaceData) ListDataViewsPages(input *ListDataViewsInput, fn func(*ListDataViewsOutput, bool) bool) error { + return c.ListDataViewsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListDataViewsPagesWithContext same as ListDataViewsPages 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 *FinSpaceData) ListDataViewsPagesWithContext(ctx aws.Context, input *ListDataViewsInput, fn func(*ListDataViewsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListDataViewsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListDataViewsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListDataViewsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListDatasets = "ListDatasets" + +// ListDatasetsRequest generates a "aws/request.Request" representing the +// client's request for the ListDatasets 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 ListDatasets for more information on using the ListDatasets +// 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 ListDatasetsRequest method. +// req, resp := client.ListDatasetsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDatasets +func (c *FinSpaceData) ListDatasetsRequest(input *ListDatasetsInput) (req *request.Request, output *ListDatasetsOutput) { + op := &request.Operation{ + Name: opListDatasets, + HTTPMethod: "GET", + HTTPPath: "/datasetsv2", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListDatasetsInput{} + } + + output = &ListDatasetsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListDatasets API operation for FinSpace Public API. +// +// Lists all of the active Datasets that a user has access to. +// +// 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 FinSpace Public API's +// API operation ListDatasets for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// The request processing has failed because of an unknown error, exception +// or failure. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// * ConflictException +// The request conflicts with an existing resource. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListDatasets +func (c *FinSpaceData) ListDatasets(input *ListDatasetsInput) (*ListDatasetsOutput, error) { + req, out := c.ListDatasetsRequest(input) + return out, req.Send() +} + +// ListDatasetsWithContext is the same as ListDatasets with the addition of +// the ability to pass a context and additional request options. +// +// See ListDatasets 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 *FinSpaceData) ListDatasetsWithContext(ctx aws.Context, input *ListDatasetsInput, opts ...request.Option) (*ListDatasetsOutput, error) { + req, out := c.ListDatasetsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListDatasetsPages iterates over the pages of a ListDatasets operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListDatasets 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 ListDatasets operation. +// pageNum := 0 +// err := client.ListDatasetsPages(params, +// func(page *finspacedata.ListDatasetsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *FinSpaceData) ListDatasetsPages(input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool) error { + return c.ListDatasetsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListDatasetsPagesWithContext same as ListDatasetsPages 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 *FinSpaceData) ListDatasetsPagesWithContext(ctx aws.Context, input *ListDatasetsInput, fn func(*ListDatasetsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListDatasetsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListDatasetsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListDatasetsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListPermissionGroups = "ListPermissionGroups" + +// ListPermissionGroupsRequest generates a "aws/request.Request" representing the +// client's request for the ListPermissionGroups 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 ListPermissionGroups for more information on using the ListPermissionGroups +// 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 ListPermissionGroupsRequest method. +// req, resp := client.ListPermissionGroupsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroups +func (c *FinSpaceData) ListPermissionGroupsRequest(input *ListPermissionGroupsInput) (req *request.Request, output *ListPermissionGroupsOutput) { + op := &request.Operation{ + Name: opListPermissionGroups, + HTTPMethod: "GET", + HTTPPath: "/permission-group", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListPermissionGroupsInput{} + } + + output = &ListPermissionGroupsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListPermissionGroups API operation for FinSpace Public API. +// +// Lists all available permission groups in FinSpace. +// +// 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 FinSpace Public API's +// API operation ListPermissionGroups for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// The request processing has failed because of an unknown error, exception +// or failure. +// +// * ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroups +func (c *FinSpaceData) ListPermissionGroups(input *ListPermissionGroupsInput) (*ListPermissionGroupsOutput, error) { + req, out := c.ListPermissionGroupsRequest(input) + return out, req.Send() +} + +// ListPermissionGroupsWithContext is the same as ListPermissionGroups with the addition of +// the ability to pass a context and additional request options. +// +// See ListPermissionGroups 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 *FinSpaceData) ListPermissionGroupsWithContext(ctx aws.Context, input *ListPermissionGroupsInput, opts ...request.Option) (*ListPermissionGroupsOutput, error) { + req, out := c.ListPermissionGroupsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListPermissionGroupsPages iterates over the pages of a ListPermissionGroups operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListPermissionGroups 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 ListPermissionGroups operation. +// pageNum := 0 +// err := client.ListPermissionGroupsPages(params, +// func(page *finspacedata.ListPermissionGroupsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *FinSpaceData) ListPermissionGroupsPages(input *ListPermissionGroupsInput, fn func(*ListPermissionGroupsOutput, bool) bool) error { + return c.ListPermissionGroupsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListPermissionGroupsPagesWithContext same as ListPermissionGroupsPages 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 *FinSpaceData) ListPermissionGroupsPagesWithContext(ctx aws.Context, input *ListPermissionGroupsInput, fn func(*ListPermissionGroupsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListPermissionGroupsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListPermissionGroupsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListPermissionGroupsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListUsers = "ListUsers" + +// ListUsersRequest generates a "aws/request.Request" representing the +// client's request for the ListUsers 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 ListUsers for more information on using the ListUsers +// 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 ListUsersRequest method. +// req, resp := client.ListUsersRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsers +func (c *FinSpaceData) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersOutput) { + op := &request.Operation{ + Name: opListUsers, + HTTPMethod: "GET", + HTTPPath: "/user", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListUsersInput{} + } + + output = &ListUsersOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListUsers API operation for FinSpace Public API. +// +// Lists all available user accounts in FinSpace. +// +// 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 FinSpace Public API's +// API operation ListUsers for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// The request processing has failed because of an unknown error, exception +// or failure. +// +// * ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsers +func (c *FinSpaceData) ListUsers(input *ListUsersInput) (*ListUsersOutput, error) { + req, out := c.ListUsersRequest(input) + return out, req.Send() +} + +// ListUsersWithContext is the same as ListUsers with the addition of +// the ability to pass a context and additional request options. +// +// See ListUsers 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 *FinSpaceData) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersOutput, error) { + req, out := c.ListUsersRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListUsersPages iterates over the pages of a ListUsers operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListUsers 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 ListUsers operation. +// pageNum := 0 +// err := client.ListUsersPages(params, +// func(page *finspacedata.ListUsersOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *FinSpaceData) ListUsersPages(input *ListUsersInput, fn func(*ListUsersOutput, bool) bool) error { + return c.ListUsersPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListUsersPagesWithContext same as ListUsersPages 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 *FinSpaceData) ListUsersPagesWithContext(ctx aws.Context, input *ListUsersInput, fn func(*ListUsersOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListUsersInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListUsersRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListUsersOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opResetUserPassword = "ResetUserPassword" + +// ResetUserPasswordRequest generates a "aws/request.Request" representing the +// client's request for the ResetUserPassword 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 ResetUserPassword for more information on using the ResetUserPassword +// 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 ResetUserPasswordRequest method. +// req, resp := client.ResetUserPasswordRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ResetUserPassword +func (c *FinSpaceData) ResetUserPasswordRequest(input *ResetUserPasswordInput) (req *request.Request, output *ResetUserPasswordOutput) { + op := &request.Operation{ + Name: opResetUserPassword, + HTTPMethod: "POST", + HTTPPath: "/user/{userId}/password", + } + + if input == nil { + input = &ResetUserPasswordInput{} + } + + output = &ResetUserPasswordOutput{} + req = c.newRequest(op, input, output) + return +} + +// ResetUserPassword API operation for FinSpace Public API. +// +// Resets the password for a specified user ID and generates a temporary one. +// Only a superuser can reset password for other users. Resetting the password +// immediately invalidates the previous password associated with the user. +// +// 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 FinSpace Public API's +// API operation ResetUserPassword for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// The request processing has failed because of an unknown error, exception +// or failure. +// +// * ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ConflictException +// The request conflicts with an existing resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ResetUserPassword +func (c *FinSpaceData) ResetUserPassword(input *ResetUserPasswordInput) (*ResetUserPasswordOutput, error) { + req, out := c.ResetUserPasswordRequest(input) + return out, req.Send() +} + +// ResetUserPasswordWithContext is the same as ResetUserPassword with the addition of +// the ability to pass a context and additional request options. +// +// See ResetUserPassword 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 *FinSpaceData) ResetUserPasswordWithContext(ctx aws.Context, input *ResetUserPasswordInput, opts ...request.Option) (*ResetUserPasswordOutput, error) { + req, out := c.ResetUserPasswordRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateChangeset = "UpdateChangeset" + +// UpdateChangesetRequest generates a "aws/request.Request" representing the +// client's request for the UpdateChangeset 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 UpdateChangeset for more information on using the UpdateChangeset +// 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 UpdateChangesetRequest method. +// req, resp := client.UpdateChangesetRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateChangeset +func (c *FinSpaceData) UpdateChangesetRequest(input *UpdateChangesetInput) (req *request.Request, output *UpdateChangesetOutput) { + op := &request.Operation{ + Name: opUpdateChangeset, + HTTPMethod: "PUT", + HTTPPath: "/datasets/{datasetId}/changesetsv2/{changesetId}", + } + + if input == nil { + input = &UpdateChangesetInput{} + } + + output = &UpdateChangesetOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateChangeset API operation for FinSpace Public API. +// +// Updates a FinSpace Changeset. +// +// 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 FinSpace Public API's +// API operation UpdateChangeset for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * InternalServerException +// The request processing has failed because of an unknown error, exception +// or failure. +// +// * ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ConflictException +// The request conflicts with an existing resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateChangeset +func (c *FinSpaceData) UpdateChangeset(input *UpdateChangesetInput) (*UpdateChangesetOutput, error) { + req, out := c.UpdateChangesetRequest(input) + return out, req.Send() +} + +// UpdateChangesetWithContext is the same as UpdateChangeset with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateChangeset 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 *FinSpaceData) UpdateChangesetWithContext(ctx aws.Context, input *UpdateChangesetInput, opts ...request.Option) (*UpdateChangesetOutput, error) { + req, out := c.UpdateChangesetRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateDataset = "UpdateDataset" + +// UpdateDatasetRequest generates a "aws/request.Request" representing the +// client's request for the UpdateDataset 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 UpdateDataset for more information on using the UpdateDataset +// 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 UpdateDatasetRequest method. +// req, resp := client.UpdateDatasetRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateDataset +func (c *FinSpaceData) UpdateDatasetRequest(input *UpdateDatasetInput) (req *request.Request, output *UpdateDatasetOutput) { + op := &request.Operation{ + Name: opUpdateDataset, + HTTPMethod: "PUT", + HTTPPath: "/datasetsv2/{datasetId}", + } + + if input == nil { + input = &UpdateDatasetInput{} + } + + output = &UpdateDatasetOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateDataset API operation for FinSpace Public API. +// +// Updates a FinSpace Dataset. +// +// 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 FinSpace Public API's +// API operation UpdateDataset for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// The request processing has failed because of an unknown error, exception +// or failure. +// +// * ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ConflictException +// The request conflicts with an existing resource. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateDataset +func (c *FinSpaceData) UpdateDataset(input *UpdateDatasetInput) (*UpdateDatasetOutput, error) { + req, out := c.UpdateDatasetRequest(input) + return out, req.Send() +} + +// UpdateDatasetWithContext is the same as UpdateDataset with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateDataset 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 *FinSpaceData) UpdateDatasetWithContext(ctx aws.Context, input *UpdateDatasetInput, opts ...request.Option) (*UpdateDatasetOutput, error) { + req, out := c.UpdateDatasetRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdatePermissionGroup = "UpdatePermissionGroup" + +// UpdatePermissionGroupRequest generates a "aws/request.Request" representing the +// client's request for the UpdatePermissionGroup 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 UpdatePermissionGroup for more information on using the UpdatePermissionGroup +// 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 UpdatePermissionGroupRequest method. +// req, resp := client.UpdatePermissionGroupRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdatePermissionGroup +func (c *FinSpaceData) UpdatePermissionGroupRequest(input *UpdatePermissionGroupInput) (req *request.Request, output *UpdatePermissionGroupOutput) { + op := &request.Operation{ + Name: opUpdatePermissionGroup, + HTTPMethod: "PUT", + HTTPPath: "/permission-group/{permissionGroupId}", + } + + if input == nil { + input = &UpdatePermissionGroupInput{} + } + + output = &UpdatePermissionGroupOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdatePermissionGroup API operation for FinSpace Public API. +// +// Modifies the details of a permission group. You cannot modify a permissionGroupID. +// +// 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 FinSpace Public API's +// API operation UpdatePermissionGroup for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// The request processing has failed because of an unknown error, exception +// or failure. +// +// * ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ConflictException +// The request conflicts with an existing resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdatePermissionGroup +func (c *FinSpaceData) UpdatePermissionGroup(input *UpdatePermissionGroupInput) (*UpdatePermissionGroupOutput, error) { + req, out := c.UpdatePermissionGroupRequest(input) + return out, req.Send() +} + +// UpdatePermissionGroupWithContext is the same as UpdatePermissionGroup with the addition of +// the ability to pass a context and additional request options. +// +// See UpdatePermissionGroup 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 *FinSpaceData) UpdatePermissionGroupWithContext(ctx aws.Context, input *UpdatePermissionGroupInput, opts ...request.Option) (*UpdatePermissionGroupOutput, error) { + req, out := c.UpdatePermissionGroupRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateUser = "UpdateUser" + +// UpdateUserRequest generates a "aws/request.Request" representing the +// client's request for the UpdateUser 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 UpdateUser for more information on using the UpdateUser +// 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 UpdateUserRequest method. +// req, resp := client.UpdateUserRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateUser +func (c *FinSpaceData) UpdateUserRequest(input *UpdateUserInput) (req *request.Request, output *UpdateUserOutput) { + op := &request.Operation{ + Name: opUpdateUser, + HTTPMethod: "PUT", + HTTPPath: "/user/{userId}", + } + + if input == nil { + input = &UpdateUserInput{} + } + + output = &UpdateUserOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateUser API operation for FinSpace Public API. +// +// Modifies the details of the specified user account. You cannot update the +// userId for a user. +// +// 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 FinSpace Public API's +// API operation UpdateUser for usage and error information. +// +// Returned Error Types: +// * InternalServerException +// The request processing has failed because of an unknown error, exception +// or failure. +// +// * ValidationException +// The input fails to satisfy the constraints specified by an AWS service. +// +// * ThrottlingException +// The request was denied due to request throttling. +// +// * AccessDeniedException +// You do not have sufficient access to perform this action. +// +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ConflictException +// The request conflicts with an existing resource. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UpdateUser +func (c *FinSpaceData) UpdateUser(input *UpdateUserInput) (*UpdateUserOutput, error) { + req, out := c.UpdateUserRequest(input) + return out, req.Send() +} + +// UpdateUserWithContext is the same as UpdateUser with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateUser 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 *FinSpaceData) UpdateUserWithContext(ctx aws.Context, input *UpdateUserInput, opts ...request.Option) (*UpdateUserOutput, error) { + req, out := c.UpdateUserRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// You do not have sufficient access to perform this action. +type AccessDeniedException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" 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 AccessDeniedException) 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 AccessDeniedException) GoString() string { + return s.String() +} + +func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { + return &AccessDeniedException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *AccessDeniedException) Code() string { + return "AccessDeniedException" +} + +// Message returns the exception's message. +func (s *AccessDeniedException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *AccessDeniedException) OrigErr() error { + return nil +} + +func (s *AccessDeniedException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *AccessDeniedException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *AccessDeniedException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The structure with error messages. +type ChangesetErrorInfo struct { + _ struct{} `type:"structure"` + + // The category of the error. + // + // * VALIDATION – The inputs to this request are invalid. + // + // * SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please + // contact AWS support to increase quotas. + // + // * ACCESS_DENIED – Missing required permission to perform this request. + // + // * RESOURCE_NOT_FOUND – One or more inputs to this request were not found. + // + // * THROTTLING – The system temporarily lacks sufficient resources to + // process the request. + // + // * INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred. + // + // * CANCELLED – Cancelled. + // + // * USER_RECOVERABLE – A user recoverable error has occurred. + ErrorCategory *string `locationName:"errorCategory" type:"string" enum:"ErrorCategory"` + + // The text of the error message. + ErrorMessage *string `locationName:"errorMessage" 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 ChangesetErrorInfo) 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 ChangesetErrorInfo) GoString() string { + return s.String() +} + +// SetErrorCategory sets the ErrorCategory field's value. +func (s *ChangesetErrorInfo) SetErrorCategory(v string) *ChangesetErrorInfo { + s.ErrorCategory = &v + return s +} + +// SetErrorMessage sets the ErrorMessage field's value. +func (s *ChangesetErrorInfo) SetErrorMessage(v string) *ChangesetErrorInfo { + s.ErrorMessage = &v + return s +} + +// A Changeset is unit of data in a Dataset. +type ChangesetSummary struct { + _ struct{} `type:"structure"` + + // Beginning time from which the Changeset is active. The value is determined + // as epoch time in milliseconds. For example, the value for Monday, November + // 1, 2021 12:00:00 PM UTC is specified as 1635768000000. + ActiveFromTimestamp *int64 `locationName:"activeFromTimestamp" type:"long"` + + // Time until which the Changeset is active. The value is determined as epoch + // time in milliseconds. For example, the value for Monday, November 1, 2021 + // 12:00:00 PM UTC is specified as 1635768000000. + ActiveUntilTimestamp *int64 `locationName:"activeUntilTimestamp" type:"long"` + + // Type that indicates how a Changeset is applied to a Dataset. + // + // * REPLACE – Changeset is considered as a replacement to all prior loaded + // Changesets. + // + // * APPEND – Changeset is considered as an addition to the end of all + // prior loaded Changesets. + // + // * MODIFY – Changeset is considered as a replacement to a specific prior + // ingested Changeset. + ChangeType *string `locationName:"changeType" type:"string" enum:"ChangeType"` + + // The ARN identifier of the Changeset. + ChangesetArn *string `locationName:"changesetArn" type:"string"` + + // The unique identifier for a Changeset. + ChangesetId *string `locationName:"changesetId" min:"1" type:"string"` + + // The timestamp at which the Changeset was created in FinSpace. The value is + // determined as epoch time in milliseconds. For example, the value for Monday, + // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. + CreateTime *int64 `locationName:"createTime" type:"long"` + + // The unique identifier for the FinSpace Dataset in which the Changeset is + // created. + DatasetId *string `locationName:"datasetId" min:"1" type:"string"` + + // The structure with error messages. + ErrorInfo *ChangesetErrorInfo `locationName:"errorInfo" type:"structure"` + + // Options that define the structure of the source file(s). + FormatParams map[string]*string `locationName:"formatParams" type:"map"` + + // Options that define the location of the data being ingested. + SourceParams map[string]*string `locationName:"sourceParams" type:"map"` + + // Status of the Changeset ingestion. + // + // * PENDING – Changeset is pending creation. + // + // * FAILED – Changeset creation has failed. + // + // * SUCCESS – Changeset creation has succeeded. + // + // * RUNNING – Changeset creation is running. + // + // * STOP_REQUESTED – User requested Changeset creation to stop. + Status *string `locationName:"status" type:"string" enum:"IngestionStatus"` + + // The unique identifier of the updated Changeset. + UpdatedByChangesetId *string `locationName:"updatedByChangesetId" min:"1" type:"string"` + + // The unique identifier of the Changeset that is updated. + UpdatesChangesetId *string `locationName:"updatesChangesetId" 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 ChangesetSummary) 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 ChangesetSummary) GoString() string { + return s.String() +} + +// SetActiveFromTimestamp sets the ActiveFromTimestamp field's value. +func (s *ChangesetSummary) SetActiveFromTimestamp(v int64) *ChangesetSummary { + s.ActiveFromTimestamp = &v + return s +} + +// SetActiveUntilTimestamp sets the ActiveUntilTimestamp field's value. +func (s *ChangesetSummary) SetActiveUntilTimestamp(v int64) *ChangesetSummary { + s.ActiveUntilTimestamp = &v + return s +} + +// SetChangeType sets the ChangeType field's value. +func (s *ChangesetSummary) SetChangeType(v string) *ChangesetSummary { + s.ChangeType = &v + return s +} + +// SetChangesetArn sets the ChangesetArn field's value. +func (s *ChangesetSummary) SetChangesetArn(v string) *ChangesetSummary { + s.ChangesetArn = &v + return s +} + +// SetChangesetId sets the ChangesetId field's value. +func (s *ChangesetSummary) SetChangesetId(v string) *ChangesetSummary { + s.ChangesetId = &v + return s +} + +// SetCreateTime sets the CreateTime field's value. +func (s *ChangesetSummary) SetCreateTime(v int64) *ChangesetSummary { + s.CreateTime = &v + return s +} + +// SetDatasetId sets the DatasetId field's value. +func (s *ChangesetSummary) SetDatasetId(v string) *ChangesetSummary { + s.DatasetId = &v + return s +} + +// SetErrorInfo sets the ErrorInfo field's value. +func (s *ChangesetSummary) SetErrorInfo(v *ChangesetErrorInfo) *ChangesetSummary { + s.ErrorInfo = v + return s +} + +// SetFormatParams sets the FormatParams field's value. +func (s *ChangesetSummary) SetFormatParams(v map[string]*string) *ChangesetSummary { + s.FormatParams = v + return s +} + +// SetSourceParams sets the SourceParams field's value. +func (s *ChangesetSummary) SetSourceParams(v map[string]*string) *ChangesetSummary { + s.SourceParams = v + return s +} + +// SetStatus sets the Status field's value. +func (s *ChangesetSummary) SetStatus(v string) *ChangesetSummary { + s.Status = &v + return s +} + +// SetUpdatedByChangesetId sets the UpdatedByChangesetId field's value. +func (s *ChangesetSummary) SetUpdatedByChangesetId(v string) *ChangesetSummary { + s.UpdatedByChangesetId = &v + return s +} + +// SetUpdatesChangesetId sets the UpdatesChangesetId field's value. +func (s *ChangesetSummary) SetUpdatesChangesetId(v string) *ChangesetSummary { + s.UpdatesChangesetId = &v + return s +} + +// The definition of a column in a tabular Dataset. +type ColumnDefinition struct { + _ struct{} `type:"structure"` + + // Description for a column. + ColumnDescription *string `locationName:"columnDescription" type:"string"` + + // The name of a column. + ColumnName *string `locationName:"columnName" type:"string"` + + // Data type of a column. + // + // * STRING – A String data type. CHAR – A char data type. INTEGER – + // An integer data type. TINYINT – A tinyint data type. SMALLINT – A + // smallint data type. BIGINT – A bigint data type. FLOAT – A float data + // type. DOUBLE – A double data type. DATE – A date data type. DATETIME + // – A datetime data type. BOOLEAN – A boolean data type. BINARY – + // A binary data type. + DataType *string `locationName:"dataType" type:"string" enum:"ColumnDataType"` +} + +// 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 ColumnDefinition) 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 ColumnDefinition) GoString() string { + return s.String() +} + +// SetColumnDescription sets the ColumnDescription field's value. +func (s *ColumnDefinition) SetColumnDescription(v string) *ColumnDefinition { + s.ColumnDescription = &v + return s +} + +// SetColumnName sets the ColumnName field's value. +func (s *ColumnDefinition) SetColumnName(v string) *ColumnDefinition { + s.ColumnName = &v + return s +} + +// SetDataType sets the DataType field's value. +func (s *ColumnDefinition) SetDataType(v string) *ColumnDefinition { + s.DataType = &v + return s +} + +// The request conflicts with an existing resource. +type ConflictException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` + + Reason *string `locationName:"reason" 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 ConflictException) 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 ConflictException) GoString() string { + return s.String() +} + +func newErrorConflictException(v protocol.ResponseMetadata) error { + return &ConflictException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ConflictException) Code() string { + return "ConflictException" +} + +// Message returns the exception's message. +func (s *ConflictException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ConflictException) OrigErr() error { + return nil +} + +func (s *ConflictException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ConflictException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ConflictException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The request for a CreateChangeset operation. +type CreateChangesetInput struct { + _ struct{} `type:"structure"` + + // The option to indicate how a Changeset will be applied to a Dataset. + // + // * REPLACE – Changeset will be considered as a replacement to all prior + // loaded Changesets. + // + // * APPEND – Changeset will be considered as an addition to the end of + // all prior loaded Changesets. + // + // * MODIFY – Changeset is considered as a replacement to a specific prior + // ingested Changeset. + // + // ChangeType is a required field + ChangeType *string `locationName:"changeType" type:"string" required:"true" enum:"ChangeType"` + + // A token that ensures idempotency. This token expires in 10 minutes. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // The unique identifier for the FinSpace Dataset where the Changeset will be + // created. + // + // DatasetId is a required field + DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` + + // Options that define the structure of the source file(s) including the format + // type (formatType), header row (withHeader), data separation character (separator) + // and the type of compression (compression). + // + // formatType is a required attribute and can have the following values: + // + // * PARQUET – Parquet source file format. + // + // * CSV – CSV source file format. + // + // * JSON – JSON source file format. + // + // * XML – XML source file format. + // + // Here is an example of how you could specify the formatParams: + // + // "formatParams": { "formatType": "CSV", "withHeader": "true", "separator": + // ",", "compression":"None" } + // + // Note that if you only provide formatType as CSV, the rest of the attributes + // will automatically default to CSV values as following: + // + // { "withHeader": "true", "separator": "," } + // + // For more information about supported file formats, see Supported Data Types + // and File Formats (https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html) + // in the FinSpace User Guide. + // + // FormatParams is a required field + FormatParams map[string]*string `locationName:"formatParams" type:"map" required:"true"` + + // Options that define the location of the data being ingested (s3SourcePath) + // and the source of the changeset (sourceType). + // + // Both s3SourcePath and sourceType are required attributes. + // + // Here is an example of how you could specify the sourceParams: + // + // "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", + // "sourceType": "S3" } + // + // The S3 path that you specify must allow the FinSpace role access. To do that, + // you first need to configure the IAM policy on S3 bucket. For more information, + // see Loading data from an Amazon S3 Bucket using the FinSpace API (https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets) + // section. + // + // SourceParams is a required field + SourceParams map[string]*string `locationName:"sourceParams" type:"map" 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 CreateChangesetInput) 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 CreateChangesetInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateChangesetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateChangesetInput"} + if s.ChangeType == nil { + invalidParams.Add(request.NewErrParamRequired("ChangeType")) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.DatasetId == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetId")) + } + if s.DatasetId != nil && len(*s.DatasetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) + } + if s.FormatParams == nil { + invalidParams.Add(request.NewErrParamRequired("FormatParams")) + } + if s.SourceParams == nil { + invalidParams.Add(request.NewErrParamRequired("SourceParams")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetChangeType sets the ChangeType field's value. +func (s *CreateChangesetInput) SetChangeType(v string) *CreateChangesetInput { + s.ChangeType = &v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateChangesetInput) SetClientToken(v string) *CreateChangesetInput { + s.ClientToken = &v + return s +} + +// SetDatasetId sets the DatasetId field's value. +func (s *CreateChangesetInput) SetDatasetId(v string) *CreateChangesetInput { + s.DatasetId = &v + return s +} + +// SetFormatParams sets the FormatParams field's value. +func (s *CreateChangesetInput) SetFormatParams(v map[string]*string) *CreateChangesetInput { + s.FormatParams = v + return s +} + +// SetSourceParams sets the SourceParams field's value. +func (s *CreateChangesetInput) SetSourceParams(v map[string]*string) *CreateChangesetInput { + s.SourceParams = v + return s +} + +// The response from a CreateChangeset operation. +type CreateChangesetOutput struct { + _ struct{} `type:"structure"` + + // The unique identifier of the Changeset that is created. + ChangesetId *string `locationName:"changesetId" min:"1" type:"string"` + + // The unique identifier for the FinSpace Dataset where the Changeset is created. + DatasetId *string `locationName:"datasetId" 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 CreateChangesetOutput) 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 CreateChangesetOutput) GoString() string { + return s.String() +} + +// SetChangesetId sets the ChangesetId field's value. +func (s *CreateChangesetOutput) SetChangesetId(v string) *CreateChangesetOutput { + s.ChangesetId = &v + return s +} + +// SetDatasetId sets the DatasetId field's value. +func (s *CreateChangesetOutput) SetDatasetId(v string) *CreateChangesetOutput { + s.DatasetId = &v + return s +} + +// Request for creating a data view. +type CreateDataViewInput struct { + _ struct{} `type:"structure"` + + // Beginning time to use for the Dataview. The value is determined as epoch + // time in milliseconds. For example, the value for Monday, November 1, 2021 + // 12:00:00 PM UTC is specified as 1635768000000. + AsOfTimestamp *int64 `locationName:"asOfTimestamp" type:"long"` + + // Flag to indicate Dataview should be updated automatically. + AutoUpdate *bool `locationName:"autoUpdate" type:"boolean"` + + // A token that ensures idempotency. This token expires in 10 minutes. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // The unique Dataset identifier that is used to create a Dataview. + // + // DatasetId is a required field + DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` + + // Options that define the destination type for the Dataview. + // + // DestinationTypeParams is a required field + DestinationTypeParams *DataViewDestinationTypeParams `locationName:"destinationTypeParams" type:"structure" required:"true"` + + // Ordered set of column names used to partition data. + PartitionColumns []*string `locationName:"partitionColumns" type:"list"` + + // Columns to be used for sorting the data. + SortColumns []*string `locationName:"sortColumns" type:"list"` +} + +// 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 CreateDataViewInput) 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 CreateDataViewInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateDataViewInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateDataViewInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.DatasetId == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetId")) + } + if s.DatasetId != nil && len(*s.DatasetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) + } + if s.DestinationTypeParams == nil { + invalidParams.Add(request.NewErrParamRequired("DestinationTypeParams")) + } + if s.DestinationTypeParams != nil { + if err := s.DestinationTypeParams.Validate(); err != nil { + invalidParams.AddNested("DestinationTypeParams", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAsOfTimestamp sets the AsOfTimestamp field's value. +func (s *CreateDataViewInput) SetAsOfTimestamp(v int64) *CreateDataViewInput { + s.AsOfTimestamp = &v + return s +} + +// SetAutoUpdate sets the AutoUpdate field's value. +func (s *CreateDataViewInput) SetAutoUpdate(v bool) *CreateDataViewInput { + s.AutoUpdate = &v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateDataViewInput) SetClientToken(v string) *CreateDataViewInput { + s.ClientToken = &v + return s +} + +// SetDatasetId sets the DatasetId field's value. +func (s *CreateDataViewInput) SetDatasetId(v string) *CreateDataViewInput { + s.DatasetId = &v + return s +} + +// SetDestinationTypeParams sets the DestinationTypeParams field's value. +func (s *CreateDataViewInput) SetDestinationTypeParams(v *DataViewDestinationTypeParams) *CreateDataViewInput { + s.DestinationTypeParams = v + return s +} + +// SetPartitionColumns sets the PartitionColumns field's value. +func (s *CreateDataViewInput) SetPartitionColumns(v []*string) *CreateDataViewInput { + s.PartitionColumns = v + return s +} + +// SetSortColumns sets the SortColumns field's value. +func (s *CreateDataViewInput) SetSortColumns(v []*string) *CreateDataViewInput { + s.SortColumns = v + return s +} + +// Response for creating a data view. +type CreateDataViewOutput struct { + _ struct{} `type:"structure"` + + // The unique identifier for the created Dataview. + DataViewId *string `locationName:"dataViewId" min:"1" type:"string"` + + // The unique identifier of the Dataset used for the Dataview. + DatasetId *string `locationName:"datasetId" 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 CreateDataViewOutput) 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 CreateDataViewOutput) GoString() string { + return s.String() +} + +// SetDataViewId sets the DataViewId field's value. +func (s *CreateDataViewOutput) SetDataViewId(v string) *CreateDataViewOutput { + s.DataViewId = &v + return s +} + +// SetDatasetId sets the DatasetId field's value. +func (s *CreateDataViewOutput) SetDatasetId(v string) *CreateDataViewOutput { + s.DatasetId = &v + return s +} + +// The request for a CreateDataset operation +type CreateDatasetInput struct { + _ struct{} `type:"structure"` + + // The unique resource identifier for a Dataset. + Alias *string `locationName:"alias" min:"1" type:"string"` + + // A token that ensures idempotency. This token expires in 10 minutes. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // Description of a Dataset. + DatasetDescription *string `locationName:"datasetDescription" min:"1" type:"string"` + + // Display title for a FinSpace Dataset. + // + // DatasetTitle is a required field + DatasetTitle *string `locationName:"datasetTitle" min:"1" type:"string" required:"true"` + + // The format in which Dataset data is structured. + // + // * TABULAR – Data is structured in a tabular format. + // + // * NON_TABULAR – Data is structured in a non-tabular format. + // + // Kind is a required field + Kind *string `locationName:"kind" type:"string" required:"true" enum:"DatasetKind"` + + // Contact information for a Dataset owner. + OwnerInfo *DatasetOwnerInfo `locationName:"ownerInfo" type:"structure"` + + // Permission group parameters for Dataset permissions. + // + // PermissionGroupParams is a required field + PermissionGroupParams *PermissionGroupParams `locationName:"permissionGroupParams" type:"structure" required:"true"` + + // Definition for a schema on a tabular Dataset. + SchemaDefinition *SchemaUnion `locationName:"schemaDefinition" 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 CreateDatasetInput) 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 CreateDatasetInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateDatasetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateDatasetInput"} + if s.Alias != nil && len(*s.Alias) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Alias", 1)) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.DatasetDescription != nil && len(*s.DatasetDescription) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetDescription", 1)) + } + if s.DatasetTitle == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetTitle")) + } + if s.DatasetTitle != nil && len(*s.DatasetTitle) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetTitle", 1)) + } + if s.Kind == nil { + invalidParams.Add(request.NewErrParamRequired("Kind")) + } + if s.PermissionGroupParams == nil { + invalidParams.Add(request.NewErrParamRequired("PermissionGroupParams")) + } + if s.OwnerInfo != nil { + if err := s.OwnerInfo.Validate(); err != nil { + invalidParams.AddNested("OwnerInfo", err.(request.ErrInvalidParams)) + } + } + if s.PermissionGroupParams != nil { + if err := s.PermissionGroupParams.Validate(); err != nil { + invalidParams.AddNested("PermissionGroupParams", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAlias sets the Alias field's value. +func (s *CreateDatasetInput) SetAlias(v string) *CreateDatasetInput { + s.Alias = &v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateDatasetInput) SetClientToken(v string) *CreateDatasetInput { + s.ClientToken = &v + return s +} + +// SetDatasetDescription sets the DatasetDescription field's value. +func (s *CreateDatasetInput) SetDatasetDescription(v string) *CreateDatasetInput { + s.DatasetDescription = &v + return s +} + +// SetDatasetTitle sets the DatasetTitle field's value. +func (s *CreateDatasetInput) SetDatasetTitle(v string) *CreateDatasetInput { + s.DatasetTitle = &v + return s +} + +// SetKind sets the Kind field's value. +func (s *CreateDatasetInput) SetKind(v string) *CreateDatasetInput { + s.Kind = &v + return s +} + +// SetOwnerInfo sets the OwnerInfo field's value. +func (s *CreateDatasetInput) SetOwnerInfo(v *DatasetOwnerInfo) *CreateDatasetInput { + s.OwnerInfo = v + return s +} + +// SetPermissionGroupParams sets the PermissionGroupParams field's value. +func (s *CreateDatasetInput) SetPermissionGroupParams(v *PermissionGroupParams) *CreateDatasetInput { + s.PermissionGroupParams = v + return s +} + +// SetSchemaDefinition sets the SchemaDefinition field's value. +func (s *CreateDatasetInput) SetSchemaDefinition(v *SchemaUnion) *CreateDatasetInput { + s.SchemaDefinition = v + return s +} + +// The response from a CreateDataset operation +type CreateDatasetOutput struct { + _ struct{} `type:"structure"` + + // The unique identifier for the created Dataset. + DatasetId *string `locationName:"datasetId" 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 CreateDatasetOutput) 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 CreateDatasetOutput) GoString() string { + return s.String() +} + +// SetDatasetId sets the DatasetId field's value. +func (s *CreateDatasetOutput) SetDatasetId(v string) *CreateDatasetOutput { + s.DatasetId = &v + return s +} + +type CreatePermissionGroupInput struct { + _ struct{} `type:"structure"` + + // The option to indicate FinSpace application permissions that are granted + // to a specific group. + // + // * CreateDataset – Group members can create new datasets. + // + // * ManageClusters – Group members can manage Apache Spark clusters from + // FinSpace notebooks. + // + // * ManageUsersAndGroups – Group members can manage users and permission + // groups. + // + // * ManageAttributeSets – Group members can manage attribute sets. + // + // * ViewAuditData – Group members can view audit data. + // + // * AccessNotebooks – Group members will have access to FinSpace notebooks. + // + // * GetTemporaryCredentials – Group members can get temporary API credentials. + // + // ApplicationPermissions is a required field + ApplicationPermissions []*string `locationName:"applicationPermissions" type:"list" required:"true"` + + // A token that ensures idempotency. This token expires in 10 minutes. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // A brief description for the permission group. + // + // Description is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreatePermissionGroupInput's + // String and GoString methods. + Description *string `locationName:"description" min:"1" type:"string" sensitive:"true"` + + // The name of the permission group. + // + // Name is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreatePermissionGroupInput's + // String and GoString methods. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true" sensitive:"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 CreatePermissionGroupInput) 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 CreatePermissionGroupInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreatePermissionGroupInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreatePermissionGroupInput"} + if s.ApplicationPermissions == nil { + invalidParams.Add(request.NewErrParamRequired("ApplicationPermissions")) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.Description != nil && len(*s.Description) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Description", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApplicationPermissions sets the ApplicationPermissions field's value. +func (s *CreatePermissionGroupInput) SetApplicationPermissions(v []*string) *CreatePermissionGroupInput { + s.ApplicationPermissions = v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreatePermissionGroupInput) SetClientToken(v string) *CreatePermissionGroupInput { + s.ClientToken = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreatePermissionGroupInput) SetDescription(v string) *CreatePermissionGroupInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreatePermissionGroupInput) SetName(v string) *CreatePermissionGroupInput { + s.Name = &v + return s +} + +type CreatePermissionGroupOutput struct { + _ struct{} `type:"structure"` + + // The unique identifier for the permission group. + PermissionGroupId *string `locationName:"permissionGroupId" 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 CreatePermissionGroupOutput) 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 CreatePermissionGroupOutput) GoString() string { + return s.String() +} + +// SetPermissionGroupId sets the PermissionGroupId field's value. +func (s *CreatePermissionGroupOutput) SetPermissionGroupId(v string) *CreatePermissionGroupOutput { + s.PermissionGroupId = &v + return s +} + +type CreateUserInput struct { + _ struct{} `type:"structure"` + + // The option to indicate whether the user can use the GetProgrammaticAccessCredentials + // API to obtain credentials that can then be used to access other FinSpace + // Data API operations. + // + // * ENABLED – The user has permissions to use the APIs. + // + // * DISABLED – The user does not have permissions to use any APIs. + ApiAccess *string `type:"string" enum:"ApiAccess"` + + // The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials + // API to obtain a credentials token for a specific FinSpace user. This must + // be an IAM role within your FinSpace account. + ApiAccessPrincipalArn *string `locationName:"apiAccessPrincipalArn" min:"20" type:"string"` + + // A token that ensures idempotency. This token expires in 10 minutes. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // The email address of the user that you want to register. The email address + // serves as a uniquer identifier for each user and cannot be changed after + // it's created. + // + // EmailAddress is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateUserInput's + // String and GoString methods. + // + // EmailAddress is a required field + EmailAddress *string `locationName:"emailAddress" min:"4" type:"string" required:"true" sensitive:"true"` + + // The first name of the user that you want to register. + // + // FirstName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateUserInput's + // String and GoString methods. + FirstName *string `locationName:"firstName" min:"1" type:"string" sensitive:"true"` + + // The last name of the user that you want to register. + // + // LastName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateUserInput's + // String and GoString methods. + LastName *string `locationName:"lastName" min:"1" type:"string" sensitive:"true"` + + // The option to indicate the type of user. Use one of the following options + // to specify this parameter: + // + // * SUPER_USER – A user with permission to all the functionality and data + // in FinSpace. + // + // * APP_USER – A user with specific permissions in FinSpace. The users + // are assigned permissions by adding them to a permission group. + // + // Type is a required field + Type *string `locationName:"type" type:"string" required:"true" enum:"UserType"` +} + +// 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 CreateUserInput) 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 CreateUserInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateUserInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateUserInput"} + if s.ApiAccessPrincipalArn != nil && len(*s.ApiAccessPrincipalArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("ApiAccessPrincipalArn", 20)) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.EmailAddress == nil { + invalidParams.Add(request.NewErrParamRequired("EmailAddress")) + } + if s.EmailAddress != nil && len(*s.EmailAddress) < 4 { + invalidParams.Add(request.NewErrParamMinLen("EmailAddress", 4)) + } + if s.FirstName != nil && len(*s.FirstName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FirstName", 1)) + } + if s.LastName != nil && len(*s.LastName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LastName", 1)) + } + if s.Type == nil { + invalidParams.Add(request.NewErrParamRequired("Type")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetApiAccess sets the ApiAccess field's value. +func (s *CreateUserInput) SetApiAccess(v string) *CreateUserInput { + s.ApiAccess = &v + return s +} + +// SetApiAccessPrincipalArn sets the ApiAccessPrincipalArn field's value. +func (s *CreateUserInput) SetApiAccessPrincipalArn(v string) *CreateUserInput { + s.ApiAccessPrincipalArn = &v + return s +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateUserInput) SetClientToken(v string) *CreateUserInput { + s.ClientToken = &v + return s +} + +// SetEmailAddress sets the EmailAddress field's value. +func (s *CreateUserInput) SetEmailAddress(v string) *CreateUserInput { + s.EmailAddress = &v + return s +} + +// SetFirstName sets the FirstName field's value. +func (s *CreateUserInput) SetFirstName(v string) *CreateUserInput { + s.FirstName = &v + return s +} + +// SetLastName sets the LastName field's value. +func (s *CreateUserInput) SetLastName(v string) *CreateUserInput { + s.LastName = &v + return s +} + +// SetType sets the Type field's value. +func (s *CreateUserInput) SetType(v string) *CreateUserInput { + s.Type = &v + return s +} + +type CreateUserOutput struct { + _ struct{} `type:"structure"` + + // The unique identifier for the user. + UserId *string `locationName:"userId" 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 CreateUserOutput) 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 CreateUserOutput) GoString() string { + return s.String() +} + +// SetUserId sets the UserId field's value. +func (s *CreateUserOutput) SetUserId(v string) *CreateUserOutput { + s.UserId = &v + return s +} + +// Short term API credentials. +type Credentials struct { + _ struct{} `type:"structure"` + + // The access key identifier. + AccessKeyId *string `locationName:"accessKeyId" min:"1" type:"string"` + + // The access key. + SecretAccessKey *string `locationName:"secretAccessKey" type:"string"` + + // The session token. + SessionToken *string `locationName:"sessionToken" 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 Credentials) String() string { + return awsutil.Prettify(s) +} -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *AccessDeniedException) OrigErr() error { +// 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 Credentials) GoString() string { + return s.String() +} + +// SetAccessKeyId sets the AccessKeyId field's value. +func (s *Credentials) SetAccessKeyId(v string) *Credentials { + s.AccessKeyId = &v + return s +} + +// SetSecretAccessKey sets the SecretAccessKey field's value. +func (s *Credentials) SetSecretAccessKey(v string) *Credentials { + s.SecretAccessKey = &v + return s +} + +// SetSessionToken sets the SessionToken field's value. +func (s *Credentials) SetSessionToken(v string) *Credentials { + s.SessionToken = &v + return s +} + +// Structure for the Dataview destination type parameters. +type DataViewDestinationTypeParams struct { + _ struct{} `type:"structure"` + + // Destination type for a Dataview. + // + // * GLUE_TABLE – Glue table destination type. + // + // * S3 – S3 destination type. + // + // DestinationType is a required field + DestinationType *string `locationName:"destinationType" type:"string" required:"true"` + + // Data view export file format. + // + // * PARQUET – Parquet export file format. + // + // * DELIMITED_TEXT – Delimited text export file format. + S3DestinationExportFileFormat *string `locationName:"s3DestinationExportFileFormat" type:"string" enum:"ExportFileFormat"` + + // Format Options for S3 Destination type. + // + // Here is an example of how you could specify the s3DestinationExportFileFormatOptions + // + // { "header": "true", "delimiter": ",", "compression": "gzip" } + S3DestinationExportFileFormatOptions map[string]*string `locationName:"s3DestinationExportFileFormatOptions" 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 DataViewDestinationTypeParams) 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 DataViewDestinationTypeParams) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DataViewDestinationTypeParams) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DataViewDestinationTypeParams"} + if s.DestinationType == nil { + invalidParams.Add(request.NewErrParamRequired("DestinationType")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } return nil } -func (s *AccessDeniedException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// SetDestinationType sets the DestinationType field's value. +func (s *DataViewDestinationTypeParams) SetDestinationType(v string) *DataViewDestinationTypeParams { + s.DestinationType = &v + return s } -// Status code returns the HTTP status code for the request's response error. -func (s *AccessDeniedException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetS3DestinationExportFileFormat sets the S3DestinationExportFileFormat field's value. +func (s *DataViewDestinationTypeParams) SetS3DestinationExportFileFormat(v string) *DataViewDestinationTypeParams { + s.S3DestinationExportFileFormat = &v + return s } -// RequestID returns the service's response RequestID for request. -func (s *AccessDeniedException) RequestID() string { - return s.RespMetadata.RequestID +// SetS3DestinationExportFileFormatOptions sets the S3DestinationExportFileFormatOptions field's value. +func (s *DataViewDestinationTypeParams) SetS3DestinationExportFileFormatOptions(v map[string]*string) *DataViewDestinationTypeParams { + s.S3DestinationExportFileFormatOptions = v + return s } // The structure with error messages. -type ChangesetErrorInfo struct { +type DataViewErrorInfo struct { _ struct{} `type:"structure"` // The category of the error. // - // * VALIDATION -The inputs to this request are invalid. + // * VALIDATION – The inputs to this request are invalid. // - // * SERVICE_QUOTA_EXCEEDED - Service quotas have been exceeded. Please contact - // AWS support to increase quotas. + // * SERVICE_QUOTA_EXCEEDED – Service quotas have been exceeded. Please + // contact AWS support to increase quotas. // - // * ACCESS_DENIED - Missing required permission to perform this request. + // * ACCESS_DENIED – Missing required permission to perform this request. // - // * RESOURCE_NOT_FOUND - One or more inputs to this request were not found. + // * RESOURCE_NOT_FOUND – One or more inputs to this request were not found. // - // * THROTTLING - The system temporarily lacks sufficient resources to process - // the request. + // * THROTTLING – The system temporarily lacks sufficient resources to + // process the request. // - // * INTERNAL_SERVICE_EXCEPTION - An internal service error has occurred. + // * INTERNAL_SERVICE_EXCEPTION – An internal service error has occurred. // - // * CANCELLED - Cancelled. + // * CANCELLED – Cancelled. // - // * USER_RECOVERABLE - A user recoverable error has occurred. + // * USER_RECOVERABLE – A user recoverable error has occurred. ErrorCategory *string `locationName:"errorCategory" type:"string" enum:"ErrorCategory"` // The text of the error message. @@ -1602,7 +4088,7 @@ type ChangesetErrorInfo 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 ChangesetErrorInfo) String() string { +func (s DataViewErrorInfo) String() string { return awsutil.Prettify(s) } @@ -1611,90 +4097,84 @@ func (s ChangesetErrorInfo) 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 ChangesetErrorInfo) GoString() string { +func (s DataViewErrorInfo) GoString() string { return s.String() } // SetErrorCategory sets the ErrorCategory field's value. -func (s *ChangesetErrorInfo) SetErrorCategory(v string) *ChangesetErrorInfo { +func (s *DataViewErrorInfo) SetErrorCategory(v string) *DataViewErrorInfo { s.ErrorCategory = &v return s } // SetErrorMessage sets the ErrorMessage field's value. -func (s *ChangesetErrorInfo) SetErrorMessage(v string) *ChangesetErrorInfo { +func (s *DataViewErrorInfo) SetErrorMessage(v string) *DataViewErrorInfo { s.ErrorMessage = &v return s } -// A Changeset is unit of data in a Dataset. -type ChangesetSummary struct { +// Structure for the summary of a Dataview. +type DataViewSummary struct { _ struct{} `type:"structure"` - // Beginning time from which the Changeset is active. The value is determined - // as Epoch time in milliseconds. For example, the value for Monday, November - // 1, 2021 12:00:00 PM UTC is specified as 1635768000000. - ActiveFromTimestamp *int64 `locationName:"activeFromTimestamp" type:"long"` - - // Time until which the Changeset is active. The value is determined as Epoch - // time in milliseconds. For example, the value for Monday, November 1, 2021 - // 12:00:00 PM UTC is specified as 1635768000000. - ActiveUntilTimestamp *int64 `locationName:"activeUntilTimestamp" type:"long"` - - // Type that indicates how a Changeset is applied to a Dataset. - // - // * REPLACE - Changeset is considered as a replacement to all prior loaded - // Changesets. - // - // * APPEND - Changeset is considered as an addition to the end of all prior - // loaded Changesets. - // - // * MODIFY - Changeset is considered as a replacement to a specific prior - // ingested Changeset. - ChangeType *string `locationName:"changeType" type:"string" enum:"ChangeType"` - - // The ARN identifier of the Changeset. - ChangesetArn *string `locationName:"changesetArn" type:"string"` + // Time range to use for the Dataview. The value is determined as epoch time + // in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 + // PM UTC is specified as 1635768000000. + AsOfTimestamp *int64 `locationName:"asOfTimestamp" type:"long"` - // The unique identifier for a Changeset. - ChangesetId *string `locationName:"changesetId" min:"1" type:"string"` + // The flag to indicate Dataview should be updated automatically. + AutoUpdate *bool `locationName:"autoUpdate" type:"boolean"` - // The timestamp at which the Changeset was created in FinSpace. The value is - // determined as Epoch time in milliseconds. For example, the value for Monday, + // The timestamp at which the Dataview was created in FinSpace. The value is + // determined as epoch time in milliseconds. For example, the value for Monday, // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. CreateTime *int64 `locationName:"createTime" type:"long"` - // The unique identifier for the FinSpace Dataset in which the Changeset is - // created. + // The ARN identifier of the Dataview. + DataViewArn *string `locationName:"dataViewArn" type:"string"` + + // The unique identifier for the Dataview. + DataViewId *string `locationName:"dataViewId" min:"1" type:"string"` + + // Th unique identifier for the Dataview Dataset. DatasetId *string `locationName:"datasetId" min:"1" type:"string"` + // Information about the Dataview destination. + DestinationTypeProperties *DataViewDestinationTypeParams `locationName:"destinationTypeProperties" type:"structure"` + // The structure with error messages. - ErrorInfo *ChangesetErrorInfo `locationName:"errorInfo" type:"structure"` + ErrorInfo *DataViewErrorInfo `locationName:"errorInfo" type:"structure"` - // Options that define the structure of the source file(s). - FormatParams map[string]*string `locationName:"formatParams" type:"map"` + // The last time that a Dataview was modified. The value is determined as epoch + // time in milliseconds. For example, the value for Monday, November 1, 2021 + // 12:00:00 PM UTC is specified as 1635768000000. + LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"` - // Options that define the location of the data being ingested. - SourceParams map[string]*string `locationName:"sourceParams" type:"map"` + // Ordered set of column names used to partition data. + PartitionColumns []*string `locationName:"partitionColumns" type:"list"` - // Status of the Changeset ingestion. + // Columns to be used for sorting the data. + SortColumns []*string `locationName:"sortColumns" type:"list"` + + // The status of a Dataview creation. // - // * PENDING - Changeset is pending creation. + // * RUNNING – Dataview creation is running. // - // * FAILED - Changeset creation has failed. + // * STARTING – Dataview creation is starting. // - // * SUCCESS - Changeset creation has succeeded. + // * FAILED – Dataview creation has failed. // - // * RUNNING - Changeset creation is running. + // * CANCELLED – Dataview creation has been cancelled. // - // * STOP_REQUESTED - User requested Changeset creation to stop. - Status *string `locationName:"status" type:"string" enum:"IngestionStatus"` - - // The unique identifier of the updated Changeset. - UpdatedByChangesetId *string `locationName:"updatedByChangesetId" min:"1" type:"string"` - - // The unique identifier of the Changeset that is updated. - UpdatesChangesetId *string `locationName:"updatesChangesetId" min:"1" type:"string"` + // * TIMEOUT – Dataview creation has timed out. + // + // * SUCCESS – Dataview creation has succeeded. + // + // * PENDING – Dataview creation is pending. + // + // * FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup + // failed. + Status *string `locationName:"status" type:"string" enum:"DataViewStatus"` } // String returns the string representation. @@ -1702,7 +4182,7 @@ type ChangesetSummary 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 ChangesetSummary) String() string { +func (s DataViewSummary) String() string { return awsutil.Prettify(s) } @@ -1711,106 +4191,123 @@ func (s ChangesetSummary) 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 ChangesetSummary) GoString() string { +func (s DataViewSummary) GoString() string { return s.String() } -// SetActiveFromTimestamp sets the ActiveFromTimestamp field's value. -func (s *ChangesetSummary) SetActiveFromTimestamp(v int64) *ChangesetSummary { - s.ActiveFromTimestamp = &v - return s -} - -// SetActiveUntilTimestamp sets the ActiveUntilTimestamp field's value. -func (s *ChangesetSummary) SetActiveUntilTimestamp(v int64) *ChangesetSummary { - s.ActiveUntilTimestamp = &v +// SetAsOfTimestamp sets the AsOfTimestamp field's value. +func (s *DataViewSummary) SetAsOfTimestamp(v int64) *DataViewSummary { + s.AsOfTimestamp = &v return s } -// SetChangeType sets the ChangeType field's value. -func (s *ChangesetSummary) SetChangeType(v string) *ChangesetSummary { - s.ChangeType = &v +// SetAutoUpdate sets the AutoUpdate field's value. +func (s *DataViewSummary) SetAutoUpdate(v bool) *DataViewSummary { + s.AutoUpdate = &v return s } -// SetChangesetArn sets the ChangesetArn field's value. -func (s *ChangesetSummary) SetChangesetArn(v string) *ChangesetSummary { - s.ChangesetArn = &v +// SetCreateTime sets the CreateTime field's value. +func (s *DataViewSummary) SetCreateTime(v int64) *DataViewSummary { + s.CreateTime = &v return s } -// SetChangesetId sets the ChangesetId field's value. -func (s *ChangesetSummary) SetChangesetId(v string) *ChangesetSummary { - s.ChangesetId = &v +// SetDataViewArn sets the DataViewArn field's value. +func (s *DataViewSummary) SetDataViewArn(v string) *DataViewSummary { + s.DataViewArn = &v return s } -// SetCreateTime sets the CreateTime field's value. -func (s *ChangesetSummary) SetCreateTime(v int64) *ChangesetSummary { - s.CreateTime = &v +// SetDataViewId sets the DataViewId field's value. +func (s *DataViewSummary) SetDataViewId(v string) *DataViewSummary { + s.DataViewId = &v return s } // SetDatasetId sets the DatasetId field's value. -func (s *ChangesetSummary) SetDatasetId(v string) *ChangesetSummary { +func (s *DataViewSummary) SetDatasetId(v string) *DataViewSummary { s.DatasetId = &v return s } -// SetErrorInfo sets the ErrorInfo field's value. -func (s *ChangesetSummary) SetErrorInfo(v *ChangesetErrorInfo) *ChangesetSummary { - s.ErrorInfo = v +// SetDestinationTypeProperties sets the DestinationTypeProperties field's value. +func (s *DataViewSummary) SetDestinationTypeProperties(v *DataViewDestinationTypeParams) *DataViewSummary { + s.DestinationTypeProperties = v return s } -// SetFormatParams sets the FormatParams field's value. -func (s *ChangesetSummary) SetFormatParams(v map[string]*string) *ChangesetSummary { - s.FormatParams = v +// SetErrorInfo sets the ErrorInfo field's value. +func (s *DataViewSummary) SetErrorInfo(v *DataViewErrorInfo) *DataViewSummary { + s.ErrorInfo = v return s } -// SetSourceParams sets the SourceParams field's value. -func (s *ChangesetSummary) SetSourceParams(v map[string]*string) *ChangesetSummary { - s.SourceParams = v +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *DataViewSummary) SetLastModifiedTime(v int64) *DataViewSummary { + s.LastModifiedTime = &v return s } -// SetStatus sets the Status field's value. -func (s *ChangesetSummary) SetStatus(v string) *ChangesetSummary { - s.Status = &v +// SetPartitionColumns sets the PartitionColumns field's value. +func (s *DataViewSummary) SetPartitionColumns(v []*string) *DataViewSummary { + s.PartitionColumns = v return s } -// SetUpdatedByChangesetId sets the UpdatedByChangesetId field's value. -func (s *ChangesetSummary) SetUpdatedByChangesetId(v string) *ChangesetSummary { - s.UpdatedByChangesetId = &v +// SetSortColumns sets the SortColumns field's value. +func (s *DataViewSummary) SetSortColumns(v []*string) *DataViewSummary { + s.SortColumns = v return s } -// SetUpdatesChangesetId sets the UpdatesChangesetId field's value. -func (s *ChangesetSummary) SetUpdatesChangesetId(v string) *ChangesetSummary { - s.UpdatesChangesetId = &v +// SetStatus sets the Status field's value. +func (s *DataViewSummary) SetStatus(v string) *DataViewSummary { + s.Status = &v return s } -// The definition of a column in a tabular Dataset. -type ColumnDefinition struct { +// The structure for a Dataset. +type Dataset struct { _ struct{} `type:"structure"` - // Description for a column. - ColumnDescription *string `locationName:"columnDescription" type:"string"` + // The unique resource identifier for a Dataset. + Alias *string `locationName:"alias" min:"1" type:"string"` - // Name for a column. - ColumnName *string `locationName:"columnName" type:"string"` + // The timestamp at which the Dataset was created in FinSpace. The value is + // determined as epoch time in milliseconds. For example, the value for Monday, + // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. + CreateTime *int64 `locationName:"createTime" type:"long"` - // Data type of a column. + // The ARN identifier of the Dataset. + DatasetArn *string `locationName:"datasetArn" type:"string"` + + // Description for a Dataset. + DatasetDescription *string `locationName:"datasetDescription" min:"1" type:"string"` + + // An identifier for a Dataset. + DatasetId *string `locationName:"datasetId" min:"1" type:"string"` + + // Display title for a Dataset. + DatasetTitle *string `locationName:"datasetTitle" min:"1" type:"string"` + + // The format in which Dataset data is structured. // - // * STRING - A String data type. CHAR - A char data type. INTEGER - An integer - // data type. TINYINT - A tinyint data type. SMALLINT - A smallint data type. - // BIGINT - A bigint data type. FLOAT - A float data type. DOUBLE - A double - // data type. DATE - A date data type. DATETIME - A datetime data type. BOOLEAN - // - A boolean data type. BINARY - A binary data type. - DataType *string `locationName:"dataType" type:"string" enum:"ColumnDataType"` + // * TABULAR – Data is structured in a tabular format. + // + // * NON_TABULAR – Data is structured in a non-tabular format. + Kind *string `locationName:"kind" type:"string" enum:"DatasetKind"` + + // The last time that the Dataset was modified. The value is determined as epoch + // time in milliseconds. For example, the value for Monday, November 1, 2021 + // 12:00:00 PM UTC is specified as 1635768000000. + LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"` + + // Contact information for a Dataset owner. + OwnerInfo *DatasetOwnerInfo `locationName:"ownerInfo" type:"structure"` + + // Definition for a schema on a tabular Dataset. + SchemaDefinition *SchemaUnion `locationName:"schemaDefinition" type:"structure"` } // String returns the string representation. @@ -1818,7 +4315,7 @@ type ColumnDefinition 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 ColumnDefinition) String() string { +func (s Dataset) String() string { return awsutil.Prettify(s) } @@ -1827,34 +4324,86 @@ func (s ColumnDefinition) 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 ColumnDefinition) GoString() string { +func (s Dataset) GoString() string { return s.String() } -// SetColumnDescription sets the ColumnDescription field's value. -func (s *ColumnDefinition) SetColumnDescription(v string) *ColumnDefinition { - s.ColumnDescription = &v +// SetAlias sets the Alias field's value. +func (s *Dataset) SetAlias(v string) *Dataset { + s.Alias = &v return s } -// SetColumnName sets the ColumnName field's value. -func (s *ColumnDefinition) SetColumnName(v string) *ColumnDefinition { - s.ColumnName = &v +// SetCreateTime sets the CreateTime field's value. +func (s *Dataset) SetCreateTime(v int64) *Dataset { + s.CreateTime = &v return s } -// SetDataType sets the DataType field's value. -func (s *ColumnDefinition) SetDataType(v string) *ColumnDefinition { - s.DataType = &v +// SetDatasetArn sets the DatasetArn field's value. +func (s *Dataset) SetDatasetArn(v string) *Dataset { + s.DatasetArn = &v return s } -// The request conflicts with an existing resource. -type ConflictException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +// SetDatasetDescription sets the DatasetDescription field's value. +func (s *Dataset) SetDatasetDescription(v string) *Dataset { + s.DatasetDescription = &v + return s +} - Message_ *string `locationName:"message" type:"string"` +// SetDatasetId sets the DatasetId field's value. +func (s *Dataset) SetDatasetId(v string) *Dataset { + s.DatasetId = &v + return s +} + +// SetDatasetTitle sets the DatasetTitle field's value. +func (s *Dataset) SetDatasetTitle(v string) *Dataset { + s.DatasetTitle = &v + return s +} + +// SetKind sets the Kind field's value. +func (s *Dataset) SetKind(v string) *Dataset { + s.Kind = &v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *Dataset) SetLastModifiedTime(v int64) *Dataset { + s.LastModifiedTime = &v + return s +} + +// SetOwnerInfo sets the OwnerInfo field's value. +func (s *Dataset) SetOwnerInfo(v *DatasetOwnerInfo) *Dataset { + s.OwnerInfo = v + return s +} + +// SetSchemaDefinition sets the SchemaDefinition field's value. +func (s *Dataset) SetSchemaDefinition(v *SchemaUnion) *Dataset { + s.SchemaDefinition = v + return s +} + +// A structure for Dataset owner info. +type DatasetOwnerInfo struct { + _ struct{} `type:"structure"` + + // Email address for the Dataset owner. + // + // Email is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DatasetOwnerInfo's + // String and GoString methods. + Email *string `locationName:"email" min:"4" type:"string" sensitive:"true"` + + // The name of the Dataset owner. + Name *string `locationName:"name" min:"1" type:"string"` + + // Phone number for the Dataset owner. + PhoneNumber *string `locationName:"phoneNumber" min:"10" type:"string"` } // String returns the string representation. @@ -1862,7 +4411,7 @@ type ConflictException 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 ConflictException) String() string { +func (s DatasetOwnerInfo) String() string { return awsutil.Prettify(s) } @@ -1871,122 +4420,58 @@ func (s ConflictException) 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 ConflictException) GoString() string { +func (s DatasetOwnerInfo) GoString() string { return s.String() } -func newErrorConflictException(v protocol.ResponseMetadata) error { - return &ConflictException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *DatasetOwnerInfo) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DatasetOwnerInfo"} + if s.Email != nil && len(*s.Email) < 4 { + invalidParams.Add(request.NewErrParamMinLen("Email", 4)) } -} - -// Code returns the exception type name. -func (s *ConflictException) Code() string { - return "ConflictException" -} - -// Message returns the exception's message. -func (s *ConflictException) Message() string { - if s.Message_ != nil { - return *s.Message_ + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.PhoneNumber != nil && len(*s.PhoneNumber) < 10 { + invalidParams.Add(request.NewErrParamMinLen("PhoneNumber", 10)) } - return "" -} -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *ConflictException) OrigErr() error { + if invalidParams.Len() > 0 { + return invalidParams + } return nil } -func (s *ConflictException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// SetEmail sets the Email field's value. +func (s *DatasetOwnerInfo) SetEmail(v string) *DatasetOwnerInfo { + s.Email = &v + return s } -// Status code returns the HTTP status code for the request's response error. -func (s *ConflictException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetName sets the Name field's value. +func (s *DatasetOwnerInfo) SetName(v string) *DatasetOwnerInfo { + s.Name = &v + return s } -// RequestID returns the service's response RequestID for request. -func (s *ConflictException) RequestID() string { - return s.RespMetadata.RequestID +// SetPhoneNumber sets the PhoneNumber field's value. +func (s *DatasetOwnerInfo) SetPhoneNumber(v string) *DatasetOwnerInfo { + s.PhoneNumber = &v + return s } -// The request for a CreateChangeset operation. -type CreateChangesetInput struct { - _ struct{} `type:"structure"` - - // Option to indicate how a Changeset will be applied to a Dataset. - // - // * REPLACE - Changeset will be considered as a replacement to all prior - // loaded Changesets. - // - // * APPEND - Changeset will be considered as an addition to the end of all - // prior loaded Changesets. - // - // * MODIFY - Changeset is considered as a replacement to a specific prior - // ingested Changeset. - // - // ChangeType is a required field - ChangeType *string `locationName:"changeType" type:"string" required:"true" enum:"ChangeType"` +// The request for a DeleteDataset operation. +type DeleteDatasetInput struct { + _ struct{} `type:"structure" nopayload:"true"` // A token that ensures idempotency. This token expires in 10 minutes. - ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // The unique identifier for the FinSpace Dataset where the Changeset will be - // created. + // The unique identifier of the Dataset to be deleted. // // DatasetId is a required field DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` - - // Options that define the structure of the source file(s) including the format - // type (formatType), header row (withHeader), data separation character (separator) - // and the type of compression (compression). - // - // formatType is a required attribute and can have the following values: - // - // * PARQUET - Parquet source file format. - // - // * CSV - CSV source file format. - // - // * JSON - JSON source file format. - // - // * XML - XML source file format. - // - // Here is an example of how you could specify the formatParams: - // - // "formatParams": { "formatType": "CSV", "withHeader": "true", "separator": - // ",", "compression":"None" } - // - // Note that if you only provide formatType as CSV, the rest of the attributes - // will automatically default to CSV values as following: - // - // { "withHeader": "true", "separator": "," } - // - // For more information about supported file formats, see Supported Data Types - // and File Formats (https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html) - // in the FinSpace User Guide. - // - // FormatParams is a required field - FormatParams map[string]*string `locationName:"formatParams" type:"map" required:"true"` - - // Options that define the location of the data being ingested (s3SourcePath) - // and the source of the changeset (sourceType). - // - // Both s3SourcePath and sourceType are required attributes. - // - // Here is an example of how you could specify the sourceParams: - // - // "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", - // "sourceType": "S3" } - // - // The S3 path that you specify must allow the FinSpace role access. To do that, - // you first need to configure the IAM policy on S3 bucket. For more information, - // see Loading data from an Amazon S3 Bucket using the FinSpace API (https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets)section. - // - // SourceParams is a required field - SourceParams map[string]*string `locationName:"sourceParams" type:"map" required:"true"` } // String returns the string representation. @@ -1994,7 +4479,7 @@ type CreateChangesetInput 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 CreateChangesetInput) String() string { +func (s DeleteDatasetInput) String() string { return awsutil.Prettify(s) } @@ -2003,16 +4488,13 @@ func (s CreateChangesetInput) 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 CreateChangesetInput) GoString() string { +func (s DeleteDatasetInput) GoString() string { return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *CreateChangesetInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateChangesetInput"} - if s.ChangeType == nil { - invalidParams.Add(request.NewErrParamRequired("ChangeType")) - } +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteDatasetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteDatasetInput"} if s.ClientToken != nil && len(*s.ClientToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) } @@ -2022,12 +4504,6 @@ func (s *CreateChangesetInput) Validate() error { if s.DatasetId != nil && len(*s.DatasetId) < 1 { invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) } - if s.FormatParams == nil { - invalidParams.Add(request.NewErrParamRequired("FormatParams")) - } - if s.SourceParams == nil { - invalidParams.Add(request.NewErrParamRequired("SourceParams")) - } if invalidParams.Len() > 0 { return invalidParams @@ -2035,44 +4511,23 @@ func (s *CreateChangesetInput) Validate() error { return nil } -// SetChangeType sets the ChangeType field's value. -func (s *CreateChangesetInput) SetChangeType(v string) *CreateChangesetInput { - s.ChangeType = &v - return s -} - // SetClientToken sets the ClientToken field's value. -func (s *CreateChangesetInput) SetClientToken(v string) *CreateChangesetInput { +func (s *DeleteDatasetInput) SetClientToken(v string) *DeleteDatasetInput { s.ClientToken = &v return s } // SetDatasetId sets the DatasetId field's value. -func (s *CreateChangesetInput) SetDatasetId(v string) *CreateChangesetInput { +func (s *DeleteDatasetInput) SetDatasetId(v string) *DeleteDatasetInput { s.DatasetId = &v return s } -// SetFormatParams sets the FormatParams field's value. -func (s *CreateChangesetInput) SetFormatParams(v map[string]*string) *CreateChangesetInput { - s.FormatParams = v - return s -} - -// SetSourceParams sets the SourceParams field's value. -func (s *CreateChangesetInput) SetSourceParams(v map[string]*string) *CreateChangesetInput { - s.SourceParams = v - return s -} - -// The response from a CreateChangeset operation. -type CreateChangesetOutput struct { +// The response from an DeleteDataset operation +type DeleteDatasetOutput struct { _ struct{} `type:"structure"` - // The unique identifier of the Changeset that is created. - ChangesetId *string `locationName:"changesetId" min:"1" type:"string"` - - // The unique identifier for the FinSpace Dataset where the Changeset is created. + // The unique identifier for the deleted Dataset. DatasetId *string `locationName:"datasetId" min:"1" type:"string"` } @@ -2081,7 +4536,7 @@ type CreateChangesetOutput 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 CreateChangesetOutput) String() string { +func (s DeleteDatasetOutput) String() string { return awsutil.Prettify(s) } @@ -2090,52 +4545,26 @@ func (s CreateChangesetOutput) 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 CreateChangesetOutput) GoString() string { +func (s DeleteDatasetOutput) GoString() string { return s.String() } -// SetChangesetId sets the ChangesetId field's value. -func (s *CreateChangesetOutput) SetChangesetId(v string) *CreateChangesetOutput { - s.ChangesetId = &v - return s -} - // SetDatasetId sets the DatasetId field's value. -func (s *CreateChangesetOutput) SetDatasetId(v string) *CreateChangesetOutput { +func (s *DeleteDatasetOutput) SetDatasetId(v string) *DeleteDatasetOutput { s.DatasetId = &v return s } -// Request for creating a data view. -type CreateDataViewInput struct { - _ struct{} `type:"structure"` - - // Beginning time to use for the Dataview. The value is determined as Epoch - // time in milliseconds. For example, the value for Monday, November 1, 2021 - // 12:00:00 PM UTC is specified as 1635768000000. - AsOfTimestamp *int64 `locationName:"asOfTimestamp" type:"long"` - - // Flag to indicate Dataview should be updated automatically. - AutoUpdate *bool `locationName:"autoUpdate" type:"boolean"` +type DeletePermissionGroupInput struct { + _ struct{} `type:"structure" nopayload:"true"` // A token that ensures idempotency. This token expires in 10 minutes. - ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - - // The unique Dataset identifier that is used to create a Dataview. - // - // DatasetId is a required field - DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` + ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // Options that define the destination type for the Dataview. + // The unique identifier for the permission group that you want to delete. // - // DestinationTypeParams is a required field - DestinationTypeParams *DataViewDestinationTypeParams `locationName:"destinationTypeParams" type:"structure" required:"true"` - - // Ordered set of column names used to partition data. - PartitionColumns []*string `locationName:"partitionColumns" type:"list"` - - // Columns to be used for sorting the data. - SortColumns []*string `locationName:"sortColumns" type:"list"` + // PermissionGroupId is a required field + PermissionGroupId *string `location:"uri" locationName:"permissionGroupId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -2143,7 +4572,7 @@ type CreateDataViewInput 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 CreateDataViewInput) String() string { +func (s DeletePermissionGroupInput) String() string { return awsutil.Prettify(s) } @@ -2152,29 +4581,21 @@ func (s CreateDataViewInput) 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 CreateDataViewInput) GoString() string { +func (s DeletePermissionGroupInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateDataViewInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateDataViewInput"} +func (s *DeletePermissionGroupInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeletePermissionGroupInput"} if s.ClientToken != nil && len(*s.ClientToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) } - if s.DatasetId == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetId")) - } - if s.DatasetId != nil && len(*s.DatasetId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) - } - if s.DestinationTypeParams == nil { - invalidParams.Add(request.NewErrParamRequired("DestinationTypeParams")) + if s.PermissionGroupId == nil { + invalidParams.Add(request.NewErrParamRequired("PermissionGroupId")) } - if s.DestinationTypeParams != nil { - if err := s.DestinationTypeParams.Validate(); err != nil { - invalidParams.AddNested("DestinationTypeParams", err.(request.ErrInvalidParams)) - } + if s.PermissionGroupId != nil && len(*s.PermissionGroupId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PermissionGroupId", 1)) } if invalidParams.Len() > 0 { @@ -2183,57 +4604,59 @@ func (s *CreateDataViewInput) Validate() error { return nil } -// SetAsOfTimestamp sets the AsOfTimestamp field's value. -func (s *CreateDataViewInput) SetAsOfTimestamp(v int64) *CreateDataViewInput { - s.AsOfTimestamp = &v +// SetClientToken sets the ClientToken field's value. +func (s *DeletePermissionGroupInput) SetClientToken(v string) *DeletePermissionGroupInput { + s.ClientToken = &v return s } -// SetAutoUpdate sets the AutoUpdate field's value. -func (s *CreateDataViewInput) SetAutoUpdate(v bool) *CreateDataViewInput { - s.AutoUpdate = &v +// SetPermissionGroupId sets the PermissionGroupId field's value. +func (s *DeletePermissionGroupInput) SetPermissionGroupId(v string) *DeletePermissionGroupInput { + s.PermissionGroupId = &v return s } -// SetClientToken sets the ClientToken field's value. -func (s *CreateDataViewInput) SetClientToken(v string) *CreateDataViewInput { - s.ClientToken = &v - return s -} +type DeletePermissionGroupOutput struct { + _ struct{} `type:"structure"` -// SetDatasetId sets the DatasetId field's value. -func (s *CreateDataViewInput) SetDatasetId(v string) *CreateDataViewInput { - s.DatasetId = &v - return s + // The unique identifier for the deleted permission group. + PermissionGroupId *string `locationName:"permissionGroupId" min:"1" type:"string"` } -// SetDestinationTypeParams sets the DestinationTypeParams field's value. -func (s *CreateDataViewInput) SetDestinationTypeParams(v *DataViewDestinationTypeParams) *CreateDataViewInput { - s.DestinationTypeParams = v - return s +// 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 DeletePermissionGroupOutput) String() string { + return awsutil.Prettify(s) } -// SetPartitionColumns sets the PartitionColumns field's value. -func (s *CreateDataViewInput) SetPartitionColumns(v []*string) *CreateDataViewInput { - s.PartitionColumns = v - return 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 DeletePermissionGroupOutput) GoString() string { + return s.String() } -// SetSortColumns sets the SortColumns field's value. -func (s *CreateDataViewInput) SetSortColumns(v []*string) *CreateDataViewInput { - s.SortColumns = v +// SetPermissionGroupId sets the PermissionGroupId field's value. +func (s *DeletePermissionGroupOutput) SetPermissionGroupId(v string) *DeletePermissionGroupOutput { + s.PermissionGroupId = &v return s } -// Response for creating a data view. -type CreateDataViewOutput struct { +type DisableUserInput struct { _ struct{} `type:"structure"` - // The unique identifier for the created Dataview. - DataViewId *string `locationName:"dataViewId" min:"1" type:"string"` + // A token that ensures idempotency. This token expires in 10 minutes. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // The unique identifier of the Dataset used for the Dataview. - DatasetId *string `locationName:"datasetId" min:"1" type:"string"` + // The unique identifier for the user account that you want to disable. + // + // UserId is a required field + UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -2241,7 +4664,7 @@ type CreateDataViewOutput 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 CreateDataViewOutput) String() string { +func (s DisableUserInput) String() string { return awsutil.Prettify(s) } @@ -2250,59 +4673,82 @@ func (s CreateDataViewOutput) 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 CreateDataViewOutput) GoString() string { +func (s DisableUserInput) GoString() string { return s.String() } -// SetDataViewId sets the DataViewId field's value. -func (s *CreateDataViewOutput) SetDataViewId(v string) *CreateDataViewOutput { - s.DataViewId = &v +// Validate inspects the fields of the type to determine if they are valid. +func (s *DisableUserInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DisableUserInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.UserId == nil { + invalidParams.Add(request.NewErrParamRequired("UserId")) + } + if s.UserId != nil && len(*s.UserId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("UserId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *DisableUserInput) SetClientToken(v string) *DisableUserInput { + s.ClientToken = &v return s } -// SetDatasetId sets the DatasetId field's value. -func (s *CreateDataViewOutput) SetDatasetId(v string) *CreateDataViewOutput { - s.DatasetId = &v +// SetUserId sets the UserId field's value. +func (s *DisableUserInput) SetUserId(v string) *DisableUserInput { + s.UserId = &v return s } -// The request for a CreateDataset operation -type CreateDatasetInput struct { +type DisableUserOutput struct { _ struct{} `type:"structure"` - // The unique resource identifier for a Dataset. - Alias *string `locationName:"alias" min:"1" type:"string"` + // The unique identifier for the disabled user account. + UserId *string `locationName:"userId" min:"1" type:"string"` +} - // A token that ensures idempotency. This token expires in 10 minutes. - ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"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 DisableUserOutput) String() string { + return awsutil.Prettify(s) +} - // Description of a Dataset. - DatasetDescription *string `locationName:"datasetDescription" min:"1" type:"string"` +// 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 DisableUserOutput) GoString() string { + return s.String() +} - // Display title for a FinSpace Dataset. - // - // DatasetTitle is a required field - DatasetTitle *string `locationName:"datasetTitle" min:"1" type:"string" required:"true"` +// SetUserId sets the UserId field's value. +func (s *DisableUserOutput) SetUserId(v string) *DisableUserOutput { + s.UserId = &v + return s +} - // The format in which Dataset data is structured. - // - // * TABULAR - Data is structured in a tabular format. - // - // * NON_TABULAR - Data is structured in a non-tabular format. - // - // Kind is a required field - Kind *string `locationName:"kind" type:"string" required:"true" enum:"DatasetKind"` +type EnableUserInput struct { + _ struct{} `type:"structure"` - // Contact information for a Dataset owner. - OwnerInfo *DatasetOwnerInfo `locationName:"ownerInfo" type:"structure"` + // A token that ensures idempotency. This token expires in 10 minutes. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // Permission group parameters for Dataset permissions. + // The unique identifier for the user account that you want to enable. // - // PermissionGroupParams is a required field - PermissionGroupParams *PermissionGroupParams `locationName:"permissionGroupParams" type:"structure" required:"true"` - - // Definition for a schema on a tabular Dataset. - SchemaDefinition *SchemaUnion `locationName:"schemaDefinition" type:"structure"` + // UserId is a required field + UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -2310,7 +4756,7 @@ type CreateDatasetInput 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 CreateDatasetInput) String() string { +func (s EnableUserInput) String() string { return awsutil.Prettify(s) } @@ -2319,43 +4765,21 @@ func (s CreateDatasetInput) 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 CreateDatasetInput) GoString() string { +func (s EnableUserInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateDatasetInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateDatasetInput"} - if s.Alias != nil && len(*s.Alias) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Alias", 1)) - } +func (s *EnableUserInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EnableUserInput"} if s.ClientToken != nil && len(*s.ClientToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) - } - if s.DatasetDescription != nil && len(*s.DatasetDescription) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatasetDescription", 1)) - } - if s.DatasetTitle == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetTitle")) - } - if s.DatasetTitle != nil && len(*s.DatasetTitle) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatasetTitle", 1)) - } - if s.Kind == nil { - invalidParams.Add(request.NewErrParamRequired("Kind")) - } - if s.PermissionGroupParams == nil { - invalidParams.Add(request.NewErrParamRequired("PermissionGroupParams")) - } - if s.OwnerInfo != nil { - if err := s.OwnerInfo.Validate(); err != nil { - invalidParams.AddNested("OwnerInfo", err.(request.ErrInvalidParams)) - } - } - if s.PermissionGroupParams != nil { - if err := s.PermissionGroupParams.Validate(); err != nil { - invalidParams.AddNested("PermissionGroupParams", err.(request.ErrInvalidParams)) - } + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.UserId == nil { + invalidParams.Add(request.NewErrParamRequired("UserId")) + } + if s.UserId != nil && len(*s.UserId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("UserId", 1)) } if invalidParams.Len() > 0 { @@ -2364,60 +4788,23 @@ func (s *CreateDatasetInput) Validate() error { return nil } -// SetAlias sets the Alias field's value. -func (s *CreateDatasetInput) SetAlias(v string) *CreateDatasetInput { - s.Alias = &v - return s -} - // SetClientToken sets the ClientToken field's value. -func (s *CreateDatasetInput) SetClientToken(v string) *CreateDatasetInput { +func (s *EnableUserInput) SetClientToken(v string) *EnableUserInput { s.ClientToken = &v return s } -// SetDatasetDescription sets the DatasetDescription field's value. -func (s *CreateDatasetInput) SetDatasetDescription(v string) *CreateDatasetInput { - s.DatasetDescription = &v - return s -} - -// SetDatasetTitle sets the DatasetTitle field's value. -func (s *CreateDatasetInput) SetDatasetTitle(v string) *CreateDatasetInput { - s.DatasetTitle = &v - return s -} - -// SetKind sets the Kind field's value. -func (s *CreateDatasetInput) SetKind(v string) *CreateDatasetInput { - s.Kind = &v - return s -} - -// SetOwnerInfo sets the OwnerInfo field's value. -func (s *CreateDatasetInput) SetOwnerInfo(v *DatasetOwnerInfo) *CreateDatasetInput { - s.OwnerInfo = v - return s -} - -// SetPermissionGroupParams sets the PermissionGroupParams field's value. -func (s *CreateDatasetInput) SetPermissionGroupParams(v *PermissionGroupParams) *CreateDatasetInput { - s.PermissionGroupParams = v - return s -} - -// SetSchemaDefinition sets the SchemaDefinition field's value. -func (s *CreateDatasetInput) SetSchemaDefinition(v *SchemaUnion) *CreateDatasetInput { - s.SchemaDefinition = v +// SetUserId sets the UserId field's value. +func (s *EnableUserInput) SetUserId(v string) *EnableUserInput { + s.UserId = &v return s } -// The response from a CreateDataset operation -type CreateDatasetOutput struct { +type EnableUserOutput struct { _ struct{} `type:"structure"` - // The unique identifier for the created Dataset. - DatasetId *string `locationName:"datasetId" min:"1" type:"string"` + // The unique identifier for the enabled user account. + UserId *string `locationName:"userId" min:"1" type:"string"` } // String returns the string representation. @@ -2425,7 +4812,7 @@ type CreateDatasetOutput 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 CreateDatasetOutput) String() string { +func (s EnableUserOutput) String() string { return awsutil.Prettify(s) } @@ -2434,28 +4821,29 @@ func (s CreateDatasetOutput) 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 CreateDatasetOutput) GoString() string { +func (s EnableUserOutput) GoString() string { return s.String() } -// SetDatasetId sets the DatasetId field's value. -func (s *CreateDatasetOutput) SetDatasetId(v string) *CreateDatasetOutput { - s.DatasetId = &v +// SetUserId sets the UserId field's value. +func (s *EnableUserOutput) SetUserId(v string) *EnableUserOutput { + s.UserId = &v return s } -// Short term API credentials. -type Credentials struct { - _ struct{} `type:"structure"` - - // The access key identifier. - AccessKeyId *string `locationName:"accessKeyId" min:"1" type:"string"` +// Request to describe a changeset. +type GetChangesetInput struct { + _ struct{} `type:"structure" nopayload:"true"` - // The access key. - SecretAccessKey *string `locationName:"secretAccessKey" type:"string"` + // The unique identifier of the Changeset for which to get data. + // + // ChangesetId is a required field + ChangesetId *string `location:"uri" locationName:"changesetId" min:"1" type:"string" required:"true"` - // The session token. - SessionToken *string `locationName:"sessionToken" type:"string"` + // The unique identifier for the FinSpace Dataset where the Changeset is created. + // + // DatasetId is a required field + DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -2463,7 +4851,7 @@ type Credentials 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 Credentials) String() string { +func (s GetChangesetInput) String() string { return awsutil.Prettify(s) } @@ -2472,54 +4860,101 @@ func (s Credentials) 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 Credentials) GoString() string { +func (s GetChangesetInput) GoString() string { return s.String() } -// SetAccessKeyId sets the AccessKeyId field's value. -func (s *Credentials) SetAccessKeyId(v string) *Credentials { - s.AccessKeyId = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetChangesetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetChangesetInput"} + if s.ChangesetId == nil { + invalidParams.Add(request.NewErrParamRequired("ChangesetId")) + } + if s.ChangesetId != nil && len(*s.ChangesetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ChangesetId", 1)) + } + if s.DatasetId == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetId")) + } + if s.DatasetId != nil && len(*s.DatasetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetSecretAccessKey sets the SecretAccessKey field's value. -func (s *Credentials) SetSecretAccessKey(v string) *Credentials { - s.SecretAccessKey = &v +// SetChangesetId sets the ChangesetId field's value. +func (s *GetChangesetInput) SetChangesetId(v string) *GetChangesetInput { + s.ChangesetId = &v return s } -// SetSessionToken sets the SessionToken field's value. -func (s *Credentials) SetSessionToken(v string) *Credentials { - s.SessionToken = &v +// SetDatasetId sets the DatasetId field's value. +func (s *GetChangesetInput) SetDatasetId(v string) *GetChangesetInput { + s.DatasetId = &v return s } -// Structure for the Dataview destination type parameters. -type DataViewDestinationTypeParams struct { +// The response from a describe changeset operation +type GetChangesetOutput struct { _ struct{} `type:"structure"` - // Destination type for a Dataview. + // Beginning time from which the Changeset is active. The value is determined + // as epoch time in milliseconds. For example, the value for Monday, November + // 1, 2021 12:00:00 PM UTC is specified as 1635768000000. + ActiveFromTimestamp *int64 `locationName:"activeFromTimestamp" type:"long"` + + // Time until which the Changeset is active. The value is determined as epoch + // time in milliseconds. For example, the value for Monday, November 1, 2021 + // 12:00:00 PM UTC is specified as 1635768000000. + ActiveUntilTimestamp *int64 `locationName:"activeUntilTimestamp" type:"long"` + + // Type that indicates how a Changeset is applied to a Dataset. // - // * GLUE_TABLE - Glue table destination type. + // * REPLACE – Changeset is considered as a replacement to all prior loaded + // Changesets. // - // * S3 - S3 destination type. + // * APPEND – Changeset is considered as an addition to the end of all + // prior loaded Changesets. // - // DestinationType is a required field - DestinationType *string `locationName:"destinationType" type:"string" required:"true"` + // * MODIFY – Changeset is considered as a replacement to a specific prior + // ingested Changeset. + ChangeType *string `locationName:"changeType" type:"string" enum:"ChangeType"` - // Data view export file format. - // - // * PARQUET - Parquet export file format. - // - // * DELIMITED_TEXT - Delimited text export file format. - S3DestinationExportFileFormat *string `locationName:"s3DestinationExportFileFormat" type:"string" enum:"ExportFileFormat"` + // The ARN identifier of the Changeset. + ChangesetArn *string `locationName:"changesetArn" type:"string"` - // Format Options for S3 Destination type. - // - // Here is an example of how you could specify the s3DestinationExportFileFormatOptions - // - // { "header": "true", "delimiter": ",", "compression": "gzip" } - S3DestinationExportFileFormatOptions map[string]*string `locationName:"s3DestinationExportFileFormatOptions" type:"map"` + // The unique identifier for a Changeset. + ChangesetId *string `locationName:"changesetId" min:"1" type:"string"` + + // The timestamp at which the Changeset was created in FinSpace. The value is + // determined as epoch time in milliseconds. For example, the value for Monday, + // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. + CreateTime *int64 `locationName:"createTime" type:"long"` + + // The unique identifier for the FinSpace Dataset where the Changeset is created. + DatasetId *string `locationName:"datasetId" min:"1" type:"string"` + + // The structure with error messages. + ErrorInfo *ChangesetErrorInfo `locationName:"errorInfo" type:"structure"` + + // Structure of the source file(s). + FormatParams map[string]*string `locationName:"formatParams" type:"map"` + + // Options that define the location of the data being ingested. + SourceParams map[string]*string `locationName:"sourceParams" type:"map"` + + // The status of Changeset creation operation. + Status *string `locationName:"status" type:"string" enum:"IngestionStatus"` + + // The unique identifier of the updated Changeset. + UpdatedByChangesetId *string `locationName:"updatedByChangesetId" min:"1" type:"string"` + + // The unique identifier of the Changeset that is being updated. + UpdatesChangesetId *string `locationName:"updatesChangesetId" min:"1" type:"string"` } // String returns the string representation. @@ -2527,7 +4962,7 @@ type DataViewDestinationTypeParams 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 DataViewDestinationTypeParams) String() string { +func (s GetChangesetOutput) String() string { return awsutil.Prettify(s) } @@ -2536,68 +4971,102 @@ func (s DataViewDestinationTypeParams) 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 DataViewDestinationTypeParams) GoString() string { +func (s GetChangesetOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DataViewDestinationTypeParams) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DataViewDestinationTypeParams"} - if s.DestinationType == nil { - invalidParams.Add(request.NewErrParamRequired("DestinationType")) - } +// SetActiveFromTimestamp sets the ActiveFromTimestamp field's value. +func (s *GetChangesetOutput) SetActiveFromTimestamp(v int64) *GetChangesetOutput { + s.ActiveFromTimestamp = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetActiveUntilTimestamp sets the ActiveUntilTimestamp field's value. +func (s *GetChangesetOutput) SetActiveUntilTimestamp(v int64) *GetChangesetOutput { + s.ActiveUntilTimestamp = &v + return s } -// SetDestinationType sets the DestinationType field's value. -func (s *DataViewDestinationTypeParams) SetDestinationType(v string) *DataViewDestinationTypeParams { - s.DestinationType = &v +// SetChangeType sets the ChangeType field's value. +func (s *GetChangesetOutput) SetChangeType(v string) *GetChangesetOutput { + s.ChangeType = &v return s } -// SetS3DestinationExportFileFormat sets the S3DestinationExportFileFormat field's value. -func (s *DataViewDestinationTypeParams) SetS3DestinationExportFileFormat(v string) *DataViewDestinationTypeParams { - s.S3DestinationExportFileFormat = &v +// SetChangesetArn sets the ChangesetArn field's value. +func (s *GetChangesetOutput) SetChangesetArn(v string) *GetChangesetOutput { + s.ChangesetArn = &v return s } -// SetS3DestinationExportFileFormatOptions sets the S3DestinationExportFileFormatOptions field's value. -func (s *DataViewDestinationTypeParams) SetS3DestinationExportFileFormatOptions(v map[string]*string) *DataViewDestinationTypeParams { - s.S3DestinationExportFileFormatOptions = v +// SetChangesetId sets the ChangesetId field's value. +func (s *GetChangesetOutput) SetChangesetId(v string) *GetChangesetOutput { + s.ChangesetId = &v + return s +} + +// SetCreateTime sets the CreateTime field's value. +func (s *GetChangesetOutput) SetCreateTime(v int64) *GetChangesetOutput { + s.CreateTime = &v + return s +} + +// SetDatasetId sets the DatasetId field's value. +func (s *GetChangesetOutput) SetDatasetId(v string) *GetChangesetOutput { + s.DatasetId = &v + return s +} + +// SetErrorInfo sets the ErrorInfo field's value. +func (s *GetChangesetOutput) SetErrorInfo(v *ChangesetErrorInfo) *GetChangesetOutput { + s.ErrorInfo = v + return s +} + +// SetFormatParams sets the FormatParams field's value. +func (s *GetChangesetOutput) SetFormatParams(v map[string]*string) *GetChangesetOutput { + s.FormatParams = v + return s +} + +// SetSourceParams sets the SourceParams field's value. +func (s *GetChangesetOutput) SetSourceParams(v map[string]*string) *GetChangesetOutput { + s.SourceParams = v + return s +} + +// SetStatus sets the Status field's value. +func (s *GetChangesetOutput) SetStatus(v string) *GetChangesetOutput { + s.Status = &v + return s +} + +// SetUpdatedByChangesetId sets the UpdatedByChangesetId field's value. +func (s *GetChangesetOutput) SetUpdatedByChangesetId(v string) *GetChangesetOutput { + s.UpdatedByChangesetId = &v + return s +} + +// SetUpdatesChangesetId sets the UpdatesChangesetId field's value. +func (s *GetChangesetOutput) SetUpdatesChangesetId(v string) *GetChangesetOutput { + s.UpdatesChangesetId = &v return s } -// The structure with error messages. -type DataViewErrorInfo struct { - _ struct{} `type:"structure"` +// Request for retrieving a data view detail. Grouped / accessible within a +// dataset by its dataset id. +type GetDataViewInput struct { + _ struct{} `type:"structure" nopayload:"true"` - // The category of the error. - // - // * VALIDATION -The inputs to this request are invalid. - // - // * SERVICE_QUOTA_EXCEEDED - Service quotas have been exceeded. Please contact - // AWS support to increase quotas. - // - // * ACCESS_DENIED - Missing required permission to perform this request. - // - // * RESOURCE_NOT_FOUND - One or more inputs to this request were not found. - // - // * THROTTLING - The system temporarily lacks sufficient resources to process - // the request. - // - // * INTERNAL_SERVICE_EXCEPTION - An internal service error has occurred. - // - // * CANCELLED - Cancelled. + // The unique identifier for the Dataview. // - // * USER_RECOVERABLE - A user recoverable error has occurred. - ErrorCategory *string `locationName:"errorCategory" type:"string" enum:"ErrorCategory"` + // DataViewId is a required field + DataViewId *string `location:"uri" locationName:"dataviewId" min:"1" type:"string" required:"true"` - // The text of the error message. - ErrorMessage *string `locationName:"errorMessage" type:"string"` + // The unique identifier for the Dataset used in the Dataview. + // + // DatasetId is a required field + DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -2605,7 +5074,7 @@ type DataViewErrorInfo 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 DataViewErrorInfo) String() string { +func (s GetDataViewInput) String() string { return awsutil.Prettify(s) } @@ -2614,36 +5083,59 @@ func (s DataViewErrorInfo) 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 DataViewErrorInfo) GoString() string { +func (s GetDataViewInput) GoString() string { return s.String() } -// SetErrorCategory sets the ErrorCategory field's value. -func (s *DataViewErrorInfo) SetErrorCategory(v string) *DataViewErrorInfo { - s.ErrorCategory = &v +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetDataViewInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetDataViewInput"} + if s.DataViewId == nil { + invalidParams.Add(request.NewErrParamRequired("DataViewId")) + } + if s.DataViewId != nil && len(*s.DataViewId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DataViewId", 1)) + } + if s.DatasetId == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetId")) + } + if s.DatasetId != nil && len(*s.DatasetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDataViewId sets the DataViewId field's value. +func (s *GetDataViewInput) SetDataViewId(v string) *GetDataViewInput { + s.DataViewId = &v return s } -// SetErrorMessage sets the ErrorMessage field's value. -func (s *DataViewErrorInfo) SetErrorMessage(v string) *DataViewErrorInfo { - s.ErrorMessage = &v +// SetDatasetId sets the DatasetId field's value. +func (s *GetDataViewInput) SetDatasetId(v string) *GetDataViewInput { + s.DatasetId = &v return s } -// Structure for the summary of a Dataview. -type DataViewSummary struct { +// Response from retrieving a dataview, which includes details on the target +// database and table name +type GetDataViewOutput struct { _ struct{} `type:"structure"` - // Time range to use for the Dataview. The value is determined as Epoch time + // Time range to use for the Dataview. The value is determined as epoch time // in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 // PM UTC is specified as 1635768000000. AsOfTimestamp *int64 `locationName:"asOfTimestamp" type:"long"` - // The flag to indicate Dataview should be updated automatically. + // Flag to indicate Dataview should be updated automatically. AutoUpdate *bool `locationName:"autoUpdate" type:"boolean"` // The timestamp at which the Dataview was created in FinSpace. The value is - // determined as Epoch time in milliseconds. For example, the value for Monday, + // determined as epoch time in milliseconds. For example, the value for Monday, // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. CreateTime *int64 `locationName:"createTime" type:"long"` @@ -2653,16 +5145,16 @@ type DataViewSummary struct { // The unique identifier for the Dataview. DataViewId *string `locationName:"dataViewId" min:"1" type:"string"` - // Th unique identifier for the Dataview Dataset. + // The unique identifier for the Dataset used in the Dataview. DatasetId *string `locationName:"datasetId" min:"1" type:"string"` - // Information about the Dataview destination. - DestinationTypeProperties *DataViewDestinationTypeParams `locationName:"destinationTypeProperties" type:"structure"` + // Options that define the destination type for the Dataview. + DestinationTypeParams *DataViewDestinationTypeParams `locationName:"destinationTypeParams" type:"structure"` - // The structure with error messages. + // Information about an error that occurred for the Dataview. ErrorInfo *DataViewErrorInfo `locationName:"errorInfo" type:"structure"` - // The last time that a Dataview was modified. The value is determined as Epoch + // The last time that a Dataview was modified. The value is determined as epoch // time in milliseconds. For example, the value for Monday, November 1, 2021 // 12:00:00 PM UTC is specified as 1635768000000. LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"` @@ -2675,21 +5167,21 @@ type DataViewSummary struct { // The status of a Dataview creation. // - // * RUNNING - Dataview creation is running. + // * RUNNING – Dataview creation is running. // - // * STARTING - Dataview creation is starting. + // * STARTING – Dataview creation is starting. // - // * FAILED - Dataview creation has failed. + // * FAILED – Dataview creation has failed. // - // * CANCELLED - Dataview creation has been cancelled. + // * CANCELLED – Dataview creation has been cancelled. // - // * TIMEOUT - Dataview creation has timed out. + // * TIMEOUT – Dataview creation has timed out. // - // * SUCCESS - Dataview creation has succeeded. + // * SUCCESS – Dataview creation has succeeded. // - // * PENDING - Dataview creation is pending. + // * PENDING – Dataview creation is pending. // - // * FAILED_CLEANUP_FAILED - Dataview creation failed and resource cleanup + // * FAILED_CLEANUP_FAILED – Dataview creation failed and resource cleanup // failed. Status *string `locationName:"status" type:"string" enum:"DataViewStatus"` } @@ -2699,7 +5191,7 @@ type DataViewSummary 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 DataViewSummary) String() string { +func (s GetDataViewOutput) String() string { return awsutil.Prettify(s) } @@ -2708,123 +5200,90 @@ func (s DataViewSummary) 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 DataViewSummary) GoString() string { +func (s GetDataViewOutput) GoString() string { return s.String() } // SetAsOfTimestamp sets the AsOfTimestamp field's value. -func (s *DataViewSummary) SetAsOfTimestamp(v int64) *DataViewSummary { +func (s *GetDataViewOutput) SetAsOfTimestamp(v int64) *GetDataViewOutput { s.AsOfTimestamp = &v return s } // SetAutoUpdate sets the AutoUpdate field's value. -func (s *DataViewSummary) SetAutoUpdate(v bool) *DataViewSummary { +func (s *GetDataViewOutput) SetAutoUpdate(v bool) *GetDataViewOutput { s.AutoUpdate = &v return s } // SetCreateTime sets the CreateTime field's value. -func (s *DataViewSummary) SetCreateTime(v int64) *DataViewSummary { +func (s *GetDataViewOutput) SetCreateTime(v int64) *GetDataViewOutput { s.CreateTime = &v return s } // SetDataViewArn sets the DataViewArn field's value. -func (s *DataViewSummary) SetDataViewArn(v string) *DataViewSummary { +func (s *GetDataViewOutput) SetDataViewArn(v string) *GetDataViewOutput { s.DataViewArn = &v return s } // SetDataViewId sets the DataViewId field's value. -func (s *DataViewSummary) SetDataViewId(v string) *DataViewSummary { +func (s *GetDataViewOutput) SetDataViewId(v string) *GetDataViewOutput { s.DataViewId = &v return s } // SetDatasetId sets the DatasetId field's value. -func (s *DataViewSummary) SetDatasetId(v string) *DataViewSummary { +func (s *GetDataViewOutput) SetDatasetId(v string) *GetDataViewOutput { s.DatasetId = &v return s } -// SetDestinationTypeProperties sets the DestinationTypeProperties field's value. -func (s *DataViewSummary) SetDestinationTypeProperties(v *DataViewDestinationTypeParams) *DataViewSummary { - s.DestinationTypeProperties = v +// SetDestinationTypeParams sets the DestinationTypeParams field's value. +func (s *GetDataViewOutput) SetDestinationTypeParams(v *DataViewDestinationTypeParams) *GetDataViewOutput { + s.DestinationTypeParams = v return s } // SetErrorInfo sets the ErrorInfo field's value. -func (s *DataViewSummary) SetErrorInfo(v *DataViewErrorInfo) *DataViewSummary { +func (s *GetDataViewOutput) SetErrorInfo(v *DataViewErrorInfo) *GetDataViewOutput { s.ErrorInfo = v return s } // SetLastModifiedTime sets the LastModifiedTime field's value. -func (s *DataViewSummary) SetLastModifiedTime(v int64) *DataViewSummary { +func (s *GetDataViewOutput) SetLastModifiedTime(v int64) *GetDataViewOutput { s.LastModifiedTime = &v return s } // SetPartitionColumns sets the PartitionColumns field's value. -func (s *DataViewSummary) SetPartitionColumns(v []*string) *DataViewSummary { +func (s *GetDataViewOutput) SetPartitionColumns(v []*string) *GetDataViewOutput { s.PartitionColumns = v return s } // SetSortColumns sets the SortColumns field's value. -func (s *DataViewSummary) SetSortColumns(v []*string) *DataViewSummary { +func (s *GetDataViewOutput) SetSortColumns(v []*string) *GetDataViewOutput { s.SortColumns = v return s } // SetStatus sets the Status field's value. -func (s *DataViewSummary) SetStatus(v string) *DataViewSummary { +func (s *GetDataViewOutput) SetStatus(v string) *GetDataViewOutput { s.Status = &v return s } -// The structure for a Dataset. -type Dataset struct { - _ struct{} `type:"structure"` - - // The unique resource identifier for a Dataset. - Alias *string `locationName:"alias" min:"1" type:"string"` - - // The timestamp at which the Dataset was created in FinSpace. The value is - // determined as Epoch time in milliseconds. For example, the value for Monday, - // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. - CreateTime *int64 `locationName:"createTime" type:"long"` - - // The ARN identifier of the Dataset. - DatasetArn *string `locationName:"datasetArn" type:"string"` - - // Description for a Dataset. - DatasetDescription *string `locationName:"datasetDescription" min:"1" type:"string"` - - // An identifier for a Dataset. - DatasetId *string `locationName:"datasetId" min:"1" type:"string"` - - // Display title for a Dataset. - DatasetTitle *string `locationName:"datasetTitle" min:"1" type:"string"` +// Request for the GetDataset operation. +type GetDatasetInput struct { + _ struct{} `type:"structure" nopayload:"true"` - // The format in which Dataset data is structured. - // - // * TABULAR - Data is structured in a tabular format. + // The unique identifier for a Dataset. // - // * NON_TABULAR - Data is structured in a non-tabular format. - Kind *string `locationName:"kind" type:"string" enum:"DatasetKind"` - - // The last time that the Dataset was modified. The value is determined as Epoch - // time in milliseconds. For example, the value for Monday, November 1, 2021 - // 12:00:00 PM UTC is specified as 1635768000000. - LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"` - - // Contact information for a Dataset owner. - OwnerInfo *DatasetOwnerInfo `locationName:"ownerInfo" type:"structure"` - - // Definition for a schema on a tabular Dataset. - SchemaDefinition *SchemaUnion `locationName:"schemaDefinition" type:"structure"` + // DatasetId is a required field + DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -2832,7 +5291,7 @@ type Dataset 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 Dataset) String() string { +func (s GetDatasetInput) String() string { return awsutil.Prettify(s) } @@ -2841,82 +5300,81 @@ func (s Dataset) 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 Dataset) GoString() string { +func (s GetDatasetInput) GoString() string { return s.String() } -// SetAlias sets the Alias field's value. -func (s *Dataset) SetAlias(v string) *Dataset { - s.Alias = &v - return s -} - -// SetCreateTime sets the CreateTime field's value. -func (s *Dataset) SetCreateTime(v int64) *Dataset { - s.CreateTime = &v - return s -} - -// SetDatasetArn sets the DatasetArn field's value. -func (s *Dataset) SetDatasetArn(v string) *Dataset { - s.DatasetArn = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetDatasetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetDatasetInput"} + if s.DatasetId == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetId")) + } + if s.DatasetId != nil && len(*s.DatasetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) + } -// SetDatasetDescription sets the DatasetDescription field's value. -func (s *Dataset) SetDatasetDescription(v string) *Dataset { - s.DatasetDescription = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } // SetDatasetId sets the DatasetId field's value. -func (s *Dataset) SetDatasetId(v string) *Dataset { +func (s *GetDatasetInput) SetDatasetId(v string) *GetDatasetInput { s.DatasetId = &v return s } -// SetDatasetTitle sets the DatasetTitle field's value. -func (s *Dataset) SetDatasetTitle(v string) *Dataset { - s.DatasetTitle = &v - return s -} +// Response for the GetDataset operation +type GetDatasetOutput struct { + _ struct{} `type:"structure"` -// SetKind sets the Kind field's value. -func (s *Dataset) SetKind(v string) *Dataset { - s.Kind = &v - return s -} + // The unique resource identifier for a Dataset. + Alias *string `locationName:"alias" min:"1" type:"string"` -// SetLastModifiedTime sets the LastModifiedTime field's value. -func (s *Dataset) SetLastModifiedTime(v int64) *Dataset { - s.LastModifiedTime = &v - return s -} + // The timestamp at which the Dataset was created in FinSpace. The value is + // determined as epoch time in milliseconds. For example, the value for Monday, + // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. + CreateTime *int64 `locationName:"createTime" type:"long"` -// SetOwnerInfo sets the OwnerInfo field's value. -func (s *Dataset) SetOwnerInfo(v *DatasetOwnerInfo) *Dataset { - s.OwnerInfo = v - return s -} + // The ARN identifier of the Dataset. + DatasetArn *string `locationName:"datasetArn" type:"string"` -// SetSchemaDefinition sets the SchemaDefinition field's value. -func (s *Dataset) SetSchemaDefinition(v *SchemaUnion) *Dataset { - s.SchemaDefinition = v - return s -} + // A description of the Dataset. + DatasetDescription *string `locationName:"datasetDescription" min:"1" type:"string"` -// A structure for Dataset owner info. -type DatasetOwnerInfo struct { - _ struct{} `type:"structure"` + // The unique identifier for a Dataset. + DatasetId *string `locationName:"datasetId" min:"1" type:"string"` - // Email address for the Dataset owner. - Email *string `locationName:"email" min:"4" type:"string"` + // Display title for a Dataset. + DatasetTitle *string `locationName:"datasetTitle" min:"1" type:"string"` - // Name of the Dataset owner. - Name *string `locationName:"name" min:"1" type:"string"` + // The format in which Dataset data is structured. + // + // * TABULAR – Data is structured in a tabular format. + // + // * NON_TABULAR – Data is structured in a non-tabular format. + Kind *string `locationName:"kind" type:"string" enum:"DatasetKind"` - // Phone number for the Dataset owner. - PhoneNumber *string `locationName:"phoneNumber" min:"10" type:"string"` + // The last time that the Dataset was modified. The value is determined as epoch + // time in milliseconds. For example, the value for Monday, November 1, 2021 + // 12:00:00 PM UTC is specified as 1635768000000. + LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"` + + // Definition for a schema on a tabular Dataset. + SchemaDefinition *SchemaUnion `locationName:"schemaDefinition" type:"structure"` + + // Status of the Dataset creation. + // + // * PENDING – Dataset is pending creation. + // + // * FAILED – Dataset creation has failed. + // + // * SUCCESS – Dataset creation has succeeded. + // + // * RUNNING – Dataset creation is running. + Status *string `locationName:"status" type:"string" enum:"DatasetStatus"` } // String returns the string representation. @@ -2924,7 +5382,7 @@ type DatasetOwnerInfo 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 DatasetOwnerInfo) String() string { +func (s GetDatasetOutput) String() string { return awsutil.Prettify(s) } @@ -2933,58 +5391,81 @@ func (s DatasetOwnerInfo) 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 DatasetOwnerInfo) GoString() string { +func (s GetDatasetOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DatasetOwnerInfo) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DatasetOwnerInfo"} - if s.Email != nil && len(*s.Email) < 4 { - invalidParams.Add(request.NewErrParamMinLen("Email", 4)) - } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) - } - if s.PhoneNumber != nil && len(*s.PhoneNumber) < 10 { - invalidParams.Add(request.NewErrParamMinLen("PhoneNumber", 10)) - } +// SetAlias sets the Alias field's value. +func (s *GetDatasetOutput) SetAlias(v string) *GetDatasetOutput { + s.Alias = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetCreateTime sets the CreateTime field's value. +func (s *GetDatasetOutput) SetCreateTime(v int64) *GetDatasetOutput { + s.CreateTime = &v + return s } -// SetEmail sets the Email field's value. -func (s *DatasetOwnerInfo) SetEmail(v string) *DatasetOwnerInfo { - s.Email = &v +// SetDatasetArn sets the DatasetArn field's value. +func (s *GetDatasetOutput) SetDatasetArn(v string) *GetDatasetOutput { + s.DatasetArn = &v return s } -// SetName sets the Name field's value. -func (s *DatasetOwnerInfo) SetName(v string) *DatasetOwnerInfo { - s.Name = &v +// SetDatasetDescription sets the DatasetDescription field's value. +func (s *GetDatasetOutput) SetDatasetDescription(v string) *GetDatasetOutput { + s.DatasetDescription = &v return s } -// SetPhoneNumber sets the PhoneNumber field's value. -func (s *DatasetOwnerInfo) SetPhoneNumber(v string) *DatasetOwnerInfo { - s.PhoneNumber = &v +// SetDatasetId sets the DatasetId field's value. +func (s *GetDatasetOutput) SetDatasetId(v string) *GetDatasetOutput { + s.DatasetId = &v return s } -// The request for a DeleteDataset operation. -type DeleteDatasetInput struct { +// SetDatasetTitle sets the DatasetTitle field's value. +func (s *GetDatasetOutput) SetDatasetTitle(v string) *GetDatasetOutput { + s.DatasetTitle = &v + return s +} + +// SetKind sets the Kind field's value. +func (s *GetDatasetOutput) SetKind(v string) *GetDatasetOutput { + s.Kind = &v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *GetDatasetOutput) SetLastModifiedTime(v int64) *GetDatasetOutput { + s.LastModifiedTime = &v + return s +} + +// SetSchemaDefinition sets the SchemaDefinition field's value. +func (s *GetDatasetOutput) SetSchemaDefinition(v *SchemaUnion) *GetDatasetOutput { + s.SchemaDefinition = v + return s +} + +// SetStatus sets the Status field's value. +func (s *GetDatasetOutput) SetStatus(v string) *GetDatasetOutput { + s.Status = &v + return s +} + +// Request for GetProgrammaticAccessCredentials operation +type GetProgrammaticAccessCredentialsInput struct { _ struct{} `type:"structure" nopayload:"true"` - // A token that ensures idempotency. This token expires in 10 minutes. - ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + // The time duration in which the credentials remain valid. + DurationInMinutes *int64 `location:"querystring" locationName:"durationInMinutes" min:"60" type:"long"` - // The unique identifier of the Dataset to be deleted. + // The FinSpace environment identifier. // - // DatasetId is a required field - DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` + // EnvironmentId is a required field + EnvironmentId *string `location:"querystring" locationName:"environmentId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -2992,7 +5473,7 @@ type DeleteDatasetInput 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 DeleteDatasetInput) String() string { +func (s GetProgrammaticAccessCredentialsInput) String() string { return awsutil.Prettify(s) } @@ -3001,21 +5482,21 @@ func (s DeleteDatasetInput) 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 DeleteDatasetInput) GoString() string { +func (s GetProgrammaticAccessCredentialsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteDatasetInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteDatasetInput"} - if s.ClientToken != nil && len(*s.ClientToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) +func (s *GetProgrammaticAccessCredentialsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetProgrammaticAccessCredentialsInput"} + if s.DurationInMinutes != nil && *s.DurationInMinutes < 60 { + invalidParams.Add(request.NewErrParamMinValue("DurationInMinutes", 60)) } - if s.DatasetId == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetId")) + if s.EnvironmentId == nil { + invalidParams.Add(request.NewErrParamRequired("EnvironmentId")) } - if s.DatasetId != nil && len(*s.DatasetId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) + if s.EnvironmentId != nil && len(*s.EnvironmentId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EnvironmentId", 1)) } if invalidParams.Len() > 0 { @@ -3024,24 +5505,27 @@ func (s *DeleteDatasetInput) Validate() error { return nil } -// SetClientToken sets the ClientToken field's value. -func (s *DeleteDatasetInput) SetClientToken(v string) *DeleteDatasetInput { - s.ClientToken = &v +// SetDurationInMinutes sets the DurationInMinutes field's value. +func (s *GetProgrammaticAccessCredentialsInput) SetDurationInMinutes(v int64) *GetProgrammaticAccessCredentialsInput { + s.DurationInMinutes = &v return s } -// SetDatasetId sets the DatasetId field's value. -func (s *DeleteDatasetInput) SetDatasetId(v string) *DeleteDatasetInput { - s.DatasetId = &v +// SetEnvironmentId sets the EnvironmentId field's value. +func (s *GetProgrammaticAccessCredentialsInput) SetEnvironmentId(v string) *GetProgrammaticAccessCredentialsInput { + s.EnvironmentId = &v return s } -// The response from an DeleteDataset operation -type DeleteDatasetOutput struct { +// Response for GetProgrammaticAccessCredentials operation +type GetProgrammaticAccessCredentialsOutput struct { _ struct{} `type:"structure"` - // The unique identifier for the deleted Dataset. - DatasetId *string `locationName:"datasetId" min:"1" type:"string"` + // Returns the programmatic credentials. + Credentials *Credentials `locationName:"credentials" type:"structure"` + + // Returns the duration in which the credentials will remain valid. + DurationInMinutes *int64 `locationName:"durationInMinutes" min:"60" type:"long"` } // String returns the string representation. @@ -3049,7 +5533,7 @@ type DeleteDatasetOutput 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 DeleteDatasetOutput) String() string { +func (s GetProgrammaticAccessCredentialsOutput) String() string { return awsutil.Prettify(s) } @@ -3058,29 +5542,29 @@ func (s DeleteDatasetOutput) 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 DeleteDatasetOutput) GoString() string { +func (s GetProgrammaticAccessCredentialsOutput) GoString() string { return s.String() } -// SetDatasetId sets the DatasetId field's value. -func (s *DeleteDatasetOutput) SetDatasetId(v string) *DeleteDatasetOutput { - s.DatasetId = &v +// SetCredentials sets the Credentials field's value. +func (s *GetProgrammaticAccessCredentialsOutput) SetCredentials(v *Credentials) *GetProgrammaticAccessCredentialsOutput { + s.Credentials = v return s } -// Request to describe a changeset. -type GetChangesetInput struct { - _ struct{} `type:"structure" nopayload:"true"` +// SetDurationInMinutes sets the DurationInMinutes field's value. +func (s *GetProgrammaticAccessCredentialsOutput) SetDurationInMinutes(v int64) *GetProgrammaticAccessCredentialsOutput { + s.DurationInMinutes = &v + return s +} - // The unique identifier of the Changeset for which to get data. - // - // ChangesetId is a required field - ChangesetId *string `location:"uri" locationName:"changesetId" min:"1" type:"string" required:"true"` +type GetUserInput struct { + _ struct{} `type:"structure" nopayload:"true"` - // The unique identifier for the FinSpace Dataset where the Changeset is created. + // The unique identifier of the user to get data for. // - // DatasetId is a required field - DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` + // UserId is a required field + UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -3088,7 +5572,7 @@ type GetChangesetInput 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 GetChangesetInput) String() string { +func (s GetUserInput) String() string { return awsutil.Prettify(s) } @@ -3097,24 +5581,18 @@ func (s GetChangesetInput) 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 GetChangesetInput) GoString() string { +func (s GetUserInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetChangesetInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetChangesetInput"} - if s.ChangesetId == nil { - invalidParams.Add(request.NewErrParamRequired("ChangesetId")) - } - if s.ChangesetId != nil && len(*s.ChangesetId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ChangesetId", 1)) - } - if s.DatasetId == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetId")) +func (s *GetUserInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetUserInput"} + if s.UserId == nil { + invalidParams.Add(request.NewErrParamRequired("UserId")) } - if s.DatasetId != nil && len(*s.DatasetId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) + if s.UserId != nil && len(*s.UserId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("UserId", 1)) } if invalidParams.Len() > 0 { @@ -3123,75 +5601,90 @@ func (s *GetChangesetInput) Validate() error { return nil } -// SetChangesetId sets the ChangesetId field's value. -func (s *GetChangesetInput) SetChangesetId(v string) *GetChangesetInput { - s.ChangesetId = &v - return s -} - -// SetDatasetId sets the DatasetId field's value. -func (s *GetChangesetInput) SetDatasetId(v string) *GetChangesetInput { - s.DatasetId = &v +// SetUserId sets the UserId field's value. +func (s *GetUserInput) SetUserId(v string) *GetUserInput { + s.UserId = &v return s } -// The response from a describe changeset operation -type GetChangesetOutput struct { +type GetUserOutput struct { _ struct{} `type:"structure"` - // Beginning time from which the Changeset is active. The value is determined - // as Epoch time in milliseconds. For example, the value for Monday, November - // 1, 2021 12:00:00 PM UTC is specified as 1635768000000. - ActiveFromTimestamp *int64 `locationName:"activeFromTimestamp" type:"long"` - - // Time until which the Changeset is active. The value is determined as Epoch - // time in milliseconds. For example, the value for Monday, November 1, 2021 - // 12:00:00 PM UTC is specified as 1635768000000. - ActiveUntilTimestamp *int64 `locationName:"activeUntilTimestamp" type:"long"` - - // Type that indicates how a Changeset is applied to a Dataset. - // - // * REPLACE - Changeset is considered as a replacement to all prior loaded - // Changesets. + // Indicates whether the user can use the GetProgrammaticAccessCredentials API + // to obtain credentials that can then be used to access other FinSpace Data + // API operations. // - // * APPEND - Changeset is considered as an addition to the end of all prior - // loaded Changesets. + // * ENABLED – The user has permissions to use the APIs. // - // * MODIFY - Changeset is considered as a replacement to a specific prior - // ingested Changeset. - ChangeType *string `locationName:"changeType" type:"string" enum:"ChangeType"` + // * DISABLED – The user does not have permissions to use any APIs. + ApiAccess *string `locationName:"apiAccess" type:"string" enum:"ApiAccess"` - // The ARN identifier of the Changeset. - ChangesetArn *string `locationName:"changesetArn" type:"string"` - - // The unique identifier for a Changeset. - ChangesetId *string `locationName:"changesetId" min:"1" type:"string"` + // The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials + // API to obtain a credentials token for a specific FinSpace user. This must + // be an IAM role within your FinSpace account. + ApiAccessPrincipalArn *string `locationName:"apiAccessPrincipalArn" min:"20" type:"string"` - // The timestamp at which the Changeset was created in FinSpace. The value is - // determined as Epoch time in milliseconds. For example, the value for Monday, - // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. + // The timestamp at which the user account was created in FinSpace. The value + // is determined as epoch time in milliseconds. CreateTime *int64 `locationName:"createTime" type:"long"` - // The unique identifier for the FinSpace Dataset where the Changeset is created. - DatasetId *string `locationName:"datasetId" min:"1" type:"string"` + // The email address that is associated with the user. + // + // EmailAddress is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by GetUserOutput's + // String and GoString methods. + EmailAddress *string `locationName:"emailAddress" min:"4" type:"string" sensitive:"true"` - // The structure with error messages. - ErrorInfo *ChangesetErrorInfo `locationName:"errorInfo" type:"structure"` + // The first name of the user. + // + // FirstName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by GetUserOutput's + // String and GoString methods. + FirstName *string `locationName:"firstName" min:"1" type:"string" sensitive:"true"` - // Structure of the source file(s). - FormatParams map[string]*string `locationName:"formatParams" type:"map"` + // Describes the last time the user account was disabled. The value is determined + // as epoch time in milliseconds. + LastDisabledTime *int64 `locationName:"lastDisabledTime" type:"long"` - // Options that define the location of the data being ingested. - SourceParams map[string]*string `locationName:"sourceParams" type:"map"` + // Describes the last time the user account was enabled. The value is determined + // as epoch time in milliseconds. + LastEnabledTime *int64 `locationName:"lastEnabledTime" type:"long"` - // The status of Changeset creation operation. - Status *string `locationName:"status" type:"string" enum:"IngestionStatus"` + // Describes the last time that the user logged into their account. The value + // is determined as epoch time in milliseconds. + LastLoginTime *int64 `locationName:"lastLoginTime" type:"long"` - // The unique identifier of the updated Changeset. - UpdatedByChangesetId *string `locationName:"updatedByChangesetId" min:"1" type:"string"` + // Describes the last time the user account was updated. The value is determined + // as epoch time in milliseconds. + LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"` - // The unique identifier of the Changeset that is being updated. - UpdatesChangesetId *string `locationName:"updatesChangesetId" min:"1" type:"string"` + // The last name of the user. + // + // LastName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by GetUserOutput's + // String and GoString methods. + LastName *string `locationName:"lastName" min:"1" type:"string" sensitive:"true"` + + // The current status of the user account. + // + // * CREATING – The user account creation is in progress. + // + // * ENABLED – The user account is created and is currently active. + // + // * DISABLED – The user account is currently inactive. + Status *string `locationName:"status" type:"string" enum:"UserStatus"` + + // Indicates the type of user. + // + // * SUPER_USER – A user with permission to all the functionality and data + // in FinSpace. + // + // * APP_USER – A user with specific permissions in FinSpace. The users + // are assigned permissions by adding them to a permissions group. + Type *string `locationName:"type" type:"string" enum:"UserType"` + + // The unique identifier for the user account that is retrieved. + UserId *string `locationName:"userId" min:"1" type:"string"` } // String returns the string representation. @@ -3199,7 +5692,7 @@ type GetChangesetOutput 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 GetChangesetOutput) String() string { +func (s GetUserOutput) String() string { return awsutil.Prettify(s) } @@ -3208,102 +5701,101 @@ func (s GetChangesetOutput) 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 GetChangesetOutput) GoString() string { +func (s GetUserOutput) GoString() string { return s.String() } -// SetActiveFromTimestamp sets the ActiveFromTimestamp field's value. -func (s *GetChangesetOutput) SetActiveFromTimestamp(v int64) *GetChangesetOutput { - s.ActiveFromTimestamp = &v +// SetApiAccess sets the ApiAccess field's value. +func (s *GetUserOutput) SetApiAccess(v string) *GetUserOutput { + s.ApiAccess = &v return s } -// SetActiveUntilTimestamp sets the ActiveUntilTimestamp field's value. -func (s *GetChangesetOutput) SetActiveUntilTimestamp(v int64) *GetChangesetOutput { - s.ActiveUntilTimestamp = &v +// SetApiAccessPrincipalArn sets the ApiAccessPrincipalArn field's value. +func (s *GetUserOutput) SetApiAccessPrincipalArn(v string) *GetUserOutput { + s.ApiAccessPrincipalArn = &v return s } -// SetChangeType sets the ChangeType field's value. -func (s *GetChangesetOutput) SetChangeType(v string) *GetChangesetOutput { - s.ChangeType = &v +// SetCreateTime sets the CreateTime field's value. +func (s *GetUserOutput) SetCreateTime(v int64) *GetUserOutput { + s.CreateTime = &v return s } -// SetChangesetArn sets the ChangesetArn field's value. -func (s *GetChangesetOutput) SetChangesetArn(v string) *GetChangesetOutput { - s.ChangesetArn = &v +// SetEmailAddress sets the EmailAddress field's value. +func (s *GetUserOutput) SetEmailAddress(v string) *GetUserOutput { + s.EmailAddress = &v return s } -// SetChangesetId sets the ChangesetId field's value. -func (s *GetChangesetOutput) SetChangesetId(v string) *GetChangesetOutput { - s.ChangesetId = &v +// SetFirstName sets the FirstName field's value. +func (s *GetUserOutput) SetFirstName(v string) *GetUserOutput { + s.FirstName = &v return s } -// SetCreateTime sets the CreateTime field's value. -func (s *GetChangesetOutput) SetCreateTime(v int64) *GetChangesetOutput { - s.CreateTime = &v +// SetLastDisabledTime sets the LastDisabledTime field's value. +func (s *GetUserOutput) SetLastDisabledTime(v int64) *GetUserOutput { + s.LastDisabledTime = &v return s } -// SetDatasetId sets the DatasetId field's value. -func (s *GetChangesetOutput) SetDatasetId(v string) *GetChangesetOutput { - s.DatasetId = &v +// SetLastEnabledTime sets the LastEnabledTime field's value. +func (s *GetUserOutput) SetLastEnabledTime(v int64) *GetUserOutput { + s.LastEnabledTime = &v return s } -// SetErrorInfo sets the ErrorInfo field's value. -func (s *GetChangesetOutput) SetErrorInfo(v *ChangesetErrorInfo) *GetChangesetOutput { - s.ErrorInfo = v +// SetLastLoginTime sets the LastLoginTime field's value. +func (s *GetUserOutput) SetLastLoginTime(v int64) *GetUserOutput { + s.LastLoginTime = &v return s } -// SetFormatParams sets the FormatParams field's value. -func (s *GetChangesetOutput) SetFormatParams(v map[string]*string) *GetChangesetOutput { - s.FormatParams = v +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *GetUserOutput) SetLastModifiedTime(v int64) *GetUserOutput { + s.LastModifiedTime = &v return s } -// SetSourceParams sets the SourceParams field's value. -func (s *GetChangesetOutput) SetSourceParams(v map[string]*string) *GetChangesetOutput { - s.SourceParams = v +// SetLastName sets the LastName field's value. +func (s *GetUserOutput) SetLastName(v string) *GetUserOutput { + s.LastName = &v return s } // SetStatus sets the Status field's value. -func (s *GetChangesetOutput) SetStatus(v string) *GetChangesetOutput { +func (s *GetUserOutput) SetStatus(v string) *GetUserOutput { s.Status = &v return s } -// SetUpdatedByChangesetId sets the UpdatedByChangesetId field's value. -func (s *GetChangesetOutput) SetUpdatedByChangesetId(v string) *GetChangesetOutput { - s.UpdatedByChangesetId = &v +// SetType sets the Type field's value. +func (s *GetUserOutput) SetType(v string) *GetUserOutput { + s.Type = &v return s } -// SetUpdatesChangesetId sets the UpdatesChangesetId field's value. -func (s *GetChangesetOutput) SetUpdatesChangesetId(v string) *GetChangesetOutput { - s.UpdatesChangesetId = &v +// SetUserId sets the UserId field's value. +func (s *GetUserOutput) SetUserId(v string) *GetUserOutput { + s.UserId = &v return s } -// Request for retrieving a data view detail. Grouped / accessible within a -// dataset by its dataset id. -type GetDataViewInput struct { - _ struct{} `type:"structure" nopayload:"true"` +type GetWorkingLocationInput struct { + _ struct{} `type:"structure"` - // The unique identifier for the Dataview. + // Specify the type of the working location. // - // DataViewId is a required field - DataViewId *string `location:"uri" locationName:"dataviewId" min:"1" type:"string" required:"true"` - - // The unique identifier for the Dataset used in the Dataview. + // * SAGEMAKER – Use the Amazon S3 location as a temporary location to + // store data content when working with FinSpace Notebooks that run on SageMaker + // studio. // - // DatasetId is a required field - DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` + // * INGESTION – Use the Amazon S3 location as a staging location to copy + // your data content and then use the location with the Changeset creation + // operation. + LocationType *string `locationName:"locationType" type:"string" enum:"LocationType"` } // String returns the string representation. @@ -3311,7 +5803,7 @@ type GetDataViewInput 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 GetDataViewInput) String() string { +func (s GetWorkingLocationInput) String() string { return awsutil.Prettify(s) } @@ -3320,107 +5812,72 @@ func (s GetDataViewInput) 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 GetDataViewInput) GoString() string { +func (s GetWorkingLocationInput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *GetDataViewInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetDataViewInput"} - if s.DataViewId == nil { - invalidParams.Add(request.NewErrParamRequired("DataViewId")) - } - if s.DataViewId != nil && len(*s.DataViewId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DataViewId", 1)) - } - if s.DatasetId == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetId")) - } - if s.DatasetId != nil && len(*s.DatasetId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetDataViewId sets the DataViewId field's value. -func (s *GetDataViewInput) SetDataViewId(v string) *GetDataViewInput { - s.DataViewId = &v - return s -} - -// SetDatasetId sets the DatasetId field's value. -func (s *GetDataViewInput) SetDatasetId(v string) *GetDataViewInput { - s.DatasetId = &v +// SetLocationType sets the LocationType field's value. +func (s *GetWorkingLocationInput) SetLocationType(v string) *GetWorkingLocationInput { + s.LocationType = &v return s } -// Response from retrieving a dataview, which includes details on the target -// database and table name -type GetDataViewOutput struct { +type GetWorkingLocationOutput struct { _ struct{} `type:"structure"` - // Time range to use for the Dataview. The value is determined as Epoch time - // in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 - // PM UTC is specified as 1635768000000. - AsOfTimestamp *int64 `locationName:"asOfTimestamp" type:"long"` - - // Flag to indicate Dataview should be updated automatically. - AutoUpdate *bool `locationName:"autoUpdate" type:"boolean"` - - // The timestamp at which the Dataview was created in FinSpace. The value is - // determined as Epoch time in milliseconds. For example, the value for Monday, - // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. - CreateTime *int64 `locationName:"createTime" type:"long"` + // Returns the Amazon S3 bucket name for the working location. + S3Bucket *string `locationName:"s3Bucket" min:"1" type:"string"` - // The ARN identifier of the Dataview. - DataViewArn *string `locationName:"dataViewArn" type:"string"` + // Returns the Amazon S3 Path for the working location. + S3Path *string `locationName:"s3Path" min:"1" type:"string"` - // The unique identifier for the Dataview. - DataViewId *string `locationName:"dataViewId" min:"1" type:"string"` + // Returns the Amazon S3 URI for the working location. + S3Uri *string `locationName:"s3Uri" min:"1" type:"string"` +} - // The unique identifier for the Dataset used in the Dataview. - DatasetId *string `locationName:"datasetId" 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 GetWorkingLocationOutput) String() string { + return awsutil.Prettify(s) +} - // Options that define the destination type for the Dataview. - DestinationTypeParams *DataViewDestinationTypeParams `locationName:"destinationTypeParams" type:"structure"` +// 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 GetWorkingLocationOutput) GoString() string { + return s.String() +} - // Information about an error that occurred for the Dataview. - ErrorInfo *DataViewErrorInfo `locationName:"errorInfo" type:"structure"` +// SetS3Bucket sets the S3Bucket field's value. +func (s *GetWorkingLocationOutput) SetS3Bucket(v string) *GetWorkingLocationOutput { + s.S3Bucket = &v + return s +} - // The last time that a Dataview was modified. The value is determined as Epoch - // time in milliseconds. For example, the value for Monday, November 1, 2021 - // 12:00:00 PM UTC is specified as 1635768000000. - LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"` +// SetS3Path sets the S3Path field's value. +func (s *GetWorkingLocationOutput) SetS3Path(v string) *GetWorkingLocationOutput { + s.S3Path = &v + return s +} - // Ordered set of column names used to partition data. - PartitionColumns []*string `locationName:"partitionColumns" type:"list"` +// SetS3Uri sets the S3Uri field's value. +func (s *GetWorkingLocationOutput) SetS3Uri(v string) *GetWorkingLocationOutput { + s.S3Uri = &v + return s +} - // Columns to be used for sorting the data. - SortColumns []*string `locationName:"sortColumns" type:"list"` +// The request processing has failed because of an unknown error, exception +// or failure. +type InternalServerException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // The status of a Dataview creation. - // - // * RUNNING - Dataview creation is running. - // - // * STARTING - Dataview creation is starting. - // - // * FAILED - Dataview creation has failed. - // - // * CANCELLED - Dataview creation has been cancelled. - // - // * TIMEOUT - Dataview creation has timed out. - // - // * SUCCESS - Dataview creation has succeeded. - // - // * PENDING - Dataview creation is pending. - // - // * FAILED_CLEANUP_FAILED - Dataview creation failed and resource cleanup - // failed. - Status *string `locationName:"status" type:"string" enum:"DataViewStatus"` + Message_ *string `locationName:"message" type:"string"` } // String returns the string representation. @@ -3428,7 +5885,7 @@ type GetDataViewOutput 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 GetDataViewOutput) String() string { +func (s InternalServerException) String() string { return awsutil.Prettify(s) } @@ -3437,90 +5894,126 @@ func (s GetDataViewOutput) 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 GetDataViewOutput) GoString() string { +func (s InternalServerException) GoString() string { return s.String() } -// SetAsOfTimestamp sets the AsOfTimestamp field's value. -func (s *GetDataViewOutput) SetAsOfTimestamp(v int64) *GetDataViewOutput { - s.AsOfTimestamp = &v - return s +func newErrorInternalServerException(v protocol.ResponseMetadata) error { + return &InternalServerException{ + RespMetadata: v, + } } -// SetAutoUpdate sets the AutoUpdate field's value. -func (s *GetDataViewOutput) SetAutoUpdate(v bool) *GetDataViewOutput { - s.AutoUpdate = &v - return s +// Code returns the exception type name. +func (s *InternalServerException) Code() string { + return "InternalServerException" } -// SetCreateTime sets the CreateTime field's value. -func (s *GetDataViewOutput) SetCreateTime(v int64) *GetDataViewOutput { - s.CreateTime = &v - return s +// Message returns the exception's message. +func (s *InternalServerException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" } -// SetDataViewArn sets the DataViewArn field's value. -func (s *GetDataViewOutput) SetDataViewArn(v string) *GetDataViewOutput { - s.DataViewArn = &v - return s +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InternalServerException) OrigErr() error { + return nil } -// SetDataViewId sets the DataViewId field's value. -func (s *GetDataViewOutput) SetDataViewId(v string) *GetDataViewOutput { - s.DataViewId = &v - return s +func (s *InternalServerException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) } -// SetDatasetId sets the DatasetId field's value. -func (s *GetDataViewOutput) SetDatasetId(v string) *GetDataViewOutput { - s.DatasetId = &v - return s +// Status code returns the HTTP status code for the request's response error. +func (s *InternalServerException) StatusCode() int { + return s.RespMetadata.StatusCode } -// SetDestinationTypeParams sets the DestinationTypeParams field's value. -func (s *GetDataViewOutput) SetDestinationTypeParams(v *DataViewDestinationTypeParams) *GetDataViewOutput { - s.DestinationTypeParams = v - return s +// RequestID returns the service's response RequestID for request. +func (s *InternalServerException) RequestID() string { + return s.RespMetadata.RequestID +} + +// A limit has exceeded. +type LimitExceededException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" 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 LimitExceededException) 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 LimitExceededException) GoString() string { + return s.String() +} + +func newErrorLimitExceededException(v protocol.ResponseMetadata) error { + return &LimitExceededException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *LimitExceededException) Code() string { + return "LimitExceededException" } -// SetErrorInfo sets the ErrorInfo field's value. -func (s *GetDataViewOutput) SetErrorInfo(v *DataViewErrorInfo) *GetDataViewOutput { - s.ErrorInfo = v - return s +// Message returns the exception's message. +func (s *LimitExceededException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" } -// SetLastModifiedTime sets the LastModifiedTime field's value. -func (s *GetDataViewOutput) SetLastModifiedTime(v int64) *GetDataViewOutput { - s.LastModifiedTime = &v - return s +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *LimitExceededException) OrigErr() error { + return nil } -// SetPartitionColumns sets the PartitionColumns field's value. -func (s *GetDataViewOutput) SetPartitionColumns(v []*string) *GetDataViewOutput { - s.PartitionColumns = v - return s +func (s *LimitExceededException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) } -// SetSortColumns sets the SortColumns field's value. -func (s *GetDataViewOutput) SetSortColumns(v []*string) *GetDataViewOutput { - s.SortColumns = v - return s +// Status code returns the HTTP status code for the request's response error. +func (s *LimitExceededException) StatusCode() int { + return s.RespMetadata.StatusCode } -// SetStatus sets the Status field's value. -func (s *GetDataViewOutput) SetStatus(v string) *GetDataViewOutput { - s.Status = &v - return s +// RequestID returns the service's response RequestID for request. +func (s *LimitExceededException) RequestID() string { + return s.RespMetadata.RequestID } -// Request for the GetDataset operation. -type GetDatasetInput struct { +// Request to ListChangesetsRequest. It exposes minimal query filters. +type ListChangesetsInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The unique identifier for a Dataset. + // The unique identifier for the FinSpace Dataset to which the Changeset belongs. // // DatasetId is a required field DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` + + // The maximum number of results per page. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // A token that indicates where a results page should begin. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } // String returns the string representation. @@ -3528,7 +6021,7 @@ type GetDatasetInput 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 GetDatasetInput) String() string { +func (s ListChangesetsInput) String() string { return awsutil.Prettify(s) } @@ -3537,19 +6030,22 @@ func (s GetDatasetInput) 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 GetDatasetInput) GoString() string { +func (s ListChangesetsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetDatasetInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetDatasetInput"} +func (s *ListChangesetsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListChangesetsInput"} if s.DatasetId == nil { invalidParams.Add(request.NewErrParamRequired("DatasetId")) } if s.DatasetId != nil && len(*s.DatasetId) < 1 { invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } if invalidParams.Len() > 0 { return invalidParams @@ -3558,60 +6054,79 @@ func (s *GetDatasetInput) Validate() error { } // SetDatasetId sets the DatasetId field's value. -func (s *GetDatasetInput) SetDatasetId(v string) *GetDatasetInput { +func (s *ListChangesetsInput) SetDatasetId(v string) *ListChangesetsInput { s.DatasetId = &v return s } -// Response for the GetDataset operation -type GetDatasetOutput struct { - _ struct{} `type:"structure"` +// SetMaxResults sets the MaxResults field's value. +func (s *ListChangesetsInput) SetMaxResults(v int64) *ListChangesetsInput { + s.MaxResults = &v + return s +} - // The unique resource identifier for a Dataset. - Alias *string `locationName:"alias" min:"1" type:"string"` +// SetNextToken sets the NextToken field's value. +func (s *ListChangesetsInput) SetNextToken(v string) *ListChangesetsInput { + s.NextToken = &v + return s +} - // The timestamp at which the Dataset was created in FinSpace. The value is - // determined as Epoch time in milliseconds. For example, the value for Monday, - // November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. - CreateTime *int64 `locationName:"createTime" type:"long"` +// Response to ListChangesetsResponse. This returns a list of dataset changesets +// that match the query criteria. +type ListChangesetsOutput struct { + _ struct{} `type:"structure"` - // The ARN identifier of the Dataset. - DatasetArn *string `locationName:"datasetArn" type:"string"` + // List of Changesets found. + Changesets []*ChangesetSummary `locationName:"changesets" type:"list"` - // A description of the Dataset. - DatasetDescription *string `locationName:"datasetDescription" min:"1" type:"string"` + // A token that indicates where a results page should begin. + NextToken *string `locationName:"nextToken" type:"string"` +} - // The unique identifier for a Dataset. - DatasetId *string `locationName:"datasetId" 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 ListChangesetsOutput) String() string { + return awsutil.Prettify(s) +} - // Display title for a Dataset. - DatasetTitle *string `locationName:"datasetTitle" min:"1" type:"string"` +// 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 ListChangesetsOutput) GoString() string { + return s.String() +} - // The format in which Dataset data is structured. - // - // * TABULAR - Data is structured in a tabular format. - // - // * NON_TABULAR - Data is structured in a non-tabular format. - Kind *string `locationName:"kind" type:"string" enum:"DatasetKind"` +// SetChangesets sets the Changesets field's value. +func (s *ListChangesetsOutput) SetChangesets(v []*ChangesetSummary) *ListChangesetsOutput { + s.Changesets = v + return s +} - // The last time that the Dataset was modified. The value is determined as Epoch - // time in milliseconds. For example, the value for Monday, November 1, 2021 - // 12:00:00 PM UTC is specified as 1635768000000. - LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"` +// SetNextToken sets the NextToken field's value. +func (s *ListChangesetsOutput) SetNextToken(v string) *ListChangesetsOutput { + s.NextToken = &v + return s +} - // Definition for a schema on a tabular Dataset. - SchemaDefinition *SchemaUnion `locationName:"schemaDefinition" type:"structure"` +// Request for a list data views. +type ListDataViewsInput struct { + _ struct{} `type:"structure" nopayload:"true"` - // Status of the Dataset creation. - // - // * PENDING - Dataset is pending creation. - // - // * FAILED - Dataset creation has failed. - // - // * SUCCESS - Dataset creation has succeeded. + // The unique identifier of the Dataset for which to retrieve Dataviews. // - // * RUNNING - Dataset creation is running. - Status *string `locationName:"status" type:"string" enum:"DatasetStatus"` + // DatasetId is a required field + DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` + + // The maximum number of results per page. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // A token that indicates where a results page should begin. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } // String returns the string representation. @@ -3619,7 +6134,7 @@ type GetDatasetOutput 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 GetDatasetOutput) String() string { +func (s ListDataViewsInput) String() string { return awsutil.Prettify(s) } @@ -3628,81 +6143,96 @@ func (s GetDatasetOutput) 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 GetDatasetOutput) GoString() string { +func (s ListDataViewsInput) GoString() string { return s.String() } -// SetAlias sets the Alias field's value. -func (s *GetDatasetOutput) SetAlias(v string) *GetDatasetOutput { - s.Alias = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListDataViewsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDataViewsInput"} + if s.DatasetId == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetId")) + } + if s.DatasetId != nil && len(*s.DatasetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } -// SetCreateTime sets the CreateTime field's value. -func (s *GetDatasetOutput) SetCreateTime(v int64) *GetDatasetOutput { - s.CreateTime = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetDatasetArn sets the DatasetArn field's value. -func (s *GetDatasetOutput) SetDatasetArn(v string) *GetDatasetOutput { - s.DatasetArn = &v +// SetDatasetId sets the DatasetId field's value. +func (s *ListDataViewsInput) SetDatasetId(v string) *ListDataViewsInput { + s.DatasetId = &v return s } -// SetDatasetDescription sets the DatasetDescription field's value. -func (s *GetDatasetOutput) SetDatasetDescription(v string) *GetDatasetOutput { - s.DatasetDescription = &v +// SetMaxResults sets the MaxResults field's value. +func (s *ListDataViewsInput) SetMaxResults(v int64) *ListDataViewsInput { + s.MaxResults = &v return s } -// SetDatasetId sets the DatasetId field's value. -func (s *GetDatasetOutput) SetDatasetId(v string) *GetDatasetOutput { - s.DatasetId = &v +// SetNextToken sets the NextToken field's value. +func (s *ListDataViewsInput) SetNextToken(v string) *ListDataViewsInput { + s.NextToken = &v return s } -// SetDatasetTitle sets the DatasetTitle field's value. -func (s *GetDatasetOutput) SetDatasetTitle(v string) *GetDatasetOutput { - s.DatasetTitle = &v - return s +type ListDataViewsOutput struct { + _ struct{} `type:"structure"` + + // A list of Dataviews. + DataViews []*DataViewSummary `locationName:"dataViews" type:"list"` + + // A token that indicates where a results page should begin. + NextToken *string `locationName:"nextToken" type:"string"` } -// SetKind sets the Kind field's value. -func (s *GetDatasetOutput) SetKind(v string) *GetDatasetOutput { - s.Kind = &v - return s +// 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 ListDataViewsOutput) String() string { + return awsutil.Prettify(s) } -// SetLastModifiedTime sets the LastModifiedTime field's value. -func (s *GetDatasetOutput) SetLastModifiedTime(v int64) *GetDatasetOutput { - s.LastModifiedTime = &v - return 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 ListDataViewsOutput) GoString() string { + return s.String() } -// SetSchemaDefinition sets the SchemaDefinition field's value. -func (s *GetDatasetOutput) SetSchemaDefinition(v *SchemaUnion) *GetDatasetOutput { - s.SchemaDefinition = v +// SetDataViews sets the DataViews field's value. +func (s *ListDataViewsOutput) SetDataViews(v []*DataViewSummary) *ListDataViewsOutput { + s.DataViews = v return s } -// SetStatus sets the Status field's value. -func (s *GetDatasetOutput) SetStatus(v string) *GetDatasetOutput { - s.Status = &v +// SetNextToken sets the NextToken field's value. +func (s *ListDataViewsOutput) SetNextToken(v string) *ListDataViewsOutput { + s.NextToken = &v return s } -// Request for GetProgrammaticAccessCredentials operation -type GetProgrammaticAccessCredentialsInput struct { +// Request for the ListDatasets operation. +type ListDatasetsInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The time duration in which the credentials remain valid. - DurationInMinutes *int64 `location:"querystring" locationName:"durationInMinutes" min:"60" type:"long"` + // The maximum number of results per page. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // The FinSpace environment identifier. - // - // EnvironmentId is a required field - EnvironmentId *string `location:"querystring" locationName:"environmentId" min:"1" type:"string" required:"true"` + // A token that indicates where a results page should begin. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } // String returns the string representation. @@ -3710,7 +6240,7 @@ type GetProgrammaticAccessCredentialsInput 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 GetProgrammaticAccessCredentialsInput) String() string { +func (s ListDatasetsInput) String() string { return awsutil.Prettify(s) } @@ -3719,21 +6249,15 @@ func (s GetProgrammaticAccessCredentialsInput) 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 GetProgrammaticAccessCredentialsInput) GoString() string { +func (s ListDatasetsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetProgrammaticAccessCredentialsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetProgrammaticAccessCredentialsInput"} - if s.DurationInMinutes != nil && *s.DurationInMinutes < 60 { - invalidParams.Add(request.NewErrParamMinValue("DurationInMinutes", 60)) - } - if s.EnvironmentId == nil { - invalidParams.Add(request.NewErrParamRequired("EnvironmentId")) - } - if s.EnvironmentId != nil && len(*s.EnvironmentId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("EnvironmentId", 1)) +func (s *ListDatasetsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDatasetsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } if invalidParams.Len() > 0 { @@ -3742,27 +6266,27 @@ func (s *GetProgrammaticAccessCredentialsInput) Validate() error { return nil } -// SetDurationInMinutes sets the DurationInMinutes field's value. -func (s *GetProgrammaticAccessCredentialsInput) SetDurationInMinutes(v int64) *GetProgrammaticAccessCredentialsInput { - s.DurationInMinutes = &v +// SetMaxResults sets the MaxResults field's value. +func (s *ListDatasetsInput) SetMaxResults(v int64) *ListDatasetsInput { + s.MaxResults = &v return s } -// SetEnvironmentId sets the EnvironmentId field's value. -func (s *GetProgrammaticAccessCredentialsInput) SetEnvironmentId(v string) *GetProgrammaticAccessCredentialsInput { - s.EnvironmentId = &v +// SetNextToken sets the NextToken field's value. +func (s *ListDatasetsInput) SetNextToken(v string) *ListDatasetsInput { + s.NextToken = &v return s } -// Response for GetProgrammaticAccessCredentials operation -type GetProgrammaticAccessCredentialsOutput struct { +// Response for the ListDatasets operation +type ListDatasetsOutput struct { _ struct{} `type:"structure"` - // Returns the programmatic credentials. - Credentials *Credentials `locationName:"credentials" type:"structure"` + // List of Datasets. + Datasets []*Dataset `locationName:"datasets" type:"list"` - // Returns the duration in which the credentials will remain valid. - DurationInMinutes *int64 `locationName:"durationInMinutes" min:"60" type:"long"` + // A token that indicates where a results page should begin. + NextToken *string `locationName:"nextToken" type:"string"` } // String returns the string representation. @@ -3770,7 +6294,7 @@ type GetProgrammaticAccessCredentialsOutput 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 GetProgrammaticAccessCredentialsOutput) String() string { +func (s ListDatasetsOutput) String() string { return awsutil.Prettify(s) } @@ -3779,35 +6303,32 @@ func (s GetProgrammaticAccessCredentialsOutput) 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 GetProgrammaticAccessCredentialsOutput) GoString() string { +func (s ListDatasetsOutput) GoString() string { return s.String() } -// SetCredentials sets the Credentials field's value. -func (s *GetProgrammaticAccessCredentialsOutput) SetCredentials(v *Credentials) *GetProgrammaticAccessCredentialsOutput { - s.Credentials = v +// SetDatasets sets the Datasets field's value. +func (s *ListDatasetsOutput) SetDatasets(v []*Dataset) *ListDatasetsOutput { + s.Datasets = v return s } -// SetDurationInMinutes sets the DurationInMinutes field's value. -func (s *GetProgrammaticAccessCredentialsOutput) SetDurationInMinutes(v int64) *GetProgrammaticAccessCredentialsOutput { - s.DurationInMinutes = &v +// SetNextToken sets the NextToken field's value. +func (s *ListDatasetsOutput) SetNextToken(v string) *ListDatasetsOutput { + s.NextToken = &v return s } -type GetWorkingLocationInput struct { - _ struct{} `type:"structure"` +type ListPermissionGroupsInput struct { + _ struct{} `type:"structure" nopayload:"true"` - // Specify the type of the working location. - // - // * SAGEMAKER - Use the Amazon S3 location as a temporary location to store - // data content when working with FinSpace Notebooks that run on SageMaker - // studio. + // The maximum number of results per page. // - // * INGESTION - Use the Amazon S3 location as a staging location to copy - // your data content and then use the location with the Changeset creation - // operation. - LocationType *string `locationName:"locationType" type:"string" enum:"LocationType"` + // MaxResults is a required field + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer" required:"true"` + + // A token that indicates where a results page should begin. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } // String returns the string representation. @@ -3815,7 +6336,7 @@ type GetWorkingLocationInput 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 GetWorkingLocationInput) String() string { +func (s ListPermissionGroupsInput) String() string { return awsutil.Prettify(s) } @@ -3824,27 +6345,46 @@ func (s GetWorkingLocationInput) 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 GetWorkingLocationInput) GoString() string { +func (s ListPermissionGroupsInput) GoString() string { return s.String() } -// SetLocationType sets the LocationType field's value. -func (s *GetWorkingLocationInput) SetLocationType(v string) *GetWorkingLocationInput { - s.LocationType = &v +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListPermissionGroupsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListPermissionGroupsInput"} + if s.MaxResults == nil { + invalidParams.Add(request.NewErrParamRequired("MaxResults")) + } + 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 *ListPermissionGroupsInput) SetMaxResults(v int64) *ListPermissionGroupsInput { + s.MaxResults = &v return s } -type GetWorkingLocationOutput struct { - _ struct{} `type:"structure"` +// SetNextToken sets the NextToken field's value. +func (s *ListPermissionGroupsInput) SetNextToken(v string) *ListPermissionGroupsInput { + s.NextToken = &v + return s +} - // Returns the Amazon S3 bucket name for the working location. - S3Bucket *string `locationName:"s3Bucket" min:"1" type:"string"` +type ListPermissionGroupsOutput struct { + _ struct{} `type:"structure"` - // Returns the Amazon S3 Path for the working location. - S3Path *string `locationName:"s3Path" min:"1" type:"string"` + // A token that indicates where a results page should begin. + NextToken *string `locationName:"nextToken" type:"string"` - // Returns the Amazon S3 URI for the working location. - S3Uri *string `locationName:"s3Uri" min:"1" type:"string"` + // A list of all the permission groups. + PermissionGroups []*PermissionGroup `locationName:"permissionGroups" type:"list"` } // String returns the string representation. @@ -3852,7 +6392,7 @@ type GetWorkingLocationOutput 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 GetWorkingLocationOutput) String() string { +func (s ListPermissionGroupsOutput) String() string { return awsutil.Prettify(s) } @@ -3861,35 +6401,32 @@ func (s GetWorkingLocationOutput) 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 GetWorkingLocationOutput) GoString() string { +func (s ListPermissionGroupsOutput) GoString() string { return s.String() } -// SetS3Bucket sets the S3Bucket field's value. -func (s *GetWorkingLocationOutput) SetS3Bucket(v string) *GetWorkingLocationOutput { - s.S3Bucket = &v +// SetNextToken sets the NextToken field's value. +func (s *ListPermissionGroupsOutput) SetNextToken(v string) *ListPermissionGroupsOutput { + s.NextToken = &v return s } -// SetS3Path sets the S3Path field's value. -func (s *GetWorkingLocationOutput) SetS3Path(v string) *GetWorkingLocationOutput { - s.S3Path = &v +// SetPermissionGroups sets the PermissionGroups field's value. +func (s *ListPermissionGroupsOutput) SetPermissionGroups(v []*PermissionGroup) *ListPermissionGroupsOutput { + s.PermissionGroups = v return s } -// SetS3Uri sets the S3Uri field's value. -func (s *GetWorkingLocationOutput) SetS3Uri(v string) *GetWorkingLocationOutput { - s.S3Uri = &v - return s -} +type ListUsersInput struct { + _ struct{} `type:"structure" nopayload:"true"` -// The request processing has failed because of an unknown error, exception -// or failure. -type InternalServerException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + // The maximum number of results per page. + // + // MaxResults is a required field + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer" required:"true"` - Message_ *string `locationName:"message" type:"string"` + // A token that indicates where a results page should begin. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } // String returns the string representation. @@ -3897,7 +6434,7 @@ type InternalServerException 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 InternalServerException) String() string { +func (s ListUsersInput) String() string { return awsutil.Prettify(s) } @@ -3906,54 +6443,46 @@ func (s InternalServerException) 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 InternalServerException) GoString() string { +func (s ListUsersInput) GoString() string { return s.String() } -func newErrorInternalServerException(v protocol.ResponseMetadata) error { - return &InternalServerException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListUsersInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListUsersInput"} + if s.MaxResults == nil { + invalidParams.Add(request.NewErrParamRequired("MaxResults")) } -} - -// Code returns the exception type name. -func (s *InternalServerException) Code() string { - return "InternalServerException" -} - -// Message returns the exception's message. -func (s *InternalServerException) Message() string { - if s.Message_ != nil { - return *s.Message_ + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } - return "" -} -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *InternalServerException) OrigErr() error { + if invalidParams.Len() > 0 { + return invalidParams + } return nil } -func (s *InternalServerException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// SetMaxResults sets the MaxResults field's value. +func (s *ListUsersInput) SetMaxResults(v int64) *ListUsersInput { + s.MaxResults = &v + return s } -// Status code returns the HTTP status code for the request's response error. -func (s *InternalServerException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetNextToken sets the NextToken field's value. +func (s *ListUsersInput) SetNextToken(v string) *ListUsersInput { + s.NextToken = &v + return s } -// RequestID returns the service's response RequestID for request. -func (s *InternalServerException) RequestID() string { - return s.RespMetadata.RequestID -} +type ListUsersOutput struct { + _ struct{} `type:"structure"` -// A limit has exceeded. -type LimitExceededException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + // A token that indicates where a results page should begin. + NextToken *string `locationName:"nextToken" type:"string"` - Message_ *string `locationName:"message" type:"string"` + // A list of all the user accounts. + Users []*User `locationName:"users" type:"list"` } // String returns the string representation. @@ -3961,7 +6490,7 @@ type LimitExceededException 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 LimitExceededException) String() string { +func (s ListUsersOutput) String() string { return awsutil.Prettify(s) } @@ -3970,62 +6499,141 @@ func (s LimitExceededException) 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 LimitExceededException) GoString() string { +func (s ListUsersOutput) GoString() string { return s.String() } -func newErrorLimitExceededException(v protocol.ResponseMetadata) error { - return &LimitExceededException{ - RespMetadata: v, - } +// SetNextToken sets the NextToken field's value. +func (s *ListUsersOutput) SetNextToken(v string) *ListUsersOutput { + s.NextToken = &v + return s } -// Code returns the exception type name. -func (s *LimitExceededException) Code() string { - return "LimitExceededException" +// SetUsers sets the Users field's value. +func (s *ListUsersOutput) SetUsers(v []*User) *ListUsersOutput { + s.Users = v + return s } -// Message returns the exception's message. -func (s *LimitExceededException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" +// The structure for a permission group. +type PermissionGroup struct { + _ struct{} `type:"structure"` + + // Indicates the permissions that are granted to a specific group for accessing + // the FinSpace application. + // + // * CreateDataset – Group members can create new datasets. + // + // * ManageClusters – Group members can manage Apache Spark clusters from + // FinSpace notebooks. + // + // * ManageUsersAndGroups – Group members can manage users and permission + // groups. + // + // * ManageAttributeSets – Group members can manage attribute sets. + // + // * ViewAuditData – Group members can view audit data. + // + // * AccessNotebooks – Group members will have access to FinSpace notebooks. + // + // * GetTemporaryCredentials – Group members can get temporary API credentials. + ApplicationPermissions []*string `locationName:"applicationPermissions" type:"list"` + + // The timestamp at which the group was created in FinSpace. The value is determined + // as epoch time in milliseconds. + CreateTime *int64 `locationName:"createTime" type:"long"` + + // A brief description for the permission group. + // + // Description is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PermissionGroup's + // String and GoString methods. + Description *string `locationName:"description" min:"1" type:"string" sensitive:"true"` + + // Describes the last time the permission group was updated. The value is determined + // as epoch time in milliseconds. + LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"` + + // The name of the permission group. + // + // Name is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by PermissionGroup's + // String and GoString methods. + Name *string `locationName:"name" min:"1" type:"string" sensitive:"true"` + + // The unique identifier for the permission group. + PermissionGroupId *string `locationName:"permissionGroupId" min:"1" type:"string"` } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *LimitExceededException) OrigErr() error { - return nil +// 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 PermissionGroup) String() string { + return awsutil.Prettify(s) } -func (s *LimitExceededException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// 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 PermissionGroup) GoString() string { + return s.String() } -// Status code returns the HTTP status code for the request's response error. -func (s *LimitExceededException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetApplicationPermissions sets the ApplicationPermissions field's value. +func (s *PermissionGroup) SetApplicationPermissions(v []*string) *PermissionGroup { + s.ApplicationPermissions = v + return s } -// RequestID returns the service's response RequestID for request. -func (s *LimitExceededException) RequestID() string { - return s.RespMetadata.RequestID +// SetCreateTime sets the CreateTime field's value. +func (s *PermissionGroup) SetCreateTime(v int64) *PermissionGroup { + s.CreateTime = &v + return s } -// Request to ListChangesetsRequest. It exposes minimal query filters. -type ListChangesetsInput struct { - _ struct{} `type:"structure" nopayload:"true"` +// SetDescription sets the Description field's value. +func (s *PermissionGroup) SetDescription(v string) *PermissionGroup { + s.Description = &v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *PermissionGroup) SetLastModifiedTime(v int64) *PermissionGroup { + s.LastModifiedTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *PermissionGroup) SetName(v string) *PermissionGroup { + s.Name = &v + return s +} + +// SetPermissionGroupId sets the PermissionGroupId field's value. +func (s *PermissionGroup) SetPermissionGroupId(v string) *PermissionGroup { + s.PermissionGroupId = &v + return s +} - // The unique identifier for the FinSpace Dataset to which the Changeset belongs. - // - // DatasetId is a required field - DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` +// Permission group parameters for Dataset permissions. +// +// Here is an example of how you could specify the PermissionGroupParams: +// +// { "permissionGroupId": "0r6fCRtSTUk4XPfXQe3M0g", "datasetPermissions": [ +// {"permission": "ViewDatasetDetails"}, {"permission": "AddDatasetData"}, {"permission": +// "EditDatasetMetadata"}, {"permission": "DeleteDataset"} ] } +type PermissionGroupParams struct { + _ struct{} `type:"structure"` - // The maximum number of results per page. - MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + // List of resource permissions. + DatasetPermissions []*ResourcePermission `locationName:"datasetPermissions" type:"list"` - // A token indicating where a results page should begin. - NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` + // The unique identifier for the PermissionGroup. + PermissionGroupId *string `locationName:"permissionGroupId" min:"1" type:"string"` } // String returns the string representation. @@ -4033,7 +6641,7 @@ type ListChangesetsInput 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 ListChangesetsInput) String() string { +func (s PermissionGroupParams) String() string { return awsutil.Prettify(s) } @@ -4042,21 +6650,25 @@ func (s ListChangesetsInput) 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 ListChangesetsInput) GoString() string { +func (s PermissionGroupParams) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListChangesetsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListChangesetsInput"} - if s.DatasetId == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetId")) - } - if s.DatasetId != nil && len(*s.DatasetId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) +func (s *PermissionGroupParams) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PermissionGroupParams"} + if s.PermissionGroupId != nil && len(*s.PermissionGroupId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PermissionGroupId", 1)) } - if s.MaxResults != nil && *s.MaxResults < 1 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + if s.DatasetPermissions != nil { + for i, v := range s.DatasetPermissions { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "DatasetPermissions", i), err.(request.ErrInvalidParams)) + } + } } if invalidParams.Len() > 0 { @@ -4065,34 +6677,29 @@ func (s *ListChangesetsInput) Validate() error { return nil } -// SetDatasetId sets the DatasetId field's value. -func (s *ListChangesetsInput) SetDatasetId(v string) *ListChangesetsInput { - s.DatasetId = &v - return s -} - -// SetMaxResults sets the MaxResults field's value. -func (s *ListChangesetsInput) SetMaxResults(v int64) *ListChangesetsInput { - s.MaxResults = &v +// SetDatasetPermissions sets the DatasetPermissions field's value. +func (s *PermissionGroupParams) SetDatasetPermissions(v []*ResourcePermission) *PermissionGroupParams { + s.DatasetPermissions = v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListChangesetsInput) SetNextToken(v string) *ListChangesetsInput { - s.NextToken = &v +// SetPermissionGroupId sets the PermissionGroupId field's value. +func (s *PermissionGroupParams) SetPermissionGroupId(v string) *PermissionGroupParams { + s.PermissionGroupId = &v return s } -// Response to ListChangesetsResponse. This returns a list of dataset changesets -// that match the query criteria. -type ListChangesetsOutput struct { +type ResetUserPasswordInput struct { _ struct{} `type:"structure"` - // List of Changesets found. - Changesets []*ChangesetSummary `locationName:"changesets" type:"list"` + // A token that ensures idempotency. This token expires in 10 minutes. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // A token indicating where a results page should begin. - NextToken *string `locationName:"nextToken" type:"string"` + // The unique identifier of the user that a temporary password is requested + // for. + // + // UserId is a required field + UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -4100,7 +6707,7 @@ type ListChangesetsOutput 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 ListChangesetsOutput) String() string { +func (s ResetUserPasswordInput) String() string { return awsutil.Prettify(s) } @@ -4109,36 +6716,54 @@ func (s ListChangesetsOutput) 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 ListChangesetsOutput) GoString() string { +func (s ResetUserPasswordInput) GoString() string { return s.String() } -// SetChangesets sets the Changesets field's value. -func (s *ListChangesetsOutput) SetChangesets(v []*ChangesetSummary) *ListChangesetsOutput { - s.Changesets = v +// Validate inspects the fields of the type to determine if they are valid. +func (s *ResetUserPasswordInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ResetUserPasswordInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.UserId == nil { + invalidParams.Add(request.NewErrParamRequired("UserId")) + } + if s.UserId != nil && len(*s.UserId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("UserId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *ResetUserPasswordInput) SetClientToken(v string) *ResetUserPasswordInput { + s.ClientToken = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListChangesetsOutput) SetNextToken(v string) *ListChangesetsOutput { - s.NextToken = &v +// SetUserId sets the UserId field's value. +func (s *ResetUserPasswordInput) SetUserId(v string) *ResetUserPasswordInput { + s.UserId = &v return s } -// Request for a list data views. -type ListDataViewsInput struct { - _ struct{} `type:"structure" nopayload:"true"` +type ResetUserPasswordOutput struct { + _ struct{} `type:"structure"` - // The unique identifier of the Dataset for which to retrieve Dataviews. + // A randomly generated temporary password for the requested user account. This + // password expires in 7 days. // - // DatasetId is a required field - DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` + // TemporaryPassword is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by ResetUserPasswordOutput's + // String and GoString methods. + TemporaryPassword *string `locationName:"temporaryPassword" min:"8" type:"string" sensitive:"true"` - // The maximum number of results per page. - MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - - // A token indicating where a results page should begin. - NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` + // The unique identifier of the user that a new password is generated for. + UserId *string `locationName:"userId" min:"1" type:"string"` } // String returns the string representation. @@ -4146,7 +6771,7 @@ type ListDataViewsInput 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 ListDataViewsInput) String() string { +func (s ResetUserPasswordOutput) String() string { return awsutil.Prettify(s) } @@ -4155,55 +6780,30 @@ func (s ListDataViewsInput) 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 ListDataViewsInput) GoString() string { +func (s ResetUserPasswordOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *ListDataViewsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListDataViewsInput"} - if s.DatasetId == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetId")) - } - if s.DatasetId != nil && len(*s.DatasetId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) - } - if s.MaxResults != nil && *s.MaxResults < 1 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetDatasetId sets the DatasetId field's value. -func (s *ListDataViewsInput) SetDatasetId(v string) *ListDataViewsInput { - s.DatasetId = &v - return s -} - -// SetMaxResults sets the MaxResults field's value. -func (s *ListDataViewsInput) SetMaxResults(v int64) *ListDataViewsInput { - s.MaxResults = &v +// SetTemporaryPassword sets the TemporaryPassword field's value. +func (s *ResetUserPasswordOutput) SetTemporaryPassword(v string) *ResetUserPasswordOutput { + s.TemporaryPassword = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListDataViewsInput) SetNextToken(v string) *ListDataViewsInput { - s.NextToken = &v +// SetUserId sets the UserId field's value. +func (s *ResetUserPasswordOutput) SetUserId(v string) *ResetUserPasswordOutput { + s.UserId = &v return s } -type ListDataViewsOutput struct { - _ struct{} `type:"structure"` +// One or more resources can't be found. +type ResourceNotFoundException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // A list of Dataviews. - DataViews []*DataViewSummary `locationName:"dataViews" type:"list"` + Message_ *string `locationName:"message" type:"string"` - // A token indicating where a results page should begin. - NextToken *string `locationName:"nextToken" type:"string"` + Reason *string `locationName:"reason" type:"string"` } // String returns the string representation. @@ -4211,7 +6811,7 @@ type ListDataViewsOutput 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 ListDataViewsOutput) String() string { +func (s ResourceNotFoundException) String() string { return awsutil.Prettify(s) } @@ -4220,31 +6820,75 @@ func (s ListDataViewsOutput) 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 ListDataViewsOutput) GoString() string { +func (s ResourceNotFoundException) GoString() string { return s.String() } -// SetDataViews sets the DataViews field's value. -func (s *ListDataViewsOutput) SetDataViews(v []*DataViewSummary) *ListDataViewsOutput { - s.DataViews = v - return s +func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error { + return &ResourceNotFoundException{ + RespMetadata: v, + } } -// SetNextToken sets the NextToken field's value. -func (s *ListDataViewsOutput) SetNextToken(v string) *ListDataViewsOutput { - s.NextToken = &v - return s +// Code returns the exception type name. +func (s *ResourceNotFoundException) Code() string { + return "ResourceNotFoundException" } -// Request for the ListDatasets operation. -type ListDatasetsInput struct { - _ struct{} `type:"structure" nopayload:"true"` +// Message returns the exception's message. +func (s *ResourceNotFoundException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} - // The maximum number of results per page. - MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ResourceNotFoundException) OrigErr() error { + return nil +} - // A token indicating where a results page should begin. - NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` +func (s *ResourceNotFoundException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ResourceNotFoundException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ResourceNotFoundException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Resource permission for a dataset. When you create a dataset, all the other +// members of the same user group inherit access to the dataset. You can only +// create a dataset if your user group has application permission for Create +// Datasets. +// +// The following is a list of valid dataset permissions that you can apply: +// +// * ViewDatasetDetails +// +// * ReadDatasetDetails +// +// * AddDatasetData +// +// * CreateSnapshot +// +// * EditDatasetMetadata +// +// * DeleteDataset +// +// For more information on the dataset permissions, see Supported Dataset Permissions +// (https://docs.aws.amazon.com/finspace/latest/userguide/managing-user-permissions.html#supported-dataset-permissions) +// in the FinSpace User Guide. +type ResourcePermission struct { + _ struct{} `type:"structure"` + + // Permission for a resource. + Permission *string `locationName:"permission" min:"1" type:"string"` } // String returns the string representation. @@ -4252,7 +6896,7 @@ type ListDatasetsInput 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 ListDatasetsInput) String() string { +func (s ResourcePermission) String() string { return awsutil.Prettify(s) } @@ -4261,15 +6905,15 @@ func (s ListDatasetsInput) 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 ListDatasetsInput) GoString() string { +func (s ResourcePermission) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListDatasetsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListDatasetsInput"} - if s.MaxResults != nil && *s.MaxResults < 1 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) +func (s *ResourcePermission) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ResourcePermission"} + if s.Permission != nil && len(*s.Permission) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Permission", 1)) } if invalidParams.Len() > 0 { @@ -4278,27 +6922,21 @@ func (s *ListDatasetsInput) Validate() error { return nil } -// SetMaxResults sets the MaxResults field's value. -func (s *ListDatasetsInput) SetMaxResults(v int64) *ListDatasetsInput { - s.MaxResults = &v - return s -} - -// SetNextToken sets the NextToken field's value. -func (s *ListDatasetsInput) SetNextToken(v string) *ListDatasetsInput { - s.NextToken = &v +// SetPermission sets the Permission field's value. +func (s *ResourcePermission) SetPermission(v string) *ResourcePermission { + s.Permission = &v return s } -// Response for the ListDatasets operation -type ListDatasetsOutput struct { +// Definition for a schema on a tabular Dataset. +type SchemaDefinition struct { _ struct{} `type:"structure"` - // List of Datasets. - Datasets []*Dataset `locationName:"datasets" type:"list"` + // List of column definitions. + Columns []*ColumnDefinition `locationName:"columns" type:"list"` - // A token indicating where a results page should begin. - NextToken *string `locationName:"nextToken" type:"string"` + // List of column names used for primary key. + PrimaryKeyColumns []*string `locationName:"primaryKeyColumns" type:"list"` } // String returns the string representation. @@ -4306,7 +6944,7 @@ type ListDatasetsOutput 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 ListDatasetsOutput) String() string { +func (s SchemaDefinition) String() string { return awsutil.Prettify(s) } @@ -4315,37 +6953,28 @@ func (s ListDatasetsOutput) 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 ListDatasetsOutput) GoString() string { +func (s SchemaDefinition) GoString() string { return s.String() } -// SetDatasets sets the Datasets field's value. -func (s *ListDatasetsOutput) SetDatasets(v []*Dataset) *ListDatasetsOutput { - s.Datasets = v +// SetColumns sets the Columns field's value. +func (s *SchemaDefinition) SetColumns(v []*ColumnDefinition) *SchemaDefinition { + s.Columns = v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListDatasetsOutput) SetNextToken(v string) *ListDatasetsOutput { - s.NextToken = &v +// SetPrimaryKeyColumns sets the PrimaryKeyColumns field's value. +func (s *SchemaDefinition) SetPrimaryKeyColumns(v []*string) *SchemaDefinition { + s.PrimaryKeyColumns = v return s } -// Permission group parameters for Dataset permissions. -// -// Here is an example of how you could specify the PermissionGroupParams: -// -// { "permissionGroupId": "0r6fCRtSTUk4XPfXQe3M0g", "datasetPermissions": [ -// {"permission": "ViewDatasetDetails"}, {"permission": "AddDatasetData"}, {"permission": -// "EditDatasetMetadata"}, {"permission": "DeleteDataset"} ] } -type PermissionGroupParams struct { +// A union of schema types. +type SchemaUnion struct { _ struct{} `type:"structure"` - // List of resource permissions. - DatasetPermissions []*ResourcePermission `locationName:"datasetPermissions" type:"list"` - - // The unique identifier of the PermissionGroup. - PermissionGroupId *string `locationName:"permissionGroupId" min:"1" type:"string"` + // The configuration for a schema on a tabular Dataset. + TabularSchemaConfig *SchemaDefinition `locationName:"tabularSchemaConfig" type:"structure"` } // String returns the string representation. @@ -4353,7 +6982,7 @@ type PermissionGroupParams 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 PermissionGroupParams) String() string { +func (s SchemaUnion) String() string { return awsutil.Prettify(s) } @@ -4362,47 +6991,18 @@ func (s PermissionGroupParams) 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 PermissionGroupParams) GoString() string { +func (s SchemaUnion) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *PermissionGroupParams) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "PermissionGroupParams"} - if s.PermissionGroupId != nil && len(*s.PermissionGroupId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("PermissionGroupId", 1)) - } - if s.DatasetPermissions != nil { - for i, v := range s.DatasetPermissions { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "DatasetPermissions", i), err.(request.ErrInvalidParams)) - } - } - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetDatasetPermissions sets the DatasetPermissions field's value. -func (s *PermissionGroupParams) SetDatasetPermissions(v []*ResourcePermission) *PermissionGroupParams { - s.DatasetPermissions = v - return s -} - -// SetPermissionGroupId sets the PermissionGroupId field's value. -func (s *PermissionGroupParams) SetPermissionGroupId(v string) *PermissionGroupParams { - s.PermissionGroupId = &v +// SetTabularSchemaConfig sets the TabularSchemaConfig field's value. +func (s *SchemaUnion) SetTabularSchemaConfig(v *SchemaDefinition) *SchemaUnion { + s.TabularSchemaConfig = v return s } -// One or more resources can't be found. -type ResourceNotFoundException struct { +// The request was denied due to request throttling. +type ThrottlingException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -4414,7 +7014,7 @@ type ResourceNotFoundException 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 ResourceNotFoundException) String() string { +func (s ThrottlingException) String() string { return awsutil.Prettify(s) } @@ -4423,23 +7023,23 @@ func (s ResourceNotFoundException) 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 ResourceNotFoundException) GoString() string { +func (s ThrottlingException) GoString() string { return s.String() } -func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error { - return &ResourceNotFoundException{ +func newErrorThrottlingException(v protocol.ResponseMetadata) error { + return &ThrottlingException{ RespMetadata: v, } } // Code returns the exception type name. -func (s *ResourceNotFoundException) Code() string { - return "ResourceNotFoundException" +func (s *ThrottlingException) Code() string { + return "ThrottlingException" } // Message returns the exception's message. -func (s *ResourceNotFoundException) Message() string { +func (s *ThrottlingException) Message() string { if s.Message_ != nil { return *s.Message_ } @@ -4447,51 +7047,89 @@ func (s *ResourceNotFoundException) Message() string { } // OrigErr always returns nil, satisfies awserr.Error interface. -func (s *ResourceNotFoundException) OrigErr() error { +func (s *ThrottlingException) OrigErr() error { return nil } -func (s *ResourceNotFoundException) Error() string { +func (s *ThrottlingException) Error() string { return fmt.Sprintf("%s: %s", s.Code(), s.Message()) } // Status code returns the HTTP status code for the request's response error. -func (s *ResourceNotFoundException) StatusCode() int { +func (s *ThrottlingException) StatusCode() int { return s.RespMetadata.StatusCode } // RequestID returns the service's response RequestID for request. -func (s *ResourceNotFoundException) RequestID() string { +func (s *ThrottlingException) RequestID() string { return s.RespMetadata.RequestID } -// Resource permission for a dataset. When you create a dataset, all the other -// members of the same user group inherit access to the dataset. You can only -// create a dataset if your user group has application permission for Create -// Datasets. -// -// The following is a list of valid dataset permissions that you can apply: -// -// * ViewDatasetDetails -// -// * ReadDatasetDetails -// -// * AddDatasetData -// -// * CreateSnapshot -// -// * EditDatasetMetadata -// -// * DeleteDataset -// -// For more information on the ataset permissions, see Supported Dataset Permissions -// (https://docs.aws.amazon.com/finspace/latest/userguide/managing-user-permissions.html#supported-dataset-permissions) -// in the FinSpace User Guide. -type ResourcePermission struct { +// Request to update an existing changeset. +type UpdateChangesetInput struct { _ struct{} `type:"structure"` - // Permission for a resource. - Permission *string `locationName:"permission" min:"1" type:"string"` + // The unique identifier for the Changeset to update. + // + // ChangesetId is a required field + ChangesetId *string `location:"uri" locationName:"changesetId" min:"1" type:"string" required:"true"` + + // A token that ensures idempotency. This token expires in 10 minutes. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // The unique identifier for the FinSpace Dataset in which the Changeset is + // created. + // + // DatasetId is a required field + DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` + + // Options that define the structure of the source file(s) including the format + // type (formatType), header row (withHeader), data separation character (separator) + // and the type of compression (compression). + // + // formatType is a required attribute and can have the following values: + // + // * PARQUET – Parquet source file format. + // + // * CSV – CSV source file format. + // + // * JSON – JSON source file format. + // + // * XML – XML source file format. + // + // Here is an example of how you could specify the formatParams: + // + // "formatParams": { "formatType": "CSV", "withHeader": "true", "separator": + // ",", "compression":"None" } + // + // Note that if you only provide formatType as CSV, the rest of the attributes + // will automatically default to CSV values as following: + // + // { "withHeader": "true", "separator": "," } + // + // For more information about supported file formats, see Supported Data Types + // and File Formats (https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html) + // in the FinSpace User Guide. + // + // FormatParams is a required field + FormatParams map[string]*string `locationName:"formatParams" type:"map" required:"true"` + + // Options that define the location of the data being ingested (s3SourcePath) + // and the source of the changeset (sourceType). + // + // Both s3SourcePath and sourceType are required attributes. + // + // Here is an example of how you could specify the sourceParams: + // + // "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", + // "sourceType": "S3" } + // + // The S3 path that you specify must allow the FinSpace role access. To do that, + // you first need to configure the IAM policy on S3 bucket. For more information, + // see Loading data from an Amazon S3 Bucket using the FinSpace API (https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets)section. + // + // SourceParams is a required field + SourceParams map[string]*string `locationName:"sourceParams" type:"map" required:"true"` } // String returns the string representation. @@ -4499,7 +7137,7 @@ type ResourcePermission 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 ResourcePermission) String() string { +func (s UpdateChangesetInput) String() string { return awsutil.Prettify(s) } @@ -4508,15 +7146,33 @@ func (s ResourcePermission) 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 ResourcePermission) GoString() string { +func (s UpdateChangesetInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ResourcePermission) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ResourcePermission"} - if s.Permission != nil && len(*s.Permission) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Permission", 1)) +func (s *UpdateChangesetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateChangesetInput"} + if s.ChangesetId == nil { + invalidParams.Add(request.NewErrParamRequired("ChangesetId")) + } + if s.ChangesetId != nil && len(*s.ChangesetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ChangesetId", 1)) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.DatasetId == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetId")) + } + if s.DatasetId != nil && len(*s.DatasetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) + } + if s.FormatParams == nil { + invalidParams.Add(request.NewErrParamRequired("FormatParams")) + } + if s.SourceParams == nil { + invalidParams.Add(request.NewErrParamRequired("SourceParams")) } if invalidParams.Len() > 0 { @@ -4525,21 +7181,46 @@ func (s *ResourcePermission) Validate() error { return nil } -// SetPermission sets the Permission field's value. -func (s *ResourcePermission) SetPermission(v string) *ResourcePermission { - s.Permission = &v +// SetChangesetId sets the ChangesetId field's value. +func (s *UpdateChangesetInput) SetChangesetId(v string) *UpdateChangesetInput { + s.ChangesetId = &v return s } -// Definition for a schema on a tabular Dataset. -type SchemaDefinition struct { - _ struct{} `type:"structure"` +// SetClientToken sets the ClientToken field's value. +func (s *UpdateChangesetInput) SetClientToken(v string) *UpdateChangesetInput { + s.ClientToken = &v + return s +} - // List of column definitions. - Columns []*ColumnDefinition `locationName:"columns" type:"list"` +// SetDatasetId sets the DatasetId field's value. +func (s *UpdateChangesetInput) SetDatasetId(v string) *UpdateChangesetInput { + s.DatasetId = &v + return s +} - // List of column names used for primary key. - PrimaryKeyColumns []*string `locationName:"primaryKeyColumns" type:"list"` +// SetFormatParams sets the FormatParams field's value. +func (s *UpdateChangesetInput) SetFormatParams(v map[string]*string) *UpdateChangesetInput { + s.FormatParams = v + return s +} + +// SetSourceParams sets the SourceParams field's value. +func (s *UpdateChangesetInput) SetSourceParams(v map[string]*string) *UpdateChangesetInput { + s.SourceParams = v + return s +} + +// The response from a update changeset operation. +type UpdateChangesetOutput struct { + _ struct{} `type:"structure"` + + // The unique identifier for the Changeset to update. + ChangesetId *string `locationName:"changesetId" min:"1" type:"string"` + + // The unique identifier for the FinSpace Dataset in which the Changeset is + // created. + DatasetId *string `locationName:"datasetId" min:"1" type:"string"` } // String returns the string representation. @@ -4547,7 +7228,7 @@ type SchemaDefinition 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 SchemaDefinition) String() string { +func (s UpdateChangesetOutput) String() string { return awsutil.Prettify(s) } @@ -4556,28 +7237,56 @@ func (s SchemaDefinition) 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 SchemaDefinition) GoString() string { +func (s UpdateChangesetOutput) GoString() string { return s.String() } -// SetColumns sets the Columns field's value. -func (s *SchemaDefinition) SetColumns(v []*ColumnDefinition) *SchemaDefinition { - s.Columns = v +// SetChangesetId sets the ChangesetId field's value. +func (s *UpdateChangesetOutput) SetChangesetId(v string) *UpdateChangesetOutput { + s.ChangesetId = &v return s } -// SetPrimaryKeyColumns sets the PrimaryKeyColumns field's value. -func (s *SchemaDefinition) SetPrimaryKeyColumns(v []*string) *SchemaDefinition { - s.PrimaryKeyColumns = v +// SetDatasetId sets the DatasetId field's value. +func (s *UpdateChangesetOutput) SetDatasetId(v string) *UpdateChangesetOutput { + s.DatasetId = &v return s } -// A union of schema types. -type SchemaUnion struct { +// The request for an UpdateDataset operation +type UpdateDatasetInput struct { _ struct{} `type:"structure"` - // The configuration for a schema on a tabular Dataset. - TabularSchemaConfig *SchemaDefinition `locationName:"tabularSchemaConfig" type:"structure"` + // The unique resource identifier for a Dataset. + Alias *string `locationName:"alias" min:"1" type:"string"` + + // A token that ensures idempotency. This token expires in 10 minutes. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // A description for the Dataset. + DatasetDescription *string `locationName:"datasetDescription" min:"1" type:"string"` + + // The unique identifier for the Dataset to update. + // + // DatasetId is a required field + DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` + + // A display title for the Dataset. + // + // DatasetTitle is a required field + DatasetTitle *string `locationName:"datasetTitle" min:"1" type:"string" required:"true"` + + // The format in which the Dataset data is structured. + // + // * TABULAR – Data is structured in a tabular format. + // + // * NON_TABULAR – Data is structured in a non-tabular format. + // + // Kind is a required field + Kind *string `locationName:"kind" type:"string" required:"true" enum:"DatasetKind"` + + // Definition for a schema on a tabular Dataset. + SchemaDefinition *SchemaUnion `locationName:"schemaDefinition" type:"structure"` } // String returns the string representation. @@ -4585,7 +7294,7 @@ type SchemaUnion 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 SchemaUnion) String() string { +func (s UpdateDatasetInput) String() string { return awsutil.Prettify(s) } @@ -4594,22 +7303,92 @@ func (s SchemaUnion) 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 SchemaUnion) GoString() string { +func (s UpdateDatasetInput) GoString() string { return s.String() } -// SetTabularSchemaConfig sets the TabularSchemaConfig field's value. -func (s *SchemaUnion) SetTabularSchemaConfig(v *SchemaDefinition) *SchemaUnion { - s.TabularSchemaConfig = v +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateDatasetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateDatasetInput"} + if s.Alias != nil && len(*s.Alias) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Alias", 1)) + } + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.DatasetDescription != nil && len(*s.DatasetDescription) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetDescription", 1)) + } + if s.DatasetId == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetId")) + } + if s.DatasetId != nil && len(*s.DatasetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) + } + if s.DatasetTitle == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetTitle")) + } + if s.DatasetTitle != nil && len(*s.DatasetTitle) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetTitle", 1)) + } + if s.Kind == nil { + invalidParams.Add(request.NewErrParamRequired("Kind")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAlias sets the Alias field's value. +func (s *UpdateDatasetInput) SetAlias(v string) *UpdateDatasetInput { + s.Alias = &v return s } -// The request was denied due to request throttling. -type ThrottlingException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +// SetClientToken sets the ClientToken field's value. +func (s *UpdateDatasetInput) SetClientToken(v string) *UpdateDatasetInput { + s.ClientToken = &v + return s +} - Message_ *string `locationName:"message" type:"string"` +// SetDatasetDescription sets the DatasetDescription field's value. +func (s *UpdateDatasetInput) SetDatasetDescription(v string) *UpdateDatasetInput { + s.DatasetDescription = &v + return s +} + +// SetDatasetId sets the DatasetId field's value. +func (s *UpdateDatasetInput) SetDatasetId(v string) *UpdateDatasetInput { + s.DatasetId = &v + return s +} + +// SetDatasetTitle sets the DatasetTitle field's value. +func (s *UpdateDatasetInput) SetDatasetTitle(v string) *UpdateDatasetInput { + s.DatasetTitle = &v + return s +} + +// SetKind sets the Kind field's value. +func (s *UpdateDatasetInput) SetKind(v string) *UpdateDatasetInput { + s.Kind = &v + return s +} + +// SetSchemaDefinition sets the SchemaDefinition field's value. +func (s *UpdateDatasetInput) SetSchemaDefinition(v *SchemaUnion) *UpdateDatasetInput { + s.SchemaDefinition = v + return s +} + +// The response from an UpdateDataset operation +type UpdateDatasetOutput struct { + _ struct{} `type:"structure"` + + // The unique identifier for updated Dataset. + DatasetId *string `locationName:"datasetId" min:"1" type:"string"` } // String returns the string representation. @@ -4617,7 +7396,7 @@ type ThrottlingException 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 ThrottlingException) String() string { +func (s UpdateDatasetOutput) String() string { return awsutil.Prettify(s) } @@ -4626,113 +7405,60 @@ func (s ThrottlingException) 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 ThrottlingException) GoString() string { +func (s UpdateDatasetOutput) GoString() string { return s.String() } -func newErrorThrottlingException(v protocol.ResponseMetadata) error { - return &ThrottlingException{ - RespMetadata: v, - } -} - -// Code returns the exception type name. -func (s *ThrottlingException) Code() string { - return "ThrottlingException" -} - -// Message returns the exception's message. -func (s *ThrottlingException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" -} - -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *ThrottlingException) OrigErr() error { - return nil -} - -func (s *ThrottlingException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) -} - -// Status code returns the HTTP status code for the request's response error. -func (s *ThrottlingException) StatusCode() int { - return s.RespMetadata.StatusCode -} - -// RequestID returns the service's response RequestID for request. -func (s *ThrottlingException) RequestID() string { - return s.RespMetadata.RequestID +// SetDatasetId sets the DatasetId field's value. +func (s *UpdateDatasetOutput) SetDatasetId(v string) *UpdateDatasetOutput { + s.DatasetId = &v + return s } -// Request to update an existing changeset. -type UpdateChangesetInput struct { +type UpdatePermissionGroupInput struct { _ struct{} `type:"structure"` - // The unique identifier for the Changeset to update. - // - // ChangesetId is a required field - ChangesetId *string `location:"uri" locationName:"changesetId" min:"1" type:"string" required:"true"` - - // A token that ensures idempotency. This token expires in 10 minutes. - ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - - // The unique identifier for the FinSpace Dataset in which the Changeset is - // created. - // - // DatasetId is a required field - DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` - - // Options that define the structure of the source file(s) including the format - // type (formatType), header row (withHeader), data separation character (separator) - // and the type of compression (compression). - // - // formatType is a required attribute and can have the following values: - // - // * PARQUET - Parquet source file format. - // - // * CSV - CSV source file format. - // - // * JSON - JSON source file format. + // The permissions that are granted to a specific group for accessing the FinSpace + // application. // - // * XML - XML source file format. + // * CreateDataset – Group members can create new datasets. // - // Here is an example of how you could specify the formatParams: + // * ManageClusters – Group members can manage Apache Spark clusters from + // FinSpace notebooks. // - // "formatParams": { "formatType": "CSV", "withHeader": "true", "separator": - // ",", "compression":"None" } + // * ManageUsersAndGroups – Group members can manage users and permission + // groups. // - // Note that if you only provide formatType as CSV, the rest of the attributes - // will automatically default to CSV values as following: + // * ManageAttributeSets – Group members can manage attribute sets. // - // { "withHeader": "true", "separator": "," } + // * ViewAuditData – Group members can view audit data. // - // For more information about supported file formats, see Supported Data Types - // and File Formats (https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html) - // in the FinSpace User Guide. + // * AccessNotebooks – Group members will have access to FinSpace notebooks. // - // FormatParams is a required field - FormatParams map[string]*string `locationName:"formatParams" type:"map" required:"true"` + // * GetTemporaryCredentials – Group members can get temporary API credentials. + ApplicationPermissions []*string `locationName:"applicationPermissions" type:"list"` - // Options that define the location of the data being ingested (s3SourcePath) - // and the source of the changeset (sourceType). - // - // Both s3SourcePath and sourceType are required attributes. - // - // Here is an example of how you could specify the sourceParams: + // A token that ensures idempotency. This token expires in 10 minutes. + ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` + + // A brief description for the permission group. // - // "sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", - // "sourceType": "S3" } + // Description is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UpdatePermissionGroupInput's + // String and GoString methods. + Description *string `locationName:"description" min:"1" type:"string" sensitive:"true"` + + // The name of the permission group. // - // The S3 path that you specify must allow the FinSpace role access. To do that, - // you first need to configure the IAM policy on S3 bucket. For more information, - // see Loading data from an Amazon S3 Bucket using the FinSpace API (https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets)section. + // Name is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UpdatePermissionGroupInput's + // String and GoString methods. + Name *string `locationName:"name" min:"1" type:"string" sensitive:"true"` + + // The unique identifier for the permission group to update. // - // SourceParams is a required field - SourceParams map[string]*string `locationName:"sourceParams" type:"map" required:"true"` + // PermissionGroupId is a required field + PermissionGroupId *string `location:"uri" locationName:"permissionGroupId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -4740,7 +7466,7 @@ type UpdateChangesetInput 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 UpdateChangesetInput) String() string { +func (s UpdatePermissionGroupInput) String() string { return awsutil.Prettify(s) } @@ -4748,34 +7474,28 @@ func (s UpdateChangesetInput) 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 UpdateChangesetInput) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *UpdateChangesetInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "UpdateChangesetInput"} - if s.ChangesetId == nil { - invalidParams.Add(request.NewErrParamRequired("ChangesetId")) - } - if s.ChangesetId != nil && len(*s.ChangesetId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ChangesetId", 1)) - } +// value will be replaced with "sensitive". +func (s UpdatePermissionGroupInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdatePermissionGroupInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdatePermissionGroupInput"} if s.ClientToken != nil && len(*s.ClientToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) } - if s.DatasetId == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetId")) + if s.Description != nil && len(*s.Description) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Description", 1)) } - if s.DatasetId != nil && len(*s.DatasetId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } - if s.FormatParams == nil { - invalidParams.Add(request.NewErrParamRequired("FormatParams")) + if s.PermissionGroupId == nil { + invalidParams.Add(request.NewErrParamRequired("PermissionGroupId")) } - if s.SourceParams == nil { - invalidParams.Add(request.NewErrParamRequired("SourceParams")) + if s.PermissionGroupId != nil && len(*s.PermissionGroupId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PermissionGroupId", 1)) } if invalidParams.Len() > 0 { @@ -4784,46 +7504,41 @@ func (s *UpdateChangesetInput) Validate() error { return nil } -// SetChangesetId sets the ChangesetId field's value. -func (s *UpdateChangesetInput) SetChangesetId(v string) *UpdateChangesetInput { - s.ChangesetId = &v +// SetApplicationPermissions sets the ApplicationPermissions field's value. +func (s *UpdatePermissionGroupInput) SetApplicationPermissions(v []*string) *UpdatePermissionGroupInput { + s.ApplicationPermissions = v return s } // SetClientToken sets the ClientToken field's value. -func (s *UpdateChangesetInput) SetClientToken(v string) *UpdateChangesetInput { +func (s *UpdatePermissionGroupInput) SetClientToken(v string) *UpdatePermissionGroupInput { s.ClientToken = &v return s } -// SetDatasetId sets the DatasetId field's value. -func (s *UpdateChangesetInput) SetDatasetId(v string) *UpdateChangesetInput { - s.DatasetId = &v +// SetDescription sets the Description field's value. +func (s *UpdatePermissionGroupInput) SetDescription(v string) *UpdatePermissionGroupInput { + s.Description = &v return s } -// SetFormatParams sets the FormatParams field's value. -func (s *UpdateChangesetInput) SetFormatParams(v map[string]*string) *UpdateChangesetInput { - s.FormatParams = v +// SetName sets the Name field's value. +func (s *UpdatePermissionGroupInput) SetName(v string) *UpdatePermissionGroupInput { + s.Name = &v return s } -// SetSourceParams sets the SourceParams field's value. -func (s *UpdateChangesetInput) SetSourceParams(v map[string]*string) *UpdateChangesetInput { - s.SourceParams = v +// SetPermissionGroupId sets the PermissionGroupId field's value. +func (s *UpdatePermissionGroupInput) SetPermissionGroupId(v string) *UpdatePermissionGroupInput { + s.PermissionGroupId = &v return s } -// The response from a update changeset operation. -type UpdateChangesetOutput struct { +type UpdatePermissionGroupOutput struct { _ struct{} `type:"structure"` - // The unique identifier for the Changeset to update. - ChangesetId *string `locationName:"changesetId" min:"1" type:"string"` - - // The unique identifier for the FinSpace Dataset in which the Changeset is - // created. - DatasetId *string `locationName:"datasetId" min:"1" type:"string"` + // The unique identifier for the updated permission group. + PermissionGroupId *string `locationName:"permissionGroupId" min:"1" type:"string"` } // String returns the string representation. @@ -4831,7 +7546,7 @@ type UpdateChangesetOutput 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 UpdateChangesetOutput) String() string { +func (s UpdatePermissionGroupOutput) String() string { return awsutil.Prettify(s) } @@ -4840,56 +7555,63 @@ func (s UpdateChangesetOutput) 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 UpdateChangesetOutput) GoString() string { +func (s UpdatePermissionGroupOutput) GoString() string { return s.String() } -// SetChangesetId sets the ChangesetId field's value. -func (s *UpdateChangesetOutput) SetChangesetId(v string) *UpdateChangesetOutput { - s.ChangesetId = &v - return s -} - -// SetDatasetId sets the DatasetId field's value. -func (s *UpdateChangesetOutput) SetDatasetId(v string) *UpdateChangesetOutput { - s.DatasetId = &v +// SetPermissionGroupId sets the PermissionGroupId field's value. +func (s *UpdatePermissionGroupOutput) SetPermissionGroupId(v string) *UpdatePermissionGroupOutput { + s.PermissionGroupId = &v return s } -// The request for an UpdateDataset operation -type UpdateDatasetInput struct { +type UpdateUserInput struct { _ struct{} `type:"structure"` - // The unique resource identifier for a Dataset. - Alias *string `locationName:"alias" min:"1" type:"string"` + // The option to indicate whether the user can use the GetProgrammaticAccessCredentials + // API to obtain credentials that can then be used to access other FinSpace + // Data API operations. + // + // * ENABLED – The user has permissions to use the APIs. + // + // * DISABLED – The user does not have permissions to use any APIs. + ApiAccess *string `locationName:"apiAccess" type:"string" enum:"ApiAccess"` + + // The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials + // API to obtain a credentials token for a specific FinSpace user. This must + // be an IAM role within your FinSpace account. + ApiAccessPrincipalArn *string `locationName:"apiAccessPrincipalArn" min:"20" type:"string"` // A token that ensures idempotency. This token expires in 10 minutes. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // A description for the Dataset. - DatasetDescription *string `locationName:"datasetDescription" min:"1" type:"string"` - - // The unique identifier for the Dataset to update. + // The first name of the user. // - // DatasetId is a required field - DatasetId *string `location:"uri" locationName:"datasetId" min:"1" type:"string" required:"true"` + // FirstName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UpdateUserInput's + // String and GoString methods. + FirstName *string `locationName:"firstName" min:"1" type:"string" sensitive:"true"` - // A display title for the Dataset. + // The last name of the user. // - // DatasetTitle is a required field - DatasetTitle *string `locationName:"datasetTitle" min:"1" type:"string" required:"true"` + // LastName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UpdateUserInput's + // String and GoString methods. + LastName *string `locationName:"lastName" min:"1" type:"string" sensitive:"true"` - // The format in which the Dataset data is structured. - // - // * TABULAR - Data is structured in a tabular format. + // The option to indicate the type of user. // - // * NON_TABULAR - Data is structured in a non-tabular format. + // * SUPER_USER– A user with permission to all the functionality and data + // in FinSpace. // - // Kind is a required field - Kind *string `locationName:"kind" type:"string" required:"true" enum:"DatasetKind"` + // * APP_USER – A user with specific permissions in FinSpace. The users + // are assigned permissions by adding them to a permissions group. + Type *string `locationName:"type" type:"string" enum:"UserType"` - // Definition for a schema on a tabular Dataset. - SchemaDefinition *SchemaUnion `locationName:"schemaDefinition" type:"structure"` + // The unique identifier for the user account to update. + // + // UserId is a required field + UserId *string `location:"uri" locationName:"userId" min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -4897,7 +7619,7 @@ type UpdateDatasetInput 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 UpdateDatasetInput) String() string { +func (s UpdateUserInput) String() string { return awsutil.Prettify(s) } @@ -4906,36 +7628,30 @@ func (s UpdateDatasetInput) 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 UpdateDatasetInput) GoString() string { +func (s UpdateUserInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *UpdateDatasetInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "UpdateDatasetInput"} - if s.Alias != nil && len(*s.Alias) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Alias", 1)) +func (s *UpdateUserInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateUserInput"} + if s.ApiAccessPrincipalArn != nil && len(*s.ApiAccessPrincipalArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("ApiAccessPrincipalArn", 20)) } if s.ClientToken != nil && len(*s.ClientToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) } - if s.DatasetDescription != nil && len(*s.DatasetDescription) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatasetDescription", 1)) - } - if s.DatasetId == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetId")) - } - if s.DatasetId != nil && len(*s.DatasetId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatasetId", 1)) + if s.FirstName != nil && len(*s.FirstName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FirstName", 1)) } - if s.DatasetTitle == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetTitle")) + if s.LastName != nil && len(*s.LastName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LastName", 1)) } - if s.DatasetTitle != nil && len(*s.DatasetTitle) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatasetTitle", 1)) + if s.UserId == nil { + invalidParams.Add(request.NewErrParamRequired("UserId")) } - if s.Kind == nil { - invalidParams.Add(request.NewErrParamRequired("Kind")) + if s.UserId != nil && len(*s.UserId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("UserId", 1)) } if invalidParams.Len() > 0 { @@ -4944,54 +7660,159 @@ func (s *UpdateDatasetInput) Validate() error { return nil } -// SetAlias sets the Alias field's value. -func (s *UpdateDatasetInput) SetAlias(v string) *UpdateDatasetInput { - s.Alias = &v +// SetApiAccess sets the ApiAccess field's value. +func (s *UpdateUserInput) SetApiAccess(v string) *UpdateUserInput { + s.ApiAccess = &v + return s +} + +// SetApiAccessPrincipalArn sets the ApiAccessPrincipalArn field's value. +func (s *UpdateUserInput) SetApiAccessPrincipalArn(v string) *UpdateUserInput { + s.ApiAccessPrincipalArn = &v return s } // SetClientToken sets the ClientToken field's value. -func (s *UpdateDatasetInput) SetClientToken(v string) *UpdateDatasetInput { +func (s *UpdateUserInput) SetClientToken(v string) *UpdateUserInput { s.ClientToken = &v return s } -// SetDatasetDescription sets the DatasetDescription field's value. -func (s *UpdateDatasetInput) SetDatasetDescription(v string) *UpdateDatasetInput { - s.DatasetDescription = &v +// SetFirstName sets the FirstName field's value. +func (s *UpdateUserInput) SetFirstName(v string) *UpdateUserInput { + s.FirstName = &v return s } -// SetDatasetId sets the DatasetId field's value. -func (s *UpdateDatasetInput) SetDatasetId(v string) *UpdateDatasetInput { - s.DatasetId = &v +// SetLastName sets the LastName field's value. +func (s *UpdateUserInput) SetLastName(v string) *UpdateUserInput { + s.LastName = &v return s } -// SetDatasetTitle sets the DatasetTitle field's value. -func (s *UpdateDatasetInput) SetDatasetTitle(v string) *UpdateDatasetInput { - s.DatasetTitle = &v +// SetType sets the Type field's value. +func (s *UpdateUserInput) SetType(v string) *UpdateUserInput { + s.Type = &v return s } -// SetKind sets the Kind field's value. -func (s *UpdateDatasetInput) SetKind(v string) *UpdateDatasetInput { - s.Kind = &v +// SetUserId sets the UserId field's value. +func (s *UpdateUserInput) SetUserId(v string) *UpdateUserInput { + s.UserId = &v return s } -// SetSchemaDefinition sets the SchemaDefinition field's value. -func (s *UpdateDatasetInput) SetSchemaDefinition(v *SchemaUnion) *UpdateDatasetInput { - s.SchemaDefinition = v +type UpdateUserOutput struct { + _ struct{} `type:"structure"` + + // The unique identifier of the updated user account. + UserId *string `locationName:"userId" 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 UpdateUserOutput) 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 UpdateUserOutput) GoString() string { + return s.String() +} + +// SetUserId sets the UserId field's value. +func (s *UpdateUserOutput) SetUserId(v string) *UpdateUserOutput { + s.UserId = &v return s } -// The response from an UpdateDataset operation -type UpdateDatasetOutput struct { +// The details of the user account. +type User struct { _ struct{} `type:"structure"` - // The unique identifier for updated Dataset. - DatasetId *string `locationName:"datasetId" min:"1" type:"string"` + // Indicates whether the user can use the GetProgrammaticAccessCredentials API + // to obtain credentials that can then be used to access other FinSpace Data + // API operations. + // + // * ENABLED – The user has permissions to use the APIs. + // + // * DISABLED – The user does not have permissions to use any APIs. + ApiAccess *string `locationName:"apiAccess" type:"string" enum:"ApiAccess"` + + // The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials + // API to obtain a credentials token for a specific FinSpace user. This must + // be an IAM role within your FinSpace account. + ApiAccessPrincipalArn *string `locationName:"apiAccessPrincipalArn" min:"20" type:"string"` + + // The timestamp at which the user account was created in FinSpace. The value + // is determined as epoch time in milliseconds. + CreateTime *int64 `locationName:"createTime" type:"long"` + + // The email address of the user. The email address serves as a uniquer identifier + // for each user and cannot be changed after it's created. + // + // EmailAddress is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by User's + // String and GoString methods. + EmailAddress *string `locationName:"emailAddress" min:"4" type:"string" sensitive:"true"` + + // The first name of the user. + // + // FirstName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by User's + // String and GoString methods. + FirstName *string `locationName:"firstName" min:"1" type:"string" sensitive:"true"` + + // Describes the last time the user account was disabled. The value is determined + // as epoch time in milliseconds. + LastDisabledTime *int64 `locationName:"lastDisabledTime" type:"long"` + + // Describes the last time the user account was enabled. The value is determined + // as epoch time in milliseconds. + LastEnabledTime *int64 `locationName:"lastEnabledTime" type:"long"` + + // Describes the last time that the user logged into their account. The value + // is determined as epoch time in milliseconds. + LastLoginTime *int64 `locationName:"lastLoginTime" type:"long"` + + // Describes the last time the user account was updated. The value is determined + // as epoch time in milliseconds. + LastModifiedTime *int64 `locationName:"lastModifiedTime" type:"long"` + + // The last name of the user. + // + // LastName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by User's + // String and GoString methods. + LastName *string `locationName:"lastName" min:"1" type:"string" sensitive:"true"` + + // The current status of the user account. + // + // * CREATING – The user account creation is in progress. + // + // * ENABLED – The user account is created and is currently active. + // + // * DISABLED – The user account is currently inactive. + Status *string `locationName:"status" type:"string" enum:"UserStatus"` + + // Indicates the type of user. + // + // * SUPER_USER – A user with permission to all the functionality and data + // in FinSpace. + // + // * APP_USER – A user with specific permissions in FinSpace. The users + // are assigned permissions by adding them to a permissions group. + Type *string `locationName:"type" type:"string" enum:"UserType"` + + // The unique identifier for the user. + UserId *string `locationName:"userId" min:"1" type:"string"` } // String returns the string representation. @@ -4999,7 +7820,7 @@ type UpdateDatasetOutput 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 UpdateDatasetOutput) String() string { +func (s User) String() string { return awsutil.Prettify(s) } @@ -5008,13 +7829,85 @@ func (s UpdateDatasetOutput) 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 UpdateDatasetOutput) GoString() string { +func (s User) GoString() string { return s.String() } -// SetDatasetId sets the DatasetId field's value. -func (s *UpdateDatasetOutput) SetDatasetId(v string) *UpdateDatasetOutput { - s.DatasetId = &v +// SetApiAccess sets the ApiAccess field's value. +func (s *User) SetApiAccess(v string) *User { + s.ApiAccess = &v + return s +} + +// SetApiAccessPrincipalArn sets the ApiAccessPrincipalArn field's value. +func (s *User) SetApiAccessPrincipalArn(v string) *User { + s.ApiAccessPrincipalArn = &v + return s +} + +// SetCreateTime sets the CreateTime field's value. +func (s *User) SetCreateTime(v int64) *User { + s.CreateTime = &v + return s +} + +// SetEmailAddress sets the EmailAddress field's value. +func (s *User) SetEmailAddress(v string) *User { + s.EmailAddress = &v + return s +} + +// SetFirstName sets the FirstName field's value. +func (s *User) SetFirstName(v string) *User { + s.FirstName = &v + return s +} + +// SetLastDisabledTime sets the LastDisabledTime field's value. +func (s *User) SetLastDisabledTime(v int64) *User { + s.LastDisabledTime = &v + return s +} + +// SetLastEnabledTime sets the LastEnabledTime field's value. +func (s *User) SetLastEnabledTime(v int64) *User { + s.LastEnabledTime = &v + return s +} + +// SetLastLoginTime sets the LastLoginTime field's value. +func (s *User) SetLastLoginTime(v int64) *User { + s.LastLoginTime = &v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *User) SetLastModifiedTime(v int64) *User { + s.LastModifiedTime = &v + return s +} + +// SetLastName sets the LastName field's value. +func (s *User) SetLastName(v string) *User { + s.LastName = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *User) SetStatus(v string) *User { + s.Status = &v + return s +} + +// SetType sets the Type field's value. +func (s *User) SetType(v string) *User { + s.Type = &v + return s +} + +// SetUserId sets the UserId field's value. +func (s *User) SetUserId(v string) *User { + s.UserId = &v return s } @@ -5024,6 +7917,8 @@ type ValidationException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"message" type:"string"` + + Reason *string `locationName:"reason" type:"string"` } // String returns the string representation. @@ -5069,7 +7964,7 @@ func (s *ValidationException) OrigErr() error { } func (s *ValidationException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) } // Status code returns the HTTP status code for the request's response error. @@ -5082,6 +7977,58 @@ func (s *ValidationException) RequestID() string { return s.RespMetadata.RequestID } +const ( + // ApiAccessEnabled is a ApiAccess enum value + ApiAccessEnabled = "ENABLED" + + // ApiAccessDisabled is a ApiAccess enum value + ApiAccessDisabled = "DISABLED" +) + +// ApiAccess_Values returns all elements of the ApiAccess enum +func ApiAccess_Values() []string { + return []string{ + ApiAccessEnabled, + ApiAccessDisabled, + } +} + +const ( + // ApplicationPermissionCreateDataset is a ApplicationPermission enum value + ApplicationPermissionCreateDataset = "CreateDataset" + + // ApplicationPermissionManageClusters is a ApplicationPermission enum value + ApplicationPermissionManageClusters = "ManageClusters" + + // ApplicationPermissionManageUsersAndGroups is a ApplicationPermission enum value + ApplicationPermissionManageUsersAndGroups = "ManageUsersAndGroups" + + // ApplicationPermissionManageAttributeSets is a ApplicationPermission enum value + ApplicationPermissionManageAttributeSets = "ManageAttributeSets" + + // ApplicationPermissionViewAuditData is a ApplicationPermission enum value + ApplicationPermissionViewAuditData = "ViewAuditData" + + // ApplicationPermissionAccessNotebooks is a ApplicationPermission enum value + ApplicationPermissionAccessNotebooks = "AccessNotebooks" + + // ApplicationPermissionGetTemporaryCredentials is a ApplicationPermission enum value + ApplicationPermissionGetTemporaryCredentials = "GetTemporaryCredentials" +) + +// ApplicationPermission_Values returns all elements of the ApplicationPermission enum +func ApplicationPermission_Values() []string { + return []string{ + ApplicationPermissionCreateDataset, + ApplicationPermissionManageClusters, + ApplicationPermissionManageUsersAndGroups, + ApplicationPermissionManageAttributeSets, + ApplicationPermissionViewAuditData, + ApplicationPermissionAccessNotebooks, + ApplicationPermissionGetTemporaryCredentials, + } +} + // Indicates how the given change will be applied to the dataset. const ( // ChangeTypeReplace is a ChangeType enum value @@ -5345,3 +8292,39 @@ func LocationType_Values() []string { LocationTypeSagemaker, } } + +const ( + // UserStatusCreating is a UserStatus enum value + UserStatusCreating = "CREATING" + + // UserStatusEnabled is a UserStatus enum value + UserStatusEnabled = "ENABLED" + + // UserStatusDisabled is a UserStatus enum value + UserStatusDisabled = "DISABLED" +) + +// UserStatus_Values returns all elements of the UserStatus enum +func UserStatus_Values() []string { + return []string{ + UserStatusCreating, + UserStatusEnabled, + UserStatusDisabled, + } +} + +const ( + // UserTypeSuperUser is a UserType enum value + UserTypeSuperUser = "SUPER_USER" + + // UserTypeAppUser is a UserType enum value + UserTypeAppUser = "APP_USER" +) + +// UserType_Values returns all elements of the UserType enum +func UserType_Values() []string { + return []string{ + UserTypeSuperUser, + UserTypeAppUser, + } +} diff --git a/service/finspacedata/finspacedataiface/interface.go b/service/finspacedata/finspacedataiface/interface.go index 51fd87bc7ca..26f23e53351 100644 --- a/service/finspacedata/finspacedataiface/interface.go +++ b/service/finspacedata/finspacedataiface/interface.go @@ -72,10 +72,30 @@ type FinSpaceDataAPI interface { CreateDatasetWithContext(aws.Context, *finspacedata.CreateDatasetInput, ...request.Option) (*finspacedata.CreateDatasetOutput, error) CreateDatasetRequest(*finspacedata.CreateDatasetInput) (*request.Request, *finspacedata.CreateDatasetOutput) + CreatePermissionGroup(*finspacedata.CreatePermissionGroupInput) (*finspacedata.CreatePermissionGroupOutput, error) + CreatePermissionGroupWithContext(aws.Context, *finspacedata.CreatePermissionGroupInput, ...request.Option) (*finspacedata.CreatePermissionGroupOutput, error) + CreatePermissionGroupRequest(*finspacedata.CreatePermissionGroupInput) (*request.Request, *finspacedata.CreatePermissionGroupOutput) + + CreateUser(*finspacedata.CreateUserInput) (*finspacedata.CreateUserOutput, error) + CreateUserWithContext(aws.Context, *finspacedata.CreateUserInput, ...request.Option) (*finspacedata.CreateUserOutput, error) + CreateUserRequest(*finspacedata.CreateUserInput) (*request.Request, *finspacedata.CreateUserOutput) + DeleteDataset(*finspacedata.DeleteDatasetInput) (*finspacedata.DeleteDatasetOutput, error) DeleteDatasetWithContext(aws.Context, *finspacedata.DeleteDatasetInput, ...request.Option) (*finspacedata.DeleteDatasetOutput, error) DeleteDatasetRequest(*finspacedata.DeleteDatasetInput) (*request.Request, *finspacedata.DeleteDatasetOutput) + DeletePermissionGroup(*finspacedata.DeletePermissionGroupInput) (*finspacedata.DeletePermissionGroupOutput, error) + DeletePermissionGroupWithContext(aws.Context, *finspacedata.DeletePermissionGroupInput, ...request.Option) (*finspacedata.DeletePermissionGroupOutput, error) + DeletePermissionGroupRequest(*finspacedata.DeletePermissionGroupInput) (*request.Request, *finspacedata.DeletePermissionGroupOutput) + + DisableUser(*finspacedata.DisableUserInput) (*finspacedata.DisableUserOutput, error) + DisableUserWithContext(aws.Context, *finspacedata.DisableUserInput, ...request.Option) (*finspacedata.DisableUserOutput, error) + DisableUserRequest(*finspacedata.DisableUserInput) (*request.Request, *finspacedata.DisableUserOutput) + + EnableUser(*finspacedata.EnableUserInput) (*finspacedata.EnableUserOutput, error) + EnableUserWithContext(aws.Context, *finspacedata.EnableUserInput, ...request.Option) (*finspacedata.EnableUserOutput, error) + EnableUserRequest(*finspacedata.EnableUserInput) (*request.Request, *finspacedata.EnableUserOutput) + GetChangeset(*finspacedata.GetChangesetInput) (*finspacedata.GetChangesetOutput, error) GetChangesetWithContext(aws.Context, *finspacedata.GetChangesetInput, ...request.Option) (*finspacedata.GetChangesetOutput, error) GetChangesetRequest(*finspacedata.GetChangesetInput) (*request.Request, *finspacedata.GetChangesetOutput) @@ -92,6 +112,10 @@ type FinSpaceDataAPI interface { GetProgrammaticAccessCredentialsWithContext(aws.Context, *finspacedata.GetProgrammaticAccessCredentialsInput, ...request.Option) (*finspacedata.GetProgrammaticAccessCredentialsOutput, error) GetProgrammaticAccessCredentialsRequest(*finspacedata.GetProgrammaticAccessCredentialsInput) (*request.Request, *finspacedata.GetProgrammaticAccessCredentialsOutput) + GetUser(*finspacedata.GetUserInput) (*finspacedata.GetUserOutput, error) + GetUserWithContext(aws.Context, *finspacedata.GetUserInput, ...request.Option) (*finspacedata.GetUserOutput, error) + GetUserRequest(*finspacedata.GetUserInput) (*request.Request, *finspacedata.GetUserOutput) + GetWorkingLocation(*finspacedata.GetWorkingLocationInput) (*finspacedata.GetWorkingLocationOutput, error) GetWorkingLocationWithContext(aws.Context, *finspacedata.GetWorkingLocationInput, ...request.Option) (*finspacedata.GetWorkingLocationOutput, error) GetWorkingLocationRequest(*finspacedata.GetWorkingLocationInput) (*request.Request, *finspacedata.GetWorkingLocationOutput) @@ -117,6 +141,24 @@ type FinSpaceDataAPI interface { ListDatasetsPages(*finspacedata.ListDatasetsInput, func(*finspacedata.ListDatasetsOutput, bool) bool) error ListDatasetsPagesWithContext(aws.Context, *finspacedata.ListDatasetsInput, func(*finspacedata.ListDatasetsOutput, bool) bool, ...request.Option) error + ListPermissionGroups(*finspacedata.ListPermissionGroupsInput) (*finspacedata.ListPermissionGroupsOutput, error) + ListPermissionGroupsWithContext(aws.Context, *finspacedata.ListPermissionGroupsInput, ...request.Option) (*finspacedata.ListPermissionGroupsOutput, error) + ListPermissionGroupsRequest(*finspacedata.ListPermissionGroupsInput) (*request.Request, *finspacedata.ListPermissionGroupsOutput) + + ListPermissionGroupsPages(*finspacedata.ListPermissionGroupsInput, func(*finspacedata.ListPermissionGroupsOutput, bool) bool) error + ListPermissionGroupsPagesWithContext(aws.Context, *finspacedata.ListPermissionGroupsInput, func(*finspacedata.ListPermissionGroupsOutput, bool) bool, ...request.Option) error + + ListUsers(*finspacedata.ListUsersInput) (*finspacedata.ListUsersOutput, error) + ListUsersWithContext(aws.Context, *finspacedata.ListUsersInput, ...request.Option) (*finspacedata.ListUsersOutput, error) + ListUsersRequest(*finspacedata.ListUsersInput) (*request.Request, *finspacedata.ListUsersOutput) + + ListUsersPages(*finspacedata.ListUsersInput, func(*finspacedata.ListUsersOutput, bool) bool) error + ListUsersPagesWithContext(aws.Context, *finspacedata.ListUsersInput, func(*finspacedata.ListUsersOutput, bool) bool, ...request.Option) error + + ResetUserPassword(*finspacedata.ResetUserPasswordInput) (*finspacedata.ResetUserPasswordOutput, error) + ResetUserPasswordWithContext(aws.Context, *finspacedata.ResetUserPasswordInput, ...request.Option) (*finspacedata.ResetUserPasswordOutput, error) + ResetUserPasswordRequest(*finspacedata.ResetUserPasswordInput) (*request.Request, *finspacedata.ResetUserPasswordOutput) + UpdateChangeset(*finspacedata.UpdateChangesetInput) (*finspacedata.UpdateChangesetOutput, error) UpdateChangesetWithContext(aws.Context, *finspacedata.UpdateChangesetInput, ...request.Option) (*finspacedata.UpdateChangesetOutput, error) UpdateChangesetRequest(*finspacedata.UpdateChangesetInput) (*request.Request, *finspacedata.UpdateChangesetOutput) @@ -124,6 +166,14 @@ type FinSpaceDataAPI interface { UpdateDataset(*finspacedata.UpdateDatasetInput) (*finspacedata.UpdateDatasetOutput, error) UpdateDatasetWithContext(aws.Context, *finspacedata.UpdateDatasetInput, ...request.Option) (*finspacedata.UpdateDatasetOutput, error) UpdateDatasetRequest(*finspacedata.UpdateDatasetInput) (*request.Request, *finspacedata.UpdateDatasetOutput) + + UpdatePermissionGroup(*finspacedata.UpdatePermissionGroupInput) (*finspacedata.UpdatePermissionGroupOutput, error) + UpdatePermissionGroupWithContext(aws.Context, *finspacedata.UpdatePermissionGroupInput, ...request.Option) (*finspacedata.UpdatePermissionGroupOutput, error) + UpdatePermissionGroupRequest(*finspacedata.UpdatePermissionGroupInput) (*request.Request, *finspacedata.UpdatePermissionGroupOutput) + + UpdateUser(*finspacedata.UpdateUserInput) (*finspacedata.UpdateUserOutput, error) + UpdateUserWithContext(aws.Context, *finspacedata.UpdateUserInput, ...request.Option) (*finspacedata.UpdateUserOutput, error) + UpdateUserRequest(*finspacedata.UpdateUserInput) (*request.Request, *finspacedata.UpdateUserOutput) } var _ FinSpaceDataAPI = (*finspacedata.FinSpaceData)(nil) diff --git a/service/fis/api.go b/service/fis/api.go index 0eb5e566bb3..c21e306c7f3 100644 --- a/service/fis/api.go +++ b/service/fis/api.go @@ -1937,6 +1937,9 @@ type CreateExperimentTemplateInput struct { // Description is a required field Description *string `locationName:"description" type:"string" required:"true"` + // The configuration for experiment logging. + LogConfiguration *CreateExperimentTemplateLogConfigurationInput_ `locationName:"logConfiguration" type:"structure"` + // The Amazon Resource Name (ARN) of an IAM role that grants the FIS service // permission to perform service actions on your behalf. // @@ -2004,6 +2007,11 @@ func (s *CreateExperimentTemplateInput) Validate() error { } } } + if s.LogConfiguration != nil { + if err := s.LogConfiguration.Validate(); err != nil { + invalidParams.AddNested("LogConfiguration", err.(request.ErrInvalidParams)) + } + } if s.StopConditions != nil { for i, v := range s.StopConditions { if v == nil { @@ -2049,6 +2057,12 @@ func (s *CreateExperimentTemplateInput) SetDescription(v string) *CreateExperime return s } +// SetLogConfiguration sets the LogConfiguration field's value. +func (s *CreateExperimentTemplateInput) SetLogConfiguration(v *CreateExperimentTemplateLogConfigurationInput_) *CreateExperimentTemplateInput { + s.LogConfiguration = v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *CreateExperimentTemplateInput) SetRoleArn(v string) *CreateExperimentTemplateInput { s.RoleArn = &v @@ -2073,6 +2087,81 @@ func (s *CreateExperimentTemplateInput) SetTargets(v map[string]*CreateExperimen return s } +// Specifies the configuration for experiment logging. +type CreateExperimentTemplateLogConfigurationInput_ struct { + _ struct{} `type:"structure"` + + // The configuration for experiment logging to Amazon CloudWatch Logs. + CloudWatchLogsConfiguration *ExperimentTemplateCloudWatchLogsLogConfigurationInput_ `locationName:"cloudWatchLogsConfiguration" type:"structure"` + + // The schema version. + // + // LogSchemaVersion is a required field + LogSchemaVersion *int64 `locationName:"logSchemaVersion" type:"integer" required:"true"` + + // The configuration for experiment logging to Amazon S3. + S3Configuration *ExperimentTemplateS3LogConfigurationInput_ `locationName:"s3Configuration" 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 CreateExperimentTemplateLogConfigurationInput_) 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 CreateExperimentTemplateLogConfigurationInput_) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateExperimentTemplateLogConfigurationInput_) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateExperimentTemplateLogConfigurationInput_"} + if s.LogSchemaVersion == nil { + invalidParams.Add(request.NewErrParamRequired("LogSchemaVersion")) + } + if s.CloudWatchLogsConfiguration != nil { + if err := s.CloudWatchLogsConfiguration.Validate(); err != nil { + invalidParams.AddNested("CloudWatchLogsConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.S3Configuration != nil { + if err := s.S3Configuration.Validate(); err != nil { + invalidParams.AddNested("S3Configuration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCloudWatchLogsConfiguration sets the CloudWatchLogsConfiguration field's value. +func (s *CreateExperimentTemplateLogConfigurationInput_) SetCloudWatchLogsConfiguration(v *ExperimentTemplateCloudWatchLogsLogConfigurationInput_) *CreateExperimentTemplateLogConfigurationInput_ { + s.CloudWatchLogsConfiguration = v + return s +} + +// SetLogSchemaVersion sets the LogSchemaVersion field's value. +func (s *CreateExperimentTemplateLogConfigurationInput_) SetLogSchemaVersion(v int64) *CreateExperimentTemplateLogConfigurationInput_ { + s.LogSchemaVersion = &v + return s +} + +// SetS3Configuration sets the S3Configuration field's value. +func (s *CreateExperimentTemplateLogConfigurationInput_) SetS3Configuration(v *ExperimentTemplateS3LogConfigurationInput_) *CreateExperimentTemplateLogConfigurationInput_ { + s.S3Configuration = v + return s +} + type CreateExperimentTemplateOutput struct { _ struct{} `type:"structure"` @@ -2390,6 +2479,9 @@ type Experiment struct { // The ID of the experiment. Id *string `locationName:"id" type:"string"` + // The configuration for experiment logging. + LogConfiguration *ExperimentLogConfiguration `locationName:"logConfiguration" type:"structure"` + // The Amazon Resource Name (ARN) of an IAM role that grants the FIS service // permission to perform service actions on your behalf. RoleArn *string `locationName:"roleArn" min:"20" type:"string"` @@ -2458,6 +2550,12 @@ func (s *Experiment) SetId(v string) *Experiment { return s } +// SetLogConfiguration sets the LogConfiguration field's value. +func (s *Experiment) SetLogConfiguration(v *ExperimentLogConfiguration) *Experiment { + s.LogConfiguration = v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *Experiment) SetRoleArn(v string) *Experiment { s.RoleArn = &v @@ -2630,6 +2728,130 @@ func (s *ExperimentActionState) SetStatus(v string) *ExperimentActionState { return s } +// Describes the configuration for experiment logging to Amazon CloudWatch Logs. +type ExperimentCloudWatchLogsLogConfiguration struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs + // log group. + LogGroupArn *string `locationName:"logGroupArn" min:"20" 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 ExperimentCloudWatchLogsLogConfiguration) 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 ExperimentCloudWatchLogsLogConfiguration) GoString() string { + return s.String() +} + +// SetLogGroupArn sets the LogGroupArn field's value. +func (s *ExperimentCloudWatchLogsLogConfiguration) SetLogGroupArn(v string) *ExperimentCloudWatchLogsLogConfiguration { + s.LogGroupArn = &v + return s +} + +// Describes the configuration for experiment logging. +type ExperimentLogConfiguration struct { + _ struct{} `type:"structure"` + + // The configuration for experiment logging to Amazon CloudWatch Logs. + CloudWatchLogsConfiguration *ExperimentCloudWatchLogsLogConfiguration `locationName:"cloudWatchLogsConfiguration" type:"structure"` + + // The schema version. + LogSchemaVersion *int64 `locationName:"logSchemaVersion" type:"integer"` + + // The configuration for experiment logging to Amazon S3. + S3Configuration *ExperimentS3LogConfiguration `locationName:"s3Configuration" 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 ExperimentLogConfiguration) 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 ExperimentLogConfiguration) GoString() string { + return s.String() +} + +// SetCloudWatchLogsConfiguration sets the CloudWatchLogsConfiguration field's value. +func (s *ExperimentLogConfiguration) SetCloudWatchLogsConfiguration(v *ExperimentCloudWatchLogsLogConfiguration) *ExperimentLogConfiguration { + s.CloudWatchLogsConfiguration = v + return s +} + +// SetLogSchemaVersion sets the LogSchemaVersion field's value. +func (s *ExperimentLogConfiguration) SetLogSchemaVersion(v int64) *ExperimentLogConfiguration { + s.LogSchemaVersion = &v + return s +} + +// SetS3Configuration sets the S3Configuration field's value. +func (s *ExperimentLogConfiguration) SetS3Configuration(v *ExperimentS3LogConfiguration) *ExperimentLogConfiguration { + s.S3Configuration = v + return s +} + +// Describes the configuration for experiment logging to Amazon S3. +type ExperimentS3LogConfiguration struct { + _ struct{} `type:"structure"` + + // The name of the destination bucket. + BucketName *string `locationName:"bucketName" min:"3" type:"string"` + + // The bucket prefix. + Prefix *string `locationName:"prefix" 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 ExperimentS3LogConfiguration) 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 ExperimentS3LogConfiguration) GoString() string { + return s.String() +} + +// SetBucketName sets the BucketName field's value. +func (s *ExperimentS3LogConfiguration) SetBucketName(v string) *ExperimentS3LogConfiguration { + s.BucketName = &v + return s +} + +// SetPrefix sets the Prefix field's value. +func (s *ExperimentS3LogConfiguration) SetPrefix(v string) *ExperimentS3LogConfiguration { + s.Prefix = &v + return s +} + // Describes the state of an experiment. type ExperimentState struct { _ struct{} `type:"structure"` @@ -2917,6 +3139,9 @@ type ExperimentTemplate struct { // The time the experiment template was last updated. LastUpdateTime *time.Time `locationName:"lastUpdateTime" type:"timestamp"` + // The configuration for experiment logging. + LogConfiguration *ExperimentTemplateLogConfiguration `locationName:"logConfiguration" type:"structure"` + // The Amazon Resource Name (ARN) of an IAM role. RoleArn *string `locationName:"roleArn" min:"20" type:"string"` @@ -2978,6 +3203,12 @@ func (s *ExperimentTemplate) SetLastUpdateTime(v time.Time) *ExperimentTemplate return s } +// SetLogConfiguration sets the LogConfiguration field's value. +func (s *ExperimentTemplate) SetLogConfiguration(v *ExperimentTemplateLogConfiguration) *ExperimentTemplate { + s.LogConfiguration = v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *ExperimentTemplate) SetRoleArn(v string) *ExperimentTemplate { s.RoleArn = &v @@ -3070,6 +3301,243 @@ func (s *ExperimentTemplateAction) SetTargets(v map[string]*string) *ExperimentT return s } +// Describes the configuration for experiment logging to Amazon CloudWatch Logs. +type ExperimentTemplateCloudWatchLogsLogConfiguration struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs + // log group. + LogGroupArn *string `locationName:"logGroupArn" min:"20" 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 ExperimentTemplateCloudWatchLogsLogConfiguration) 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 ExperimentTemplateCloudWatchLogsLogConfiguration) GoString() string { + return s.String() +} + +// SetLogGroupArn sets the LogGroupArn field's value. +func (s *ExperimentTemplateCloudWatchLogsLogConfiguration) SetLogGroupArn(v string) *ExperimentTemplateCloudWatchLogsLogConfiguration { + s.LogGroupArn = &v + return s +} + +// Specifies the configuration for experiment logging to Amazon CloudWatch Logs. +type ExperimentTemplateCloudWatchLogsLogConfigurationInput_ struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the destination Amazon CloudWatch Logs + // log group. + // + // LogGroupArn is a required field + LogGroupArn *string `locationName:"logGroupArn" min:"20" 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 ExperimentTemplateCloudWatchLogsLogConfigurationInput_) 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 ExperimentTemplateCloudWatchLogsLogConfigurationInput_) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ExperimentTemplateCloudWatchLogsLogConfigurationInput_) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ExperimentTemplateCloudWatchLogsLogConfigurationInput_"} + if s.LogGroupArn == nil { + invalidParams.Add(request.NewErrParamRequired("LogGroupArn")) + } + if s.LogGroupArn != nil && len(*s.LogGroupArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("LogGroupArn", 20)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLogGroupArn sets the LogGroupArn field's value. +func (s *ExperimentTemplateCloudWatchLogsLogConfigurationInput_) SetLogGroupArn(v string) *ExperimentTemplateCloudWatchLogsLogConfigurationInput_ { + s.LogGroupArn = &v + return s +} + +// Describes the configuration for experiment logging. +type ExperimentTemplateLogConfiguration struct { + _ struct{} `type:"structure"` + + // The configuration for experiment logging to Amazon CloudWatch Logs. + CloudWatchLogsConfiguration *ExperimentTemplateCloudWatchLogsLogConfiguration `locationName:"cloudWatchLogsConfiguration" type:"structure"` + + // The schema version. + LogSchemaVersion *int64 `locationName:"logSchemaVersion" type:"integer"` + + // The configuration for experiment logging to Amazon S3. + S3Configuration *ExperimentTemplateS3LogConfiguration `locationName:"s3Configuration" 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 ExperimentTemplateLogConfiguration) 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 ExperimentTemplateLogConfiguration) GoString() string { + return s.String() +} + +// SetCloudWatchLogsConfiguration sets the CloudWatchLogsConfiguration field's value. +func (s *ExperimentTemplateLogConfiguration) SetCloudWatchLogsConfiguration(v *ExperimentTemplateCloudWatchLogsLogConfiguration) *ExperimentTemplateLogConfiguration { + s.CloudWatchLogsConfiguration = v + return s +} + +// SetLogSchemaVersion sets the LogSchemaVersion field's value. +func (s *ExperimentTemplateLogConfiguration) SetLogSchemaVersion(v int64) *ExperimentTemplateLogConfiguration { + s.LogSchemaVersion = &v + return s +} + +// SetS3Configuration sets the S3Configuration field's value. +func (s *ExperimentTemplateLogConfiguration) SetS3Configuration(v *ExperimentTemplateS3LogConfiguration) *ExperimentTemplateLogConfiguration { + s.S3Configuration = v + return s +} + +// Describes the configuration for experiment logging to Amazon S3. +type ExperimentTemplateS3LogConfiguration struct { + _ struct{} `type:"structure"` + + // The name of the destination bucket. + BucketName *string `locationName:"bucketName" min:"3" type:"string"` + + // The bucket prefix. + Prefix *string `locationName:"prefix" 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 ExperimentTemplateS3LogConfiguration) 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 ExperimentTemplateS3LogConfiguration) GoString() string { + return s.String() +} + +// SetBucketName sets the BucketName field's value. +func (s *ExperimentTemplateS3LogConfiguration) SetBucketName(v string) *ExperimentTemplateS3LogConfiguration { + s.BucketName = &v + return s +} + +// SetPrefix sets the Prefix field's value. +func (s *ExperimentTemplateS3LogConfiguration) SetPrefix(v string) *ExperimentTemplateS3LogConfiguration { + s.Prefix = &v + return s +} + +// Specifies the configuration for experiment logging to Amazon S3. +type ExperimentTemplateS3LogConfigurationInput_ struct { + _ struct{} `type:"structure"` + + // The name of the destination bucket. + // + // BucketName is a required field + BucketName *string `locationName:"bucketName" min:"3" type:"string" required:"true"` + + // The bucket prefix. + Prefix *string `locationName:"prefix" 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 ExperimentTemplateS3LogConfigurationInput_) 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 ExperimentTemplateS3LogConfigurationInput_) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ExperimentTemplateS3LogConfigurationInput_) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ExperimentTemplateS3LogConfigurationInput_"} + if s.BucketName == nil { + invalidParams.Add(request.NewErrParamRequired("BucketName")) + } + if s.BucketName != nil && len(*s.BucketName) < 3 { + invalidParams.Add(request.NewErrParamMinLen("BucketName", 3)) + } + if s.Prefix != nil && len(*s.Prefix) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Prefix", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBucketName sets the BucketName field's value. +func (s *ExperimentTemplateS3LogConfigurationInput_) SetBucketName(v string) *ExperimentTemplateS3LogConfigurationInput_ { + s.BucketName = &v + return s +} + +// SetPrefix sets the Prefix field's value. +func (s *ExperimentTemplateS3LogConfigurationInput_) SetPrefix(v string) *ExperimentTemplateS3LogConfigurationInput_ { + s.Prefix = &v + return s +} + // Describes a stop condition for an experiment template. type ExperimentTemplateStopCondition struct { _ struct{} `type:"structure"` @@ -4841,6 +5309,9 @@ type UpdateExperimentTemplateInput struct { // Id is a required field Id *string `location:"uri" locationName:"id" type:"string" required:"true"` + // The configuration for experiment logging. + LogConfiguration *UpdateExperimentTemplateLogConfigurationInput_ `locationName:"logConfiguration" type:"structure"` + // The Amazon Resource Name (ARN) of an IAM role that grants the FIS service // permission to perform service actions on your behalf. RoleArn *string `locationName:"roleArn" min:"20" type:"string"` @@ -4882,6 +5353,11 @@ func (s *UpdateExperimentTemplateInput) Validate() error { if s.RoleArn != nil && len(*s.RoleArn) < 20 { invalidParams.Add(request.NewErrParamMinLen("RoleArn", 20)) } + if s.LogConfiguration != nil { + if err := s.LogConfiguration.Validate(); err != nil { + invalidParams.AddNested("LogConfiguration", err.(request.ErrInvalidParams)) + } + } if s.StopConditions != nil { for i, v := range s.StopConditions { if v == nil { @@ -4927,6 +5403,12 @@ func (s *UpdateExperimentTemplateInput) SetId(v string) *UpdateExperimentTemplat return s } +// SetLogConfiguration sets the LogConfiguration field's value. +func (s *UpdateExperimentTemplateInput) SetLogConfiguration(v *UpdateExperimentTemplateLogConfigurationInput_) *UpdateExperimentTemplateInput { + s.LogConfiguration = v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *UpdateExperimentTemplateInput) SetRoleArn(v string) *UpdateExperimentTemplateInput { s.RoleArn = &v @@ -4945,6 +5427,76 @@ func (s *UpdateExperimentTemplateInput) SetTargets(v map[string]*UpdateExperimen return s } +// Specifies the configuration for experiment logging. +type UpdateExperimentTemplateLogConfigurationInput_ struct { + _ struct{} `type:"structure"` + + // The configuration for experiment logging to Amazon CloudWatch Logs. + CloudWatchLogsConfiguration *ExperimentTemplateCloudWatchLogsLogConfigurationInput_ `locationName:"cloudWatchLogsConfiguration" type:"structure"` + + // The schema version. + LogSchemaVersion *int64 `locationName:"logSchemaVersion" type:"integer"` + + // The configuration for experiment logging to Amazon S3. + S3Configuration *ExperimentTemplateS3LogConfigurationInput_ `locationName:"s3Configuration" 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 UpdateExperimentTemplateLogConfigurationInput_) 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 UpdateExperimentTemplateLogConfigurationInput_) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateExperimentTemplateLogConfigurationInput_) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateExperimentTemplateLogConfigurationInput_"} + if s.CloudWatchLogsConfiguration != nil { + if err := s.CloudWatchLogsConfiguration.Validate(); err != nil { + invalidParams.AddNested("CloudWatchLogsConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.S3Configuration != nil { + if err := s.S3Configuration.Validate(); err != nil { + invalidParams.AddNested("S3Configuration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCloudWatchLogsConfiguration sets the CloudWatchLogsConfiguration field's value. +func (s *UpdateExperimentTemplateLogConfigurationInput_) SetCloudWatchLogsConfiguration(v *ExperimentTemplateCloudWatchLogsLogConfigurationInput_) *UpdateExperimentTemplateLogConfigurationInput_ { + s.CloudWatchLogsConfiguration = v + return s +} + +// SetLogSchemaVersion sets the LogSchemaVersion field's value. +func (s *UpdateExperimentTemplateLogConfigurationInput_) SetLogSchemaVersion(v int64) *UpdateExperimentTemplateLogConfigurationInput_ { + s.LogSchemaVersion = &v + return s +} + +// SetS3Configuration sets the S3Configuration field's value. +func (s *UpdateExperimentTemplateLogConfigurationInput_) SetS3Configuration(v *ExperimentTemplateS3LogConfigurationInput_) *UpdateExperimentTemplateLogConfigurationInput_ { + s.S3Configuration = v + return s +} + type UpdateExperimentTemplateOutput struct { _ struct{} `type:"structure"` diff --git a/service/fsx/api.go b/service/fsx/api.go index d55408254e1..428c8669cff 100644 --- a/service/fsx/api.go +++ b/service/fsx/api.go @@ -465,8 +465,7 @@ func (c *FSx) CreateBackupRequest(input *CreateBackupInput) (req *request.Reques // No Amazon FSx file systems were found based upon supplied parameters. // // * VolumeNotFound -// No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied -// parameters. +// No Amazon FSx volumes were found based upon the supplied parameters. // // * BackupInProgress // Another backup is already under way. Wait for completion before initiating @@ -929,8 +928,8 @@ func (c *FSx) CreateFileSystemFromBackupRequest(input *CreateFileSystemFromBacku // or Amazon FSx for OpenZFS file system from an existing Amazon FSx backup. // // If a file system with the specified client request token exists and the parameters -// match, this operation returns the description of the file system. If a client -// request token with the specified by the file system exists and the parameters +// match, this operation returns the description of the file system. If a file +// system with the specified client request token exists but the parameters // don't match, this call returns IncompatibleParameterError. If a file system // with the specified client request token doesn't exist, this operation does // the following: @@ -1062,9 +1061,9 @@ func (c *FSx) CreateSnapshotRequest(input *CreateSnapshotInput) (req *request.Re // CreateSnapshot API operation for Amazon FSx. // -// Creates a snapshot of an existing Amazon FSx for OpenZFS file system. With -// snapshots, you can easily undo file changes and compare file versions by -// restoring the volume to a previous version. +// Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, +// you can easily undo file changes and compare file versions by restoring the +// volume to a previous version. // // If a snapshot with the specified client request token exists, and the parameters // match, this operation returns the description of the existing snapshot. If @@ -1102,8 +1101,7 @@ func (c *FSx) CreateSnapshotRequest(input *CreateSnapshotInput) (req *request.Re // A generic error indicating a failure with a client request. // // * VolumeNotFound -// No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied -// parameters. +// No Amazon FSx volumes were found based upon the supplied parameters. // // * ServiceLimitExceeded // An error indicating that a particular service limit was exceeded. You can @@ -1811,9 +1809,9 @@ func (c *FSx) DeleteSnapshotRequest(input *DeleteSnapshotInput) (req *request.Re // DeleteSnapshot API operation for Amazon FSx. // -// Deletes the Amazon FSx snapshot. After deletion, the snapshot no longer exists, -// and its data is gone. Deleting a snapshot doesn't affect snapshots stored -// in a file system backup. +// Deletes an Amazon FSx for OpenZFS snapshot. After deletion, the snapshot +// no longer exists, and its data is gone. Deleting a snapshot doesn't affect +// snapshots stored in a file system backup. // // The DeleteSnapshot operation returns instantly. The snapshot appears with // the lifecycle status of DELETING until the deletion is complete. @@ -2015,8 +2013,7 @@ func (c *FSx) DeleteVolumeRequest(input *DeleteVolumeInput) (req *request.Reques // A generic error indicating a server-side failure. // // * VolumeNotFound -// No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied -// parameters. +// No Amazon FSx volumes were found based upon the supplied parameters. // // See also, https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DeleteVolume func (c *FSx) DeleteVolume(input *DeleteVolumeInput) (*DeleteVolumeOutput, error) { @@ -2130,8 +2127,7 @@ func (c *FSx) DescribeBackupsRequest(input *DescribeBackupsInput) (req *request. // No Amazon FSx file systems were found based upon supplied parameters. // // * VolumeNotFound -// No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied -// parameters. +// No Amazon FSx volumes were found based upon the supplied parameters. // // * BackupNotFound // No Amazon FSx backups were found based upon the supplied parameters. @@ -2901,10 +2897,10 @@ func (c *FSx) DescribeSnapshotsRequest(input *DescribeSnapshotsInput) (req *requ // DescribeSnapshots API operation for Amazon FSx. // -// Returns the description of specific Amazon FSx snapshots, if a SnapshotIds -// value is provided. Otherwise, this operation returns all snapshots owned -// by your Amazon Web Services account in the Amazon Web Services Region of -// the endpoint that you're calling. +// Returns the description of specific Amazon FSx for OpenZFS snapshots, if +// a SnapshotIds value is provided. Otherwise, this operation returns all snapshots +// owned by your Amazon Web Services account in the Amazon Web Services Region +// of the endpoint that you're calling. // // When retrieving all snapshots, you can optionally specify the MaxResults // parameter to limit the number of snapshots in a response. If more backups @@ -3229,8 +3225,7 @@ func (c *FSx) DescribeVolumesRequest(input *DescribeVolumesInput) (req *request. // A generic error indicating a server-side failure. // // * VolumeNotFound -// No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied -// parameters. +// No Amazon FSx volumes were found based upon the supplied parameters. // // See also, https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/DescribeVolumes func (c *FSx) DescribeVolumes(input *DescribeVolumesInput) (*DescribeVolumesOutput, error) { @@ -3727,8 +3722,7 @@ func (c *FSx) RestoreVolumeFromSnapshotRequest(input *RestoreVolumeFromSnapshotI // A generic error indicating a server-side failure. // // * VolumeNotFound -// No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied -// parameters. +// No Amazon FSx volumes were found based upon the supplied parameters. // // See also, https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/RestoreVolumeFromSnapshot func (c *FSx) RestoreVolumeFromSnapshot(input *RestoreVolumeFromSnapshotInput) (*RestoreVolumeFromSnapshotOutput, error) { @@ -4240,7 +4234,7 @@ func (c *FSx) UpdateSnapshotRequest(input *UpdateSnapshotInput) (req *request.Re // UpdateSnapshot API operation for Amazon FSx. // -// Updates the name of a snapshot. +// Updates the name of an Amazon FSx for OpenZFS snapshot. // // 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 @@ -4444,8 +4438,7 @@ func (c *FSx) UpdateVolumeRequest(input *UpdateVolumeInput) (req *request.Reques // A volume configuration is required for this operation. // // * VolumeNotFound -// No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied -// parameters. +// No Amazon FSx volumes were found based upon the supplied parameters. // // See also, https://docs.aws.amazon.com/goto/WebAPI/fsx-2018-03-01/UpdateVolume func (c *FSx) UpdateVolume(input *UpdateVolumeInput) (*UpdateVolumeOutput, error) { @@ -7597,7 +7590,8 @@ func (s *CreateFileSystemOntapConfiguration) SetWeeklyMaintenanceStartTime(v str return s } -// The OpenZFS configuration properties for the file system that you are creating. +// The Amazon FSx for OpenZFS configuration properties for the file system that +// you are creating. type CreateFileSystemOpenZFSConfiguration struct { _ struct{} `type:"structure"` @@ -8255,7 +8249,8 @@ func (s *CreateOpenZFSOriginSnapshotConfiguration) SetSnapshotARN(v string) *Cre return s } -// Specifies the configuration of the OpenZFS volume that you are creating. +// Specifies the configuration of the Amazon FSx for OpenZFS volume that you +// are creating. type CreateOpenZFSVolumeConfiguration struct { _ struct{} `type:"structure"` @@ -8267,15 +8262,18 @@ type CreateOpenZFSVolumeConfiguration struct { // the snapshot, no tags are copied from the volume, regardless of this value. CopyTagsToSnapshots *bool `type:"boolean"` - // Specifies the method used to compress the data on the volume. Unless the - // compression type is specified, volumes inherit the DataCompressionType value - // of their parent volume. + // Specifies the method used to compress the data on the volume. The compression + // type is NONE by default. // - // * NONE - Doesn't compress the data on the volume. + // * NONE - Doesn't compress the data on the volume. NONE is the default. // // * ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) - // compression algorithm. This algorithm reduces the amount of space used - // on your volume and has very little impact on compute resources. + // compression algorithm. Compared to LZ4, Z-Standard provides a better compression + // ratio to minimize on-disk storage utilization. + // + // * LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. + // Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher + // write throughput speeds. DataCompressionType *string `type:"string" enum:"OpenZFSDataCompressionType"` // The configuration object for mounting a Network File System (NFS) file system. @@ -8293,13 +8291,23 @@ type CreateOpenZFSVolumeConfiguration struct { // A Boolean value indicating whether the volume is read-only. ReadOnly *bool `type:"boolean"` + // Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid + // values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 + // KiB. Most workloads should use the default record size. Database workflows + // can benefit from a smaller record size, while streaming workflows can benefit + // from a larger record size. For additional guidance on when to set a custom + // record size, see Tips for maximizing performance (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs) + // in the Amazon FSx for OpenZFS User Guide. + RecordSizeKiB *int64 `min:"4" type:"integer"` + // The maximum amount of storage in gibibytes (GiB) that the volume can use - // from its parent. You can specify a quota larger than the storage on the parent - // volume. + // from its parent. You can't specify a quota larger than the storage on the + // parent volume. To not specify a storage capacity quota, set this to -1. StorageCapacityQuotaGiB *int64 `type:"integer"` // The amount of storage in gibibytes (GiB) to reserve from the parent volume. - // You can't reserve more storage than the parent volume has reserved. + // You can't reserve more storage than the parent volume has reserved. To not + // specify a storage capacity reservation, set this to -1. StorageCapacityReservationGiB *int64 `type:"integer"` // An object specifying how much storage users or groups can use on the volume. @@ -8333,6 +8341,15 @@ func (s *CreateOpenZFSVolumeConfiguration) Validate() error { if s.ParentVolumeId != nil && len(*s.ParentVolumeId) < 23 { invalidParams.Add(request.NewErrParamMinLen("ParentVolumeId", 23)) } + if s.RecordSizeKiB != nil && *s.RecordSizeKiB < 4 { + invalidParams.Add(request.NewErrParamMinValue("RecordSizeKiB", 4)) + } + if s.StorageCapacityQuotaGiB != nil && *s.StorageCapacityQuotaGiB < -1 { + invalidParams.Add(request.NewErrParamMinValue("StorageCapacityQuotaGiB", -1)) + } + if s.StorageCapacityReservationGiB != nil && *s.StorageCapacityReservationGiB < -1 { + invalidParams.Add(request.NewErrParamMinValue("StorageCapacityReservationGiB", -1)) + } if s.NfsExports != nil { for i, v := range s.NfsExports { if v == nil { @@ -8401,6 +8418,12 @@ func (s *CreateOpenZFSVolumeConfiguration) SetReadOnly(v bool) *CreateOpenZFSVol return s } +// SetRecordSizeKiB sets the RecordSizeKiB field's value. +func (s *CreateOpenZFSVolumeConfiguration) SetRecordSizeKiB(v int64) *CreateOpenZFSVolumeConfiguration { + s.RecordSizeKiB = &v + return s +} + // SetStorageCapacityQuotaGiB sets the StorageCapacityQuotaGiB field's value. func (s *CreateOpenZFSVolumeConfiguration) SetStorageCapacityQuotaGiB(v int64) *CreateOpenZFSVolumeConfiguration { s.StorageCapacityQuotaGiB = &v @@ -10544,18 +10567,24 @@ func (s *DeleteFileSystemLustreResponse) SetFinalBackupTags(v []*Tag) *DeleteFil return s } -// The configuration object for the OpenZFS file system used in the DeleteFileSystem -// operation. +// The configuration object for the Amazon FSx for OpenZFS file system used +// in the DeleteFileSystem operation. type DeleteFileSystemOpenZFSConfiguration struct { _ struct{} `type:"structure"` - // A list of Tag values, with a maximum of 50 elements. + // A list of tags to apply to the file system's final backup. FinalBackupTags []*Tag `min:"1" type:"list"` + // To delete a file system if there are child volumes present below the root + // volume, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS. If your file system + // has child volumes and you don't use this option, the delete request will + // fail. + Options []*string `type:"list"` + // By default, Amazon FSx for OpenZFS takes a final backup on your behalf when // the DeleteFileSystem operation is invoked. Doing this helps protect you from // data loss, and we highly recommend taking the final backup. If you want to - // skip this backup, use this value to do so. + // skip taking a final backup, set this value to true. SkipFinalBackup *bool `type:"boolean"` } @@ -10606,6 +10635,12 @@ func (s *DeleteFileSystemOpenZFSConfiguration) SetFinalBackupTags(v []*Tag) *Del return s } +// SetOptions sets the Options field's value. +func (s *DeleteFileSystemOpenZFSConfiguration) SetOptions(v []*string) *DeleteFileSystemOpenZFSConfiguration { + s.Options = v + return s +} + // SetSkipFinalBackup sets the SkipFinalBackup field's value. func (s *DeleteFileSystemOpenZFSConfiguration) SetSkipFinalBackup(v bool) *DeleteFileSystemOpenZFSConfiguration { s.SkipFinalBackup = &v @@ -14660,7 +14695,7 @@ type OpenZFSClientConfiguration struct { _ struct{} `type:"structure"` // A value that specifies who can mount the file system. You can provide a wildcard - // character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24. + // character (*), an IP address (0.0.0.0), or a CIDR address (192.0.2.0/24). // By default, Amazon FSx uses the wildcard character when specifying the client. // // Clients is a required field @@ -14671,9 +14706,9 @@ type OpenZFSClientConfiguration struct { // page (https://linux.die.net/man/5/exports). When choosing your options, consider // the following: // - // * crossmount is used by default. If you don't specify crossmount when - // changing the client configuration, you won't be able to see or access - // snapshots in your file system's snapshot directory. + // * crossmnt is used by default. If you don't specify crossmnt when changing + // the client configuration, you won't be able to see or access snapshots + // in your file system's snapshot directory. // // * sync is used by default. If you instead specify async, the system acknowledges // writes before writing to disk. If the system crashes before the writes @@ -14740,22 +14775,25 @@ type OpenZFSCreateRootVolumeConfiguration struct { _ struct{} `type:"structure"` // A Boolean value indicating whether tags for the volume should be copied to - // snapshots. This value defaults to false. If it's set to true, all tags for - // the volume are copied to snapshots where the user doesn't specify tags. If - // this value is true and you specify one or more tags, only the specified tags - // are copied to snapshots. If you specify one or more tags when creating the - // snapshot, no tags are copied from the volume, regardless of this value. + // snapshots of the volume. This value defaults to false. If it's set to true, + // all tags for the volume are copied to snapshots where the user doesn't specify + // tags. If this value is true and you specify one or more tags, only the specified + // tags are copied to snapshots. If you specify one or more tags when creating + // the snapshot, no tags are copied from the volume, regardless of this value. CopyTagsToSnapshots *bool `type:"boolean"` - // Specifies the method used to compress the data on the volume. Unless the - // compression type is specified, volumes inherit the DataCompressionType value - // of their parent volume. + // Specifies the method used to compress the data on the volume. The compression + // type is NONE by default. + // + // * NONE - Doesn't compress the data on the volume. NONE is the default. // - // * NONE - Doesn't compress the data on the volume. + // * ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) + // compression algorithm. Compared to LZ4, Z-Standard provides a better compression + // ratio to minimize on-disk storage utilization. // - // * ZSTD - Compresses the data in the volume using the ZStandard (ZSTD) - // compression algorithm. This algorithm reduces the amount of space used - // on your volume and has very little impact on compute resources. + // * LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. + // Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher + // write throughput speeds. DataCompressionType *string `type:"string" enum:"OpenZFSDataCompressionType"` // The configuration object for mounting a file system. @@ -14766,6 +14804,15 @@ type OpenZFSCreateRootVolumeConfiguration struct { // and no longer want changes to occur. ReadOnly *bool `type:"boolean"` + // Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). + // Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default + // is 128 KiB. Most workloads should use the default record size. Database workflows + // can benefit from a smaller record size, while streaming workflows can benefit + // from a larger record size. For additional guidance on setting a custom record + // size, see Tips for maximizing performance (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs) + // in the Amazon FSx for OpenZFS User Guide. + RecordSizeKiB *int64 `min:"4" type:"integer"` + // An object specifying how much storage users or groups can use on the volume. UserAndGroupQuotas []*OpenZFSUserOrGroupQuota `type:"list"` } @@ -14791,6 +14838,9 @@ func (s OpenZFSCreateRootVolumeConfiguration) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *OpenZFSCreateRootVolumeConfiguration) Validate() error { invalidParams := request.ErrInvalidParams{Context: "OpenZFSCreateRootVolumeConfiguration"} + if s.RecordSizeKiB != nil && *s.RecordSizeKiB < 4 { + invalidParams.Add(request.NewErrParamMinValue("RecordSizeKiB", 4)) + } if s.NfsExports != nil { for i, v := range s.NfsExports { if v == nil { @@ -14842,6 +14892,12 @@ func (s *OpenZFSCreateRootVolumeConfiguration) SetReadOnly(v bool) *OpenZFSCreat return s } +// SetRecordSizeKiB sets the RecordSizeKiB field's value. +func (s *OpenZFSCreateRootVolumeConfiguration) SetRecordSizeKiB(v int64) *OpenZFSCreateRootVolumeConfiguration { + s.RecordSizeKiB = &v + return s +} + // SetUserAndGroupQuotas sets the UserAndGroupQuotas field's value. func (s *OpenZFSCreateRootVolumeConfiguration) SetUserAndGroupQuotas(v []*OpenZFSUserOrGroupQuota) *OpenZFSCreateRootVolumeConfiguration { s.UserAndGroupQuotas = v @@ -14895,7 +14951,7 @@ type OpenZFSFileSystemConfiguration struct { RootVolumeId *string `min:"23" type:"string"` // The throughput of an Amazon FSx file system, measured in megabytes per second - // (MBps), in 2 to the nth increments, between 2^3 (8) and 2^11 (2048). + // (MBps). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. ThroughputCapacity *int64 `min:"8" type:"integer"` // A recurring weekly time, in the format D:HH:MM. @@ -15182,15 +15238,18 @@ type OpenZFSVolumeConfiguration struct { // snapshot, no tags are copied from the volume, regardless of this value. CopyTagsToSnapshots *bool `type:"boolean"` - // The method used to compress the data on the volume. Unless a compression - // type is specified, volumes inherit the DataCompressionType value of their - // parent volume. + // Specifies the method used to compress the data on the volume. The compression + // type is NONE by default. // - // * NONE - Doesn't compress the data on the volume. + // * NONE - Doesn't compress the data on the volume. NONE is the default. // // * ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) - // compression algorithm. This algorithm reduces the amount of space used - // on your volume and has very little impact on compute resources. + // compression algorithm. Compared to LZ4, Z-Standard provides a better compression + // ratio to minimize on-disk storage utilization. + // + // * LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. + // Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher + // write throughput speeds. DataCompressionType *string `type:"string" enum:"OpenZFSDataCompressionType"` // The configuration object for mounting a Network File System (NFS) file system. @@ -15206,6 +15265,12 @@ type OpenZFSVolumeConfiguration struct { // A Boolean value indicating whether the volume is read-only. ReadOnly *bool `type:"boolean"` + // The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are + // 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most + // workloads should use the default record size. For guidance on when to set + // a custom record size, see the Amazon FSx for OpenZFS User Guide. + RecordSizeKiB *int64 `min:"4" type:"integer"` + // The maximum amount of storage in gibibtyes (GiB) that the volume can use // from its parent. You can specify a quota larger than the storage on the parent // volume. @@ -15276,6 +15341,12 @@ func (s *OpenZFSVolumeConfiguration) SetReadOnly(v bool) *OpenZFSVolumeConfigura return s } +// SetRecordSizeKiB sets the RecordSizeKiB field's value. +func (s *OpenZFSVolumeConfiguration) SetRecordSizeKiB(v int64) *OpenZFSVolumeConfiguration { + s.RecordSizeKiB = &v + return s +} + // SetStorageCapacityQuotaGiB sets the StorageCapacityQuotaGiB field's value. func (s *OpenZFSVolumeConfiguration) SetStorageCapacityQuotaGiB(v int64) *OpenZFSVolumeConfiguration { s.StorageCapacityQuotaGiB = &v @@ -16124,6 +16195,9 @@ type Snapshot struct { // * AVAILABLE - The snapshot is fully available. Lifecycle *string `type:"string" enum:"SnapshotLifecycle"` + // Describes why a resource lifecycle state changed. + LifecycleTransitionReason *LifecycleTransitionReason `type:"structure"` + // The name of the snapshot. Name *string `min:"1" type:"string"` @@ -16180,6 +16254,12 @@ func (s *Snapshot) SetLifecycle(v string) *Snapshot { return s } +// SetLifecycleTransitionReason sets the LifecycleTransitionReason field's value. +func (s *Snapshot) SetLifecycleTransitionReason(v *LifecycleTransitionReason) *Snapshot { + s.LifecycleTransitionReason = v + return s +} + // SetName sets the Name field's value. func (s *Snapshot) SetName(v string) *Snapshot { s.Name = &v @@ -17801,7 +17881,7 @@ type UpdateFileSystemOpenZFSConfiguration struct { DiskIopsConfiguration *DiskIopsConfiguration `type:"structure"` // The throughput of an Amazon FSx file system, measured in megabytes per second - // (MBps), in 2 to the nth increments, between 2^3 (8) and 2^12 (4096). + // (MBps). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. ThroughputCapacity *int64 `min:"8" type:"integer"` // A recurring weekly time, in the format D:HH:MM. @@ -18145,15 +18225,18 @@ func (s *UpdateOntapVolumeConfiguration) SetTieringPolicy(v *TieringPolicy) *Upd type UpdateOpenZFSVolumeConfiguration struct { _ struct{} `type:"structure"` - // Specifies the method used to compress the data on the volume. Unless the - // compression type is specified, volumes inherit the DataCompressionType value - // of their parent volume. + // Specifies the method used to compress the data on the volume. The compression + // type is NONE by default. // - // * NONE - Doesn't compress the data on the volume. + // * NONE - Doesn't compress the data on the volume. NONE is the default. // // * ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) - // compression algorithm. This algorithm reduces the amount of space used - // on your volume and has very little impact on compute resources. + // compression algorithm. Compared to LZ4, Z-Standard provides a better compression + // ratio to minimize on-disk storage utilization. + // + // * LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. + // Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher + // write throughput speeds. DataCompressionType *string `type:"string" enum:"OpenZFSDataCompressionType"` // The configuration object for mounting a Network File System (NFS) file system. @@ -18162,13 +18245,24 @@ type UpdateOpenZFSVolumeConfiguration struct { // A Boolean value indicating whether the volume is read-only. ReadOnly *bool `type:"boolean"` + // Specifies the record size of an OpenZFS volume, in kibibytes (KiB). Valid + // values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 + // KiB. Most workloads should use the default record size. Database workflows + // can benefit from a smaller record size, while streaming workflows can benefit + // from a larger record size. For additional guidance on when to set a custom + // record size, see Tips for maximizing performance (https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs) + // in the Amazon FSx for OpenZFS User Guide. + RecordSizeKiB *int64 `min:"4" type:"integer"` + // The maximum amount of storage in gibibytes (GiB) that the volume can use // from its parent. You can specify a quota larger than the storage on the parent - // volume. + // volume. You can specify a value of -1 to unset a volume's storage capacity + // quota. StorageCapacityQuotaGiB *int64 `type:"integer"` // The amount of storage in gibibytes (GiB) to reserve from the parent volume. - // You can't reserve more storage than the parent volume has reserved. + // You can't reserve more storage than the parent volume has reserved. You can + // specify a value of -1 to unset a volume's storage capacity reservation. StorageCapacityReservationGiB *int64 `type:"integer"` // An object specifying how much storage users or groups can use on the volume. @@ -18196,6 +18290,15 @@ func (s UpdateOpenZFSVolumeConfiguration) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *UpdateOpenZFSVolumeConfiguration) Validate() error { invalidParams := request.ErrInvalidParams{Context: "UpdateOpenZFSVolumeConfiguration"} + if s.RecordSizeKiB != nil && *s.RecordSizeKiB < 4 { + invalidParams.Add(request.NewErrParamMinValue("RecordSizeKiB", 4)) + } + if s.StorageCapacityQuotaGiB != nil && *s.StorageCapacityQuotaGiB < -1 { + invalidParams.Add(request.NewErrParamMinValue("StorageCapacityQuotaGiB", -1)) + } + if s.StorageCapacityReservationGiB != nil && *s.StorageCapacityReservationGiB < -1 { + invalidParams.Add(request.NewErrParamMinValue("StorageCapacityReservationGiB", -1)) + } if s.NfsExports != nil { for i, v := range s.NfsExports { if v == nil { @@ -18241,6 +18344,12 @@ func (s *UpdateOpenZFSVolumeConfiguration) SetReadOnly(v bool) *UpdateOpenZFSVol return s } +// SetRecordSizeKiB sets the RecordSizeKiB field's value. +func (s *UpdateOpenZFSVolumeConfiguration) SetRecordSizeKiB(v int64) *UpdateOpenZFSVolumeConfiguration { + s.RecordSizeKiB = &v + return s +} + // SetStorageCapacityQuotaGiB sets the StorageCapacityQuotaGiB field's value. func (s *UpdateOpenZFSVolumeConfiguration) SetStorageCapacityQuotaGiB(v int64) *UpdateOpenZFSVolumeConfiguration { s.StorageCapacityQuotaGiB = &v @@ -18879,8 +18988,7 @@ func (s *VolumeFilter) SetValues(v []*string) *VolumeFilter { return s } -// No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied -// parameters. +// No Amazon FSx volumes were found based upon the supplied parameters. type VolumeNotFound struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -19700,6 +19808,18 @@ func DataRepositoryTaskType_Values() []string { } } +const ( + // DeleteFileSystemOpenZFSOptionDeleteChildVolumesAndSnapshots is a DeleteFileSystemOpenZFSOption enum value + DeleteFileSystemOpenZFSOptionDeleteChildVolumesAndSnapshots = "DELETE_CHILD_VOLUMES_AND_SNAPSHOTS" +) + +// DeleteFileSystemOpenZFSOption_Values returns all elements of the DeleteFileSystemOpenZFSOption enum +func DeleteFileSystemOpenZFSOption_Values() []string { + return []string{ + DeleteFileSystemOpenZFSOptionDeleteChildVolumesAndSnapshots, + } +} + const ( // DeleteOpenZFSVolumeOptionDeleteChildVolumesAndSnapshots is a DeleteOpenZFSVolumeOption enum value DeleteOpenZFSVolumeOptionDeleteChildVolumesAndSnapshots = "DELETE_CHILD_VOLUMES_AND_SNAPSHOTS" @@ -19990,6 +20110,9 @@ const ( // OpenZFSDataCompressionTypeZstd is a OpenZFSDataCompressionType enum value OpenZFSDataCompressionTypeZstd = "ZSTD" + + // OpenZFSDataCompressionTypeLz4 is a OpenZFSDataCompressionType enum value + OpenZFSDataCompressionTypeLz4 = "LZ4" ) // OpenZFSDataCompressionType_Values returns all elements of the OpenZFSDataCompressionType enum @@ -19997,6 +20120,7 @@ func OpenZFSDataCompressionType_Values() []string { return []string{ OpenZFSDataCompressionTypeNone, OpenZFSDataCompressionTypeZstd, + OpenZFSDataCompressionTypeLz4, } } diff --git a/service/fsx/errors.go b/service/fsx/errors.go index 4b3f68886af..d46220ecf09 100644 --- a/service/fsx/errors.go +++ b/service/fsx/errors.go @@ -214,8 +214,7 @@ const ( // ErrCodeVolumeNotFound for service response error code // "VolumeNotFound". // - // No Amazon FSx for NetApp ONTAP volumes were found based upon the supplied - // parameters. + // No Amazon FSx volumes were found based upon the supplied parameters. ErrCodeVolumeNotFound = "VolumeNotFound" ) diff --git a/service/route53recoverycluster/api.go b/service/route53recoverycluster/api.go index 4ed8bdaa10d..c1db7624d29 100644 --- a/service/route53recoverycluster/api.go +++ b/service/route53recoverycluster/api.go @@ -58,16 +58,28 @@ func (c *Route53RecoveryCluster) GetRoutingControlStateRequest(input *GetRouting // // Get the state for a routing control. A routing control is a simple on/off // switch that you can use to route traffic to cells. When the state is On, -// traffic flows to a cell. When it's off, traffic does not flow. +// traffic flows to a cell. When it's Off, traffic does not flow. // -// Before you can create a routing control, you first must create a cluster -// to host the control. For more information, see CreateCluster (https://docs.aws.amazon.com/recovery-cluster/latest/api/cluster.html). -// Access one of the endpoints for the cluster to get or update the routing +// Before you can create a routing control, you must first create a cluster +// to host the control in a control panel. For more information, see Create +// routing control structures (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.create.html) +// in the Amazon Route 53 Application Recovery Controller Developer Guide. Then +// you access one of the endpoints for the cluster to get or update the routing // control state to redirect traffic. // -// For more information about working with routing controls, see Routing control -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html) -// in the Route 53 Application Recovery Controller Developer Guide. +// You must specify Regional endpoints when you work with API cluster operations +// to get or update routing control states in Application Recovery Controller. +// +// To see a code example for getting a routing control state, including accessing +// Regional cluster endpoints in sequence, see API examples (https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html) +// in the Amazon Route 53 Application Recovery Controller Developer Guide. +// +// Learn more about working with routing controls in the following topics in +// the Amazon Route 53 Application Recovery Controller Developer Guide: +// +// * Viewing and updating routing control states (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html) +// +// * Working with routing controls overall (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.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 @@ -164,11 +176,34 @@ func (c *Route53RecoveryCluster) UpdateRoutingControlStateRequest(input *UpdateR // // Set the state of the routing control to reroute traffic. You can set the // value to be On or Off. When the state is On, traffic flows to a cell. When -// it's off, traffic does not flow. +// it's Off, traffic does not flow. +// +// With Application Recovery Controller, you can add safety rules for routing +// controls, which are safeguards for routing control state updates that help +// prevent unexpected outcomes, like fail open traffic routing. However, there +// are scenarios when you might want to bypass the routing control safeguards +// that are enforced with safety rules that you've configured. For example, +// you might want to fail over quickly for disaster recovery, and one or more +// safety rules might be unexpectedly preventing you from updating a routing +// control state to reroute traffic. In a "break glass" scenario like this, +// you can override one or more safety rules to change a routing control state +// and fail over your application. +// +// The SafetyRulesToOverride property enables you override one or more safety +// rules and update routing control states. For more information, see Override +// safety rules to reroute traffic (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) +// in the Amazon Route 53 Application Recovery Controller Developer Guide. // -// For more information about working with routing controls, see Routing control -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html) -// in the Route 53 Application Recovery Controller Developer Guide. +// You must specify Regional endpoints when you work with API cluster operations +// to get or update routing control states in Application Recovery Controller. +// +// To see a code example for getting a routing control state, including accessing +// Regional cluster endpoints in sequence, see API examples (https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html) +// in the Amazon Route 53 Application Recovery Controller Developer Guide. +// +// * Viewing and updating routing control states (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html) +// +// * Working with routing controls overall (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.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 @@ -268,11 +303,34 @@ func (c *Route53RecoveryCluster) UpdateRoutingControlStatesRequest(input *Update // // Set multiple routing control states. You can set the value for each state // to be On or Off. When the state is On, traffic flows to a cell. When it's -// off, traffic does not flow. +// Off, traffic does not flow. +// +// With Application Recovery Controller, you can add safety rules for routing +// controls, which are safeguards for routing control state updates that help +// prevent unexpected outcomes, like fail open traffic routing. However, there +// are scenarios when you might want to bypass the routing control safeguards +// that are enforced with safety rules that you've configured. For example, +// you might want to fail over quickly for disaster recovery, and one or more +// safety rules might be unexpectedly preventing you from updating a routing +// control state to reroute traffic. In a "break glass" scenario like this, +// you can override one or more safety rules to change a routing control state +// and fail over your application. +// +// The SafetyRulesToOverride property enables you override one or more safety +// rules and update routing control states. For more information, see Override +// safety rules to reroute traffic (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) +// in the Amazon Route 53 Application Recovery Controller Developer Guide. +// +// You must specify Regional endpoints when you work with API cluster operations +// to get or update routing control states in Application Recovery Controller. // -// For more information about working with routing controls, see Routing control -// (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.html) -// in the Route 53 Application Recovery Controller Developer Guide. +// To see a code example for getting a routing control state, including accessing +// Regional cluster endpoints in sequence, see API examples (https://docs.aws.amazon.com/r53recovery/latest/dg/service_code_examples_actions.html) +// in the Amazon Route 53 Application Recovery Controller Developer Guide. +// +// * Viewing and updating routing control states (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.html) +// +// * Working with routing controls overall (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.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 @@ -830,11 +888,11 @@ func (s *ThrottlingException) RequestID() string { return s.RespMetadata.RequestID } -// A routing control state. +// A routing control state entry. type UpdateRoutingControlStateEntry struct { _ struct{} `type:"structure"` - // The Amazon Resource Number (ARN) for the routing control state entry. + // The Amazon Resource Number (ARN) for a routing control state entry. // // RoutingControlArn is a required field RoutingControlArn *string `min:"1" type:"string" required:"true"` @@ -907,6 +965,15 @@ type UpdateRoutingControlStateInput struct { // // RoutingControlState is a required field RoutingControlState *string `type:"string" required:"true" enum:"RoutingControlState"` + + // The Amazon Resource Numbers (ARNs) for the safety rules that you want to + // override when you're updating the state of a routing control. You can override + // one safety rule or multiple safety rules by including one or more ARNs, separated + // by commas. + // + // For more information, see Override safety rules to reroute traffic (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) + // in the Amazon Route 53 Application Recovery Controller Developer Guide. + SafetyRulesToOverride []*string `type:"list"` } // String returns the string representation. @@ -958,6 +1025,12 @@ func (s *UpdateRoutingControlStateInput) SetRoutingControlState(v string) *Updat return s } +// SetSafetyRulesToOverride sets the SafetyRulesToOverride field's value. +func (s *UpdateRoutingControlStateInput) SetSafetyRulesToOverride(v []*string) *UpdateRoutingControlStateInput { + s.SafetyRulesToOverride = v + return s +} + type UpdateRoutingControlStateOutput struct { _ struct{} `type:"structure"` } @@ -983,6 +1056,15 @@ func (s UpdateRoutingControlStateOutput) GoString() string { type UpdateRoutingControlStatesInput struct { _ struct{} `type:"structure"` + // The Amazon Resource Numbers (ARNs) for the safety rules that you want to + // override when you're updating routing control states. You can override one + // safety rule or multiple safety rules by including one or more ARNs, separated + // by commas. + // + // For more information, see Override safety rules to reroute traffic (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.override-safety-rule.html) + // in the Amazon Route 53 Application Recovery Controller Developer Guide. + SafetyRulesToOverride []*string `type:"list"` + // A set of routing control entries that you want to update. // // UpdateRoutingControlStateEntries is a required field @@ -1030,6 +1112,12 @@ func (s *UpdateRoutingControlStatesInput) Validate() error { return nil } +// SetSafetyRulesToOverride sets the SafetyRulesToOverride field's value. +func (s *UpdateRoutingControlStatesInput) SetSafetyRulesToOverride(v []*string) *UpdateRoutingControlStatesInput { + s.SafetyRulesToOverride = v + return s +} + // SetUpdateRoutingControlStateEntries sets the UpdateRoutingControlStateEntries field's value. func (s *UpdateRoutingControlStatesInput) SetUpdateRoutingControlStateEntries(v []*UpdateRoutingControlStateEntry) *UpdateRoutingControlStatesInput { s.UpdateRoutingControlStateEntries = v diff --git a/service/route53recoverycluster/doc.go b/service/route53recoverycluster/doc.go index c82bf94f875..4b1259ed1f0 100644 --- a/service/route53recoverycluster/doc.go +++ b/service/route53recoverycluster/doc.go @@ -3,38 +3,54 @@ // Package route53recoverycluster provides the client and types for making API // requests to Route53 Recovery Cluster. // -// Welcome to the Amazon Route 53 Application Recovery Controller API Reference -// Guide for Recovery Control Data Plane . -// -// Recovery control in Route 53 Application Recovery Controller includes extremely -// reliable routing controls that enable you to recover applications by rerouting -// traffic, for example, across Availability Zones or AWS Regions. Routing controls -// are simple on/off switches hosted on a cluster. A cluster is a set of five -// redundant regional endpoints against which you can execute API calls to update -// or get the state of routing controls. You use routing controls to failover -// traffic to recover your application across Availability Zones or Regions. -// -// This API guide includes information about how to get and update routing control -// states in Route 53 Application Recovery Controller. -// -// For more information about Route 53 Application Recovery Controller, see -// the following: -// -// * You can create clusters, routing controls, and control panels by using -// the control plane API for Recovery Control. For more information, see -// Amazon Route 53 Application Recovery Controller Recovery Control API Reference +// Welcome to the Routing Control (Recovery Cluster) API Reference Guide for +// Amazon Route 53 Application Recovery Controller. +// +// With Amazon Route 53 Application Recovery Controller, you can use routing +// control with extreme reliability to recover applications by rerouting traffic +// across Availability Zones or AWS Regions. Routing controls are simple on/off +// switches hosted on a highly available cluster in Application Recovery Controller. +// A cluster provides a set of five redundant Regional endpoints against which +// you can run API calls to get or update the state of routing controls. To +// implement failover, you set one routing control on and another one off, to +// reroute traffic from one Availability Zone or Amazon Web Services Region +// to another. +// +// Be aware that you must specify the Regional endpoints for a cluster when +// you work with API cluster operations to get or update routing control states +// in Application Recovery Controller. In addition, you must specify the US +// West (Oregon) Region for Application Recovery Controller API calls. For example, +// use the parameter region us-west-2 with AWS CLI commands. For more information, +// see Get and update routing control states using the API (https://docs.aws.amazon.com/r53recovery/latest/dg/routing-control.update.api.html) +// in the Amazon Route 53 Application Recovery Controller Developer Guide. +// +// This API guide includes information about the API operations for how to get +// and update routing control states in Application Recovery Controller. You +// also must set up the structures to support routing controls: clusters and +// control panels. +// +// For more information about working with routing control in Application Recovery +// Controller, see the following: +// +// * To create clusters, routing controls, and control panels by using the +// control plane API for routing control, see the Recovery Control Configuration +// API Reference Guide for Amazon Route 53 Application Recovery Controller // (https://docs.aws.amazon.com/recovery-cluster/latest/api/). // -// * Route 53 Application Recovery Controller also provides continuous readiness -// checks to ensure that your applications are scaled to handle failover -// traffic. For more information about the related API actions, see Amazon -// Route 53 Application Recovery Controller Recovery Readiness API Reference -// (https://docs.aws.amazon.com/recovery-readiness/latest/api/). +// * Learn about the components in recovery control configuration, including +// clusters, routing controls, and control panels. For more information, +// see Recovery control components (https://docs.aws.amazon.com/r53recovery/latest/dg/introduction-components.html#introduction-components-routing) +// in the Amazon Route 53 Application Recovery Controller Developer Guide. +// +// * Application Recovery Controller also provides readiness checks that +// run continually to help make sure that your applications are scaled and +// ready to handle failover traffic. For more information about the related +// API actions, see the Recovery Readiness API Reference Guide for Amazon +// Route 53 Application Recovery Controller (https://docs.aws.amazon.com/recovery-readiness/latest/api/). // // * For more information about creating resilient applications and preparing -// for recovery readiness with Route 53 Application Recovery Controller, -// see the Amazon Route 53 Application Recovery Controller Developer Guide -// (r53recovery/latest/dg/). +// for recovery readiness with Application Recovery Controller, see the Amazon +// Route 53 Application Recovery Controller Developer Guide (https://docs.aws.amazon.com/r53recovery/latest/dg/). // // See https://docs.aws.amazon.com/goto/WebAPI/route53-recovery-cluster-2019-12-02 for more information on this service. //