{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-finspace","description":"FinSpace User Environment Management service","version":"2021-03-12","base_url":"","endpoints":50,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api FinSpace User Environment Management service\n@version 2021-03-12\n@auth AWS SigV4\n@endpoints 50\n@hint download_for_search\n@toc environment(5), kx(42), tags(3)\n\n@group environment\n@endpoint POST /environment\n@desc Create a new FinSpace environment.\n@required {name: str}\n@optional {description: str, kmsKeyId: str, tags: map<str,str>, federationMode: str, federationParameters: FederationParameters, superuserParameters: SuperuserParameters, dataBundles: [str]}\n@returns(200) {environmentId: str?, environmentArn: str?, environmentUrl: str?}\n\n@endgroup\n\n@group kx\n@endpoint POST /kx/environments/{environmentId}/databases/{databaseName}/changesets\n@desc Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.\n@required {environmentId: str, databaseName: str, changeRequests: [ChangeRequest], clientToken: str}\n@returns(200) {changesetId: str?, databaseName: str?, environmentId: str?, changeRequests: [ChangeRequest]?, createdTimestamp: str(timestamp)?, lastModifiedTimestamp: str(timestamp)?, status: str?, errorInfo: ErrorInfo?{errorMessage: str?, errorType: str?}}\n\n@endpoint POST /kx/environments/{environmentId}/clusters\n@desc Creates a new kdb cluster.\n@required {environmentId: str, clusterName: str, clusterType: str, releaseLabel: str, vpcConfiguration: VpcConfiguration, azMode: str}\n@optional {clientToken: str, tickerplantLogConfiguration: TickerplantLogConfiguration, databases: [KxDatabaseConfiguration], cacheStorageConfigurations: [KxCacheStorageConfiguration], autoScalingConfiguration: AutoScalingConfiguration, clusterDescription: str, capacityConfiguration: CapacityConfiguration, initializationScript: str, commandLineArguments: [KxCommandLineArgument], code: CodeConfiguration, executionRole: str, savedownStorageConfiguration: KxSavedownStorageConfiguration, availabilityZoneId: str, tags: map<str,str>, scalingGroupConfiguration: KxScalingGroupConfiguration}\n@returns(200) {environmentId: str?, status: str?, statusReason: str?, clusterName: str?, clusterType: str?, tickerplantLogConfiguration: TickerplantLogConfiguration?{tickerplantLogVolumes: [str]?}, volumes: [Volume]?, databases: [KxDatabaseConfiguration]?, cacheStorageConfigurations: [KxCacheStorageConfiguration]?, autoScalingConfiguration: AutoScalingConfiguration?{minNodeCount: int?, maxNodeCount: int?, autoScalingMetric: str?, metricTarget: num(f64)?, scaleInCooldownSeconds: num(f64)?, scaleOutCooldownSeconds: num(f64)?}, clusterDescription: str?, capacityConfiguration: CapacityConfiguration?{nodeType: str?, nodeCount: int?}, releaseLabel: str?, vpcConfiguration: VpcConfiguration?{vpcId: str?, securityGroupIds: [str]?, subnetIds: [str]?, ipAddressType: str?}, initializationScript: str?, commandLineArguments: [KxCommandLineArgument]?, code: CodeConfiguration?{s3Bucket: str?, s3Key: str?, s3ObjectVersion: str?}, executionRole: str?, lastModifiedTimestamp: str(timestamp)?, savedownStorageConfiguration: KxSavedownStorageConfiguration?{type: str?, size: int?, volumeName: str?}, azMode: str?, availabilityZoneId: str?, createdTimestamp: str(timestamp)?, scalingGroupConfiguration: KxScalingGroupConfiguration?{scalingGroupName: str, memoryLimit: int?, memoryReservation: int, nodeCount: int, cpu: num(f64)?}}\n\n@endpoint POST /kx/environments/{environmentId}/databases\n@desc Creates a new kdb database in the environment.\n@required {environmentId: str, databaseName: str, clientToken: str}\n@optional {description: str, tags: map<str,str>}\n@returns(200) {databaseName: str?, databaseArn: str?, environmentId: str?, description: str?, createdTimestamp: str(timestamp)?, lastModifiedTimestamp: str(timestamp)?}\n\n@endpoint POST /kx/environments/{environmentId}/databases/{databaseName}/dataviews\n@desc Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters.\n@required {environmentId: str, databaseName: str, dataviewName: str, azMode: str, clientToken: str}\n@optional {availabilityZoneId: str, changesetId: str, segmentConfigurations: [KxDataviewSegmentConfiguration], autoUpdate: bool, readWrite: bool, description: str, tags: map<str,str>}\n@returns(200) {dataviewName: str?, databaseName: str?, environmentId: str?, azMode: str?, availabilityZoneId: str?, changesetId: str?, segmentConfigurations: [KxDataviewSegmentConfiguration]?, description: str?, autoUpdate: bool?, readWrite: bool?, createdTimestamp: str(timestamp)?, lastModifiedTimestamp: str(timestamp)?, status: str?}\n\n@endpoint POST /kx/environments\n@desc Creates a managed kdb environment for the account.\n@required {name: str, kmsKeyId: str}\n@optional {description: str, tags: map<str,str>, clientToken: str}\n@returns(200) {name: str?, status: str?, environmentId: str?, description: str?, environmentArn: str?, kmsKeyId: str?, creationTimestamp: str(timestamp)?}\n\n@endpoint POST /kx/environments/{environmentId}/scalingGroups\n@desc Creates a new scaling group.\n@required {environmentId: str, clientToken: str, scalingGroupName: str, hostType: str, availabilityZoneId: str}\n@optional {tags: map<str,str>}\n@returns(200) {environmentId: str?, scalingGroupName: str?, hostType: str?, availabilityZoneId: str?, status: str?, lastModifiedTimestamp: str(timestamp)?, createdTimestamp: str(timestamp)?}\n\n@endpoint POST /kx/environments/{environmentId}/users\n@desc Creates a user in FinSpace kdb environment with an associated IAM role.\n@required {environmentId: str, userName: str, iamRole: str}\n@optional {tags: map<str,str>, clientToken: str}\n@returns(200) {userName: str?, userArn: str?, environmentId: str?, iamRole: str?}\n\n@endpoint POST /kx/environments/{environmentId}/kxvolumes\n@desc Creates a new volume with a specific amount of throughput and storage capacity.\n@required {environmentId: str, volumeType: str, volumeName: str, azMode: str, availabilityZoneIds: [str]}\n@optional {clientToken: str, description: str, nas1Configuration: KxNAS1Configuration, tags: map<str,str>}\n@returns(200) {environmentId: str?, volumeName: str?, volumeType: str?, volumeArn: str?, nas1Configuration: KxNAS1Configuration?{type: str?, size: int?}, status: str?, statusReason: str?, azMode: str?, description: str?, availabilityZoneIds: [str]?, createdTimestamp: str(timestamp)?}\n\n@endgroup\n\n@group environment\n@endpoint DELETE /environment/{environmentId}\n@desc Delete an FinSpace environment.\n@required {environmentId: str}\n\n@endgroup\n\n@group kx\n@endpoint DELETE /kx/environments/{environmentId}/clusters/{clusterName}\n@desc Deletes a kdb cluster.\n@required {environmentId: str, clusterName: str}\n@optional {clientToken: str}\n\n@endpoint DELETE /kx/environments/{environmentId}/clusters/{clusterName}/nodes/{nodeId}\n@desc Deletes the specified nodes from a cluster.\n@required {environmentId: str, clusterName: str, nodeId: str}\n\n@endpoint DELETE /kx/environments/{environmentId}/databases/{databaseName}\n@desc Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.\n@required {environmentId: str, databaseName: str, clientToken: str}\n\n@endpoint DELETE /kx/environments/{environmentId}/databases/{databaseName}/dataviews/{dataviewName}\n@desc Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.\n@required {environmentId: str, databaseName: str, dataviewName: str, clientToken: str}\n\n@endpoint DELETE /kx/environments/{environmentId}\n@desc Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.\n@required {environmentId: str}\n@optional {clientToken: str}\n\n@endpoint DELETE /kx/environments/{environmentId}/scalingGroups/{scalingGroupName}\n@desc Deletes the specified scaling group. This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.\n@required {environmentId: str, scalingGroupName: str}\n@optional {clientToken: str}\n\n@endpoint DELETE /kx/environments/{environmentId}/users/{userName}\n@desc Deletes a user in the specified kdb environment.\n@required {userName: str, environmentId: str}\n@optional {clientToken: str}\n\n@endpoint DELETE /kx/environments/{environmentId}/kxvolumes/{volumeName}\n@desc Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.\n@required {environmentId: str, volumeName: str}\n@optional {clientToken: str}\n\n@endgroup\n\n@group environment\n@endpoint GET /environment/{environmentId}\n@desc Returns the FinSpace environment object.\n@required {environmentId: str}\n@returns(200) {environment: Environment?{name: str?, environmentId: str?, awsAccountId: str?, status: str?, environmentUrl: str?, description: str?, environmentArn: str?, sageMakerStudioDomainUrl: str?, kmsKeyId: str?, dedicatedServiceAccountId: str?, federationMode: str?, federationParameters: FederationParameters?{samlMetadataDocument: str?, samlMetadataURL: str?, applicationCallBackURL: str?, federationURN: str?, federationProviderName: str?, attributeMap: map<str,str>?}}}\n\n@endgroup\n\n@group kx\n@endpoint GET /kx/environments/{environmentId}/databases/{databaseName}/changesets/{changesetId}\n@desc Returns information about a kdb changeset.\n@required {environmentId: str, databaseName: str, changesetId: str}\n@returns(200) {changesetId: str?, databaseName: str?, environmentId: str?, changeRequests: [ChangeRequest]?, createdTimestamp: str(timestamp)?, activeFromTimestamp: str(timestamp)?, lastModifiedTimestamp: str(timestamp)?, status: str?, errorInfo: ErrorInfo?{errorMessage: str?, errorType: str?}}\n\n@endpoint GET /kx/environments/{environmentId}/clusters/{clusterName}\n@desc Retrieves information about a kdb cluster.\n@required {environmentId: str, clusterName: str}\n@returns(200) {status: str?, statusReason: str?, clusterName: str?, clusterType: str?, tickerplantLogConfiguration: TickerplantLogConfiguration?{tickerplantLogVolumes: [str]?}, volumes: [Volume]?, databases: [KxDatabaseConfiguration]?, cacheStorageConfigurations: [KxCacheStorageConfiguration]?, autoScalingConfiguration: AutoScalingConfiguration?{minNodeCount: int?, maxNodeCount: int?, autoScalingMetric: str?, metricTarget: num(f64)?, scaleInCooldownSeconds: num(f64)?, scaleOutCooldownSeconds: num(f64)?}, clusterDescription: str?, capacityConfiguration: CapacityConfiguration?{nodeType: str?, nodeCount: int?}, releaseLabel: str?, vpcConfiguration: VpcConfiguration?{vpcId: str?, securityGroupIds: [str]?, subnetIds: [str]?, ipAddressType: str?}, initializationScript: str?, commandLineArguments: [KxCommandLineArgument]?, code: CodeConfiguration?{s3Bucket: str?, s3Key: str?, s3ObjectVersion: str?}, executionRole: str?, lastModifiedTimestamp: str(timestamp)?, savedownStorageConfiguration: KxSavedownStorageConfiguration?{type: str?, size: int?, volumeName: str?}, azMode: str?, availabilityZoneId: str?, createdTimestamp: str(timestamp)?, scalingGroupConfiguration: KxScalingGroupConfiguration?{scalingGroupName: str, memoryLimit: int?, memoryReservation: int, nodeCount: int, cpu: num(f64)?}}\n\n@endpoint GET /kx/environments/{environmentId}/connectionString\n@desc Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.\n@required {userArn: str, environmentId: str, clusterName: str}\n@returns(200) {signedConnectionString: str?}\n\n@endpoint GET /kx/environments/{environmentId}/databases/{databaseName}\n@desc Returns database information for the specified environment ID.\n@required {environmentId: str, databaseName: str}\n@returns(200) {databaseName: str?, databaseArn: str?, environmentId: str?, description: str?, createdTimestamp: str(timestamp)?, lastModifiedTimestamp: str(timestamp)?, lastCompletedChangesetId: str?, numBytes: int(i64)?, numChangesets: int?, numFiles: int?}\n\n@endpoint GET /kx/environments/{environmentId}/databases/{databaseName}/dataviews/{dataviewName}\n@desc Retrieves details of the dataview.\n@required {environmentId: str, databaseName: str, dataviewName: str}\n@returns(200) {databaseName: str?, dataviewName: str?, azMode: str?, availabilityZoneId: str?, changesetId: str?, segmentConfigurations: [KxDataviewSegmentConfiguration]?, activeVersions: [KxDataviewActiveVersion]?, description: str?, autoUpdate: bool?, readWrite: bool?, environmentId: str?, createdTimestamp: str(timestamp)?, lastModifiedTimestamp: str(timestamp)?, status: str?, statusReason: str?}\n\n@endpoint GET /kx/environments/{environmentId}\n@desc Retrieves all the information for the specified kdb environment.\n@required {environmentId: str}\n@returns(200) {name: str?, environmentId: str?, awsAccountId: str?, status: str?, tgwStatus: str?, dnsStatus: str?, errorMessage: str?, description: str?, environmentArn: str?, kmsKeyId: str?, dedicatedServiceAccountId: str?, transitGatewayConfiguration: TransitGatewayConfiguration?{transitGatewayID: str, routableCIDRSpace: str, attachmentNetworkAclConfiguration: [NetworkACLEntry]?}, customDNSConfiguration: [CustomDNSServer]?, creationTimestamp: str(timestamp)?, updateTimestamp: str(timestamp)?, availabilityZoneIds: [str]?, certificateAuthorityArn: str?}\n\n@endpoint GET /kx/environments/{environmentId}/scalingGroups/{scalingGroupName}\n@desc Retrieves details of a scaling group.\n@required {environmentId: str, scalingGroupName: str}\n@returns(200) {scalingGroupName: str?, scalingGroupArn: str?, hostType: str?, clusters: [str]?, availabilityZoneId: str?, status: str?, statusReason: str?, lastModifiedTimestamp: str(timestamp)?, createdTimestamp: str(timestamp)?}\n\n@endpoint GET /kx/environments/{environmentId}/users/{userName}\n@desc Retrieves information about the specified kdb user.\n@required {userName: str, environmentId: str}\n@returns(200) {userName: str?, userArn: str?, environmentId: str?, iamRole: str?}\n\n@endpoint GET /kx/environments/{environmentId}/kxvolumes/{volumeName}\n@desc Retrieves the information about the volume.\n@required {environmentId: str, volumeName: str}\n@returns(200) {environmentId: str?, volumeName: str?, volumeType: str?, volumeArn: str?, nas1Configuration: KxNAS1Configuration?{type: str?, size: int?}, status: str?, statusReason: str?, createdTimestamp: str(timestamp)?, description: str?, azMode: str?, availabilityZoneIds: [str]?, lastModifiedTimestamp: str(timestamp)?, attachedClusters: [KxAttachedCluster]?}\n\n@endgroup\n\n@group environment\n@endpoint GET /environment\n@desc A list of all of your FinSpace environments.\n@optional {nextToken: str, maxResults: int}\n@returns(200) {environments: [Environment]?, nextToken: str?}\n\n@endgroup\n\n@group kx\n@endpoint GET /kx/environments/{environmentId}/databases/{databaseName}/changesets\n@desc Returns a list of all the changesets for a database.\n@required {environmentId: str, databaseName: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {kxChangesets: [KxChangesetListEntry]?, nextToken: str?}\n\n@endpoint GET /kx/environments/{environmentId}/clusters/{clusterName}/nodes\n@desc Lists all the nodes in a kdb cluster.\n@required {environmentId: str, clusterName: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {nodes: [KxNode]?, nextToken: str?}\n\n@endpoint GET /kx/environments/{environmentId}/clusters\n@desc Returns a list of clusters.\n@required {environmentId: str}\n@optional {clusterType: str, maxResults: int, nextToken: str}\n@returns(200) {kxClusterSummaries: [KxCluster]?, nextToken: str?}\n\n@endpoint GET /kx/environments/{environmentId}/databases\n@desc Returns a list of all the databases in the kdb environment.\n@required {environmentId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {kxDatabases: [KxDatabaseListEntry]?, nextToken: str?}\n\n@endpoint GET /kx/environments/{environmentId}/databases/{databaseName}/dataviews\n@desc Returns a list of all the dataviews in the database.\n@required {environmentId: str, databaseName: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {kxDataviews: [KxDataviewListEntry]?, nextToken: str?}\n\n@endpoint GET /kx/environments\n@desc Returns a list of kdb environments created in an account.\n@optional {nextToken: str, maxResults: int}\n@returns(200) {environments: [KxEnvironment]?, nextToken: str?}\n\n@endpoint GET /kx/environments/{environmentId}/scalingGroups\n@desc Returns a list of scaling groups in a kdb environment.\n@required {environmentId: str}\n@optional {maxResults: int, nextToken: str}\n@returns(200) {scalingGroups: [KxScalingGroup]?, nextToken: str?}\n\n@endpoint GET /kx/environments/{environmentId}/users\n@desc Lists all the users in a kdb environment.\n@required {environmentId: str}\n@optional {nextToken: str, maxResults: int}\n@returns(200) {users: [KxUser]?, nextToken: str?}\n\n@endpoint GET /kx/environments/{environmentId}/kxvolumes\n@desc Lists all the volumes in a kdb environment.\n@required {environmentId: str}\n@optional {maxResults: int, nextToken: str, volumeType: str}\n@returns(200) {kxVolumeSummaries: [KxVolume]?, nextToken: str?}\n\n@endgroup\n\n@group tags\n@endpoint GET /tags/{resourceArn}\n@desc A list of all tags for a resource.\n@required {resourceArn: str}\n@returns(200) {tags: map<str,str>?}\n\n@endpoint POST /tags/{resourceArn}\n@desc Adds metadata tags to a FinSpace resource.\n@required {resourceArn: str, tags: map<str,str>}\n\n@endpoint DELETE /tags/{resourceArn}\n@desc Removes metadata tags from a FinSpace resource.\n@required {resourceArn: str, tagKeys: [str]}\n\n@endgroup\n\n@group environment\n@endpoint PUT /environment/{environmentId}\n@desc Update your FinSpace environment.\n@required {environmentId: str}\n@optional {name: str, description: str, federationMode: str, federationParameters: FederationParameters}\n@returns(200) {environment: Environment?{name: str?, environmentId: str?, awsAccountId: str?, status: str?, environmentUrl: str?, description: str?, environmentArn: str?, sageMakerStudioDomainUrl: str?, kmsKeyId: str?, dedicatedServiceAccountId: str?, federationMode: str?, federationParameters: FederationParameters?{samlMetadataDocument: str?, samlMetadataURL: str?, applicationCallBackURL: str?, federationURN: str?, federationProviderName: str?, attributeMap: map<str,str>?}}}\n\n@endgroup\n\n@group kx\n@endpoint PUT /kx/environments/{environmentId}/clusters/{clusterName}/configuration/code\n@desc Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster.\n@required {environmentId: str, clusterName: str, code: CodeConfiguration}\n@optional {clientToken: str, initializationScript: str, commandLineArguments: [KxCommandLineArgument], deploymentConfiguration: KxClusterCodeDeploymentConfiguration}\n\n@endpoint PUT /kx/environments/{environmentId}/clusters/{clusterName}/configuration/databases\n@desc Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths to be cached. This API does not allow you to change a database name or add a database if you created a cluster without one.  Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.\n@required {environmentId: str, clusterName: str, databases: [KxDatabaseConfiguration]}\n@optional {clientToken: str, deploymentConfiguration: KxDeploymentConfiguration}\n\n@endpoint PUT /kx/environments/{environmentId}/databases/{databaseName}\n@desc Updates information for the given kdb database.\n@required {environmentId: str, databaseName: str, clientToken: str}\n@optional {description: str}\n@returns(200) {databaseName: str?, environmentId: str?, description: str?, lastModifiedTimestamp: str(timestamp)?}\n\n@endpoint PUT /kx/environments/{environmentId}/databases/{databaseName}/dataviews/{dataviewName}\n@desc Updates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations\n@required {environmentId: str, databaseName: str, dataviewName: str, clientToken: str}\n@optional {description: str, changesetId: str, segmentConfigurations: [KxDataviewSegmentConfiguration]}\n@returns(200) {environmentId: str?, databaseName: str?, dataviewName: str?, azMode: str?, availabilityZoneId: str?, changesetId: str?, segmentConfigurations: [KxDataviewSegmentConfiguration]?, activeVersions: [KxDataviewActiveVersion]?, status: str?, autoUpdate: bool?, readWrite: bool?, description: str?, createdTimestamp: str(timestamp)?, lastModifiedTimestamp: str(timestamp)?}\n\n@endpoint PUT /kx/environments/{environmentId}\n@desc Updates information for the given kdb environment.\n@required {environmentId: str}\n@optional {name: str, description: str, clientToken: str}\n@returns(200) {name: str?, environmentId: str?, awsAccountId: str?, status: str?, tgwStatus: str?, dnsStatus: str?, errorMessage: str?, description: str?, environmentArn: str?, kmsKeyId: str?, dedicatedServiceAccountId: str?, transitGatewayConfiguration: TransitGatewayConfiguration?{transitGatewayID: str, routableCIDRSpace: str, attachmentNetworkAclConfiguration: [NetworkACLEntry]?}, customDNSConfiguration: [CustomDNSServer]?, creationTimestamp: str(timestamp)?, updateTimestamp: str(timestamp)?, availabilityZoneIds: [str]?}\n\n@endpoint PUT /kx/environments/{environmentId}/network\n@desc Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers. Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.\n@required {environmentId: str}\n@optional {transitGatewayConfiguration: TransitGatewayConfiguration, customDNSConfiguration: [CustomDNSServer], clientToken: str}\n@returns(200) {name: str?, environmentId: str?, awsAccountId: str?, status: str?, tgwStatus: str?, dnsStatus: str?, errorMessage: str?, description: str?, environmentArn: str?, kmsKeyId: str?, dedicatedServiceAccountId: str?, transitGatewayConfiguration: TransitGatewayConfiguration?{transitGatewayID: str, routableCIDRSpace: str, attachmentNetworkAclConfiguration: [NetworkACLEntry]?}, customDNSConfiguration: [CustomDNSServer]?, creationTimestamp: str(timestamp)?, updateTimestamp: str(timestamp)?, availabilityZoneIds: [str]?}\n\n@endpoint PUT /kx/environments/{environmentId}/users/{userName}\n@desc Updates the user details. You can only update the IAM role associated with a user.\n@required {environmentId: str, userName: str, iamRole: str}\n@optional {clientToken: str}\n@returns(200) {userName: str?, userArn: str?, environmentId: str?, iamRole: str?}\n\n@endpoint PATCH /kx/environments/{environmentId}/kxvolumes/{volumeName}\n@desc Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete.\n@required {environmentId: str, volumeName: str}\n@optional {description: str, clientToken: str, nas1Configuration: KxNAS1Configuration}\n@returns(200) {environmentId: str?, volumeName: str?, volumeType: str?, volumeArn: str?, nas1Configuration: KxNAS1Configuration?{type: str?, size: int?}, status: str?, description: str?, statusReason: str?, createdTimestamp: str(timestamp)?, azMode: str?, availabilityZoneIds: [str]?, lastModifiedTimestamp: str(timestamp)?, attachedClusters: [KxAttachedCluster]?}\n\n@endgroup\n\n@end\n"}