From eddc204945e569c16f0298af31a5eea039cd5042 Mon Sep 17 00:00:00 2001 From: rchache <105247787+rchache@users.noreply.github.com> Date: Tue, 20 Oct 2026 15:12:30 -0400 Subject: [PATCH 1/5] Delete models/tnb directory --- .../service/2008-10-21/tnb-2008-10-21.json | 6612 ----------------- 1 file changed, 6612 deletions(-) delete mode 100644 models/tnb/service/2008-10-21/tnb-2008-10-21.json diff --git a/models/tnb/service/2008-10-21/tnb-2008-10-21.json b/models/tnb/service/2008-10-21/tnb-2008-10-21.json deleted file mode 100644 index 62d539571..000000000 --- a/models/tnb/service/2008-10-21/tnb-2008-10-21.json +++ /dev/null @@ -1,6612 +0,0 @@ -{ - "smithy": "2.0", - "shapes": { - "com.amazonaws.tnb#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Insufficient permissions to make request.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.tnb#CancelSolNetworkOperation": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#CancelSolNetworkOperationInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Cancels a network operation.

\n

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

", - "smithy.api#examples": [ - { - "title": "Cancel a in-progress Sol Network Operation.", - "input": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241" - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/sol/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel", - "code": 202 - } - } - }, - "com.amazonaws.tnb#CancelSolNetworkOperationInput": { - "type": "structure", - "members": { - "nsLcmOpOccId": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

The identifier of the network operation.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#CreateSolFunctionPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#CreateSolFunctionPackageInput" - }, - "output": { - "target": "com.amazonaws.tnb#CreateSolFunctionPackageOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a function package.

\n

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network. For more information, see Function packages in the\n Amazon Web Services Telco Network Builder User Guide.

\n

Creating a function package is the first step for creating a network in AWS TNB. This\n request creates an empty container with an ID. The next step is to upload the actual CSAR\n zip file into that empty container. To upload function package content, see PutSolFunctionPackageContent.

", - "smithy.api#examples": [ - { - "title": "Create a Sol function package", - "input": { - "tags": { - "Name": "Resource" - } - }, - "output": { - "onboardingState": "CREATED", - "operationalState": "DISABLED", - "usageState": "NOT_IN_USE", - "id": "fp-07aa863e53460a2a6", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-package/fp-07aa863e53460a2a6", - "tags": { - "Name": "Resource" - } - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/sol/vnfpkgm/v1/vnf_packages", - "code": 201 - } - } - }, - "com.amazonaws.tnb#CreateSolFunctionPackageInput": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#CreateSolFunctionPackageOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

ID of the function package.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#VnfPkgArn", - "traits": { - "smithy.api#documentation": "

Function package ARN.

", - "smithy.api#required": {} - } - }, - "onboardingState": { - "target": "com.amazonaws.tnb#OnboardingState", - "traits": { - "smithy.api#documentation": "

Onboarding state of the function package.

", - "smithy.api#required": {} - } - }, - "operationalState": { - "target": "com.amazonaws.tnb#OperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the function package.

", - "smithy.api#required": {} - } - }, - "usageState": { - "target": "com.amazonaws.tnb#UsageState", - "traits": { - "smithy.api#documentation": "

Usage state of the function package.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#CreateSolNetworkInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#CreateSolNetworkInstanceInput" - }, - "output": { - "target": "com.amazonaws.tnb#CreateSolNetworkInstanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a network instance.

\n

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed. Creating a network instance is the third step after creating a network\n package. For more information about network instances, Network instances in the\n Amazon Web Services Telco Network Builder User Guide.

\n

Once you create a network instance, you can instantiate it. To instantiate a network,\n see InstantiateSolNetworkInstance.

", - "smithy.api#examples": [ - { - "title": "Create a Sol Network Instance", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241", - "nsName": "CITY Instance", - "nsDescription": "Test network for CITY", - "tags": { - "Name": "Resource" - } - }, - "output": { - "id": "ni-07aa863e53460a2a6", - "nsdInfoId": "np-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-instance/ni-07aa863e53460a2a6", - "nsInstanceName": "CITY Instance", - "tags": { - "Name": "Resource" - } - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/sol/nslcm/v1/ns_instances", - "code": 201 - } - } - }, - "com.amazonaws.tnb#CreateSolNetworkInstanceInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID for network service descriptor.

", - "smithy.api#required": {} - } - }, - "nsName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network instance name.

", - "smithy.api#length": { - "min": 1, - "max": 100 - }, - "smithy.api#required": {} - } - }, - "nsDescription": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network instance description.

", - "smithy.api#length": { - "min": 0, - "max": 255 - } - } - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#CreateSolNetworkInstanceOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

Network instance ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsInstanceArn", - "traits": { - "smithy.api#documentation": "

Network instance ARN.

", - "smithy.api#required": {} - } - }, - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

Network service descriptor ID.

", - "smithy.api#required": {} - } - }, - "nsInstanceName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network instance name.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#CreateSolNetworkPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#CreateSolNetworkPackageInput" - }, - "output": { - "target": "com.amazonaws.tnb#CreateSolNetworkPackageOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a network package.

\n

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on. For more information, see Network instances in the\n Amazon Web Services Telco Network Builder User Guide.

\n

A network package consists of a network service descriptor (NSD) file (required) and any\n additional files (optional), such as scripts specific to your needs. For example, if you\n have multiple function packages in your network package, you can use the NSD to define\n which network functions should run in certain VPCs, subnets, or EKS clusters.

\n

This request creates an empty network package container with an ID. Once you create a\n network package, you can upload the network package content using PutSolNetworkPackageContent.

", - "smithy.api#examples": [ - { - "title": "Create a Sol network package", - "input": { - "tags": { - "Name": "Resource" - } - }, - "output": { - "id": "np-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", - "nsdOnboardingState": "CREATED", - "nsdOperationalState": "DISABLED", - "nsdUsageState": "NOT_IN_USE", - "tags": { - "Name": "Resource" - } - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/sol/nsd/v1/ns_descriptors", - "code": 201 - } - } - }, - "com.amazonaws.tnb#CreateSolNetworkPackageInput": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#CreateSolNetworkPackageOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the network package.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsdInfoArn", - "traits": { - "smithy.api#documentation": "

Network package ARN.

", - "smithy.api#required": {} - } - }, - "nsdOnboardingState": { - "target": "com.amazonaws.tnb#NsdOnboardingState", - "traits": { - "smithy.api#documentation": "

Onboarding state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "nsdOperationalState": { - "target": "com.amazonaws.tnb#NsdOperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "nsdUsageState": { - "target": "com.amazonaws.tnb#NsdUsageState", - "traits": { - "smithy.api#documentation": "

Usage state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#DeleteSolFunctionPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#DeleteSolFunctionPackageInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a function package.

\n

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

\n

To delete a function package, the package must be in a disabled state. To disable a\n function package, see UpdateSolFunctionPackage.

", - "smithy.api#examples": [ - { - "title": "Delete a function package", - "input": { - "vnfPkgId": "fp-07aa863e53460a2a6" - } - } - ], - "smithy.api#http": { - "method": "DELETE", - "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#DeleteSolFunctionPackageInput": { - "type": "structure", - "members": { - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

ID of the function package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#DeleteSolNetworkInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#DeleteSolNetworkInstanceInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a network instance.

\n

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

\n

To delete a network instance, the instance must be in a stopped or terminated state. To\n terminate a network instance, see TerminateSolNetworkInstance.

", - "smithy.api#examples": [ - { - "title": "Delete a Sol Network Instance.", - "input": { - "nsInstanceId": "ni-07aa863e53460a2a6" - } - } - ], - "smithy.api#http": { - "method": "DELETE", - "uri": "/sol/nslcm/v1/ns_instances/{nsInstanceId}", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#DeleteSolNetworkInstanceInput": { - "type": "structure", - "members": { - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

Network instance ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#DeleteSolNetworkPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#DeleteSolNetworkPackageInput" - }, - "output": { - "target": "smithy.api#Unit" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes network package.

\n

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

\n

To delete a network package, the package must be in a disable state. To disable a\n network package, see UpdateSolNetworkPackage.

", - "smithy.api#examples": [ - { - "title": "Delete a Sol network package", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241" - } - } - ], - "smithy.api#http": { - "method": "DELETE", - "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}", - "code": 204 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#DeleteSolNetworkPackageInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor in the network package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#DescriptorContentType": { - "type": "enum", - "members": { - "TEXT_PLAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "text/plain" - } - } - } - }, - "com.amazonaws.tnb#ErrorCause": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.tnb#ErrorDetails": { - "type": "string", - "traits": { - "smithy.api#length": { - "max": 10240 - } - } - }, - "com.amazonaws.tnb#ErrorInfo": { - "type": "structure", - "members": { - "cause": { - "target": "com.amazonaws.tnb#ErrorCause", - "traits": { - "smithy.api#documentation": "

Error cause.

" - } - }, - "details": { - "target": "com.amazonaws.tnb#ErrorDetails", - "traits": { - "smithy.api#documentation": "

Error details.

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

Provides error information.

" - } - }, - "com.amazonaws.tnb#FunctionArtifactMeta": { - "type": "structure", - "members": { - "overrides": { - "target": "com.amazonaws.tnb#OverrideList", - "traits": { - "smithy.api#documentation": "

Lists of function package overrides.

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

Metadata for function package artifacts.

\n

Artifacts are the contents of the package descriptor file and the state of the package.

" - } - }, - "com.amazonaws.tnb#GetSolFunctionInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolFunctionInstanceInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolFunctionInstanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the details of a network function instance, including the instantiation state and\n metadata from the function package descriptor in the network function package.

\n

A network function instance is a function in a function package .

", - "smithy.api#examples": [ - { - "title": "Get a Sol Network Function Instance details", - "input": { - "vnfInstanceId": "fi-b9439c34c1ef86c54" - }, - "output": { - "id": "fi-b9439c34c1ef86c54", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-instance/fi-b9439c34c1ef86c54", - "nsInstanceId": "ni-07aa863e53460a2a6", - "vnfPkgId": "fp-07aa863e53460a2a6", - "vnfdId": "6625a858-2157-4d74-9197-a6ff67d51f3e", - "vnfProvider": "VNFBuilder", - "vnfProductName": "VNFBuilder-AMF", - "vnfdVersion": "1.0", - "instantiationState": "INSTANTIATED", - "instantiatedVnfInfo": { - "vnfState": "STARTED", - "vnfcResourceInfo": [ - { - "metadata": { - "cluster": "TestCluster", - "nodeGroup": "Core-EKS-TEST01-EKSNodeGroup-94BNRKWRV6MP", - "helmChart": "VnfHelmChart01" - } - } - ] - }, - "metadata": { - "createdAt": "2022-06-10T19:48:33Z", - "lastModified": "2022-06-10T19:48:33Z" - } - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/vnflcm/v1/vnf_instances/{vnfInstanceId}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionInstanceInput": { - "type": "structure", - "members": { - "vnfInstanceId": { - "target": "com.amazonaws.tnb#VnfInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network function.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionInstanceMetadata": { - "type": "structure", - "members": { - "createdAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

The metadata of a network function instance.

\n

A network function instance is a function in a function package .

" - } - }, - "com.amazonaws.tnb#GetSolFunctionInstanceOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#VnfInstanceId", - "traits": { - "smithy.api#documentation": "

Network function instance ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#VnfInstanceArn", - "traits": { - "smithy.api#documentation": "

Network function instance ARN.

", - "smithy.api#required": {} - } - }, - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

Network instance ID.

", - "smithy.api#required": {} - } - }, - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

Function package ID.

", - "smithy.api#required": {} - } - }, - "vnfdId": { - "target": "com.amazonaws.tnb#VnfdId", - "traits": { - "smithy.api#documentation": "

Function package descriptor ID.

", - "smithy.api#required": {} - } - }, - "vnfProvider": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network function provider.

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

Network function product name.

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

Function package descriptor version.

" - } - }, - "instantiationState": { - "target": "com.amazonaws.tnb#VnfInstantiationState", - "traits": { - "smithy.api#documentation": "

Network function instantiation state.

", - "smithy.api#required": {} - } - }, - "instantiatedVnfInfo": { - "target": "com.amazonaws.tnb#GetSolVnfInfo" - }, - "metadata": { - "target": "com.amazonaws.tnb#GetSolFunctionInstanceMetadata", - "traits": { - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolFunctionPackageInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolFunctionPackageOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the details of an individual function package, such as the operational state and\n whether the package is in use.

\n

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network..

", - "smithy.api#examples": [ - { - "title": "Describe a function package with correct vnfPkgId", - "input": { - "vnfPkgId": "fp-07aa863e53460a2a6" - }, - "output": { - "id": "fp-07aa863e53460a2a6", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-package/fp-07aa863e53460a2a6", - "onboardingState": "ONBOARDED", - "operationalState": "ENABLED", - "usageState": "IN_USE", - "vnfdId": "eefaac4a-cf5c-4b1f-869e-9d31a9fa6d71", - "vnfProvider": "VNFBuilder", - "vnfProductName": "NRF", - "vnfdVersion": "1.0.0", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z", - "vnfd": { - "overrides": [] - } - } - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolFunctionPackageContentInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolFunctionPackageContentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the contents of a function package.

\n

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

", - "smithy.api#examples": [ - { - "title": "Get the content of a function package", - "input": { - "accept": "application/zip", - "vnfPkgId": "fp-07aa863e53460a2a6" - }, - "output": { - "contentType": "application/zip", - "packageContent": "dGVzdCBjb250ZW50IGhlcmU=" - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageContentInput": { - "type": "structure", - "members": { - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

ID of the function package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "accept": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

The format of the package that you want to download from the function packages.

", - "smithy.api#httpHeader": "Accept", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageContentOutput": { - "type": "structure", - "members": { - "contentType": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

Indicates the media type of the resource.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "packageContent": { - "target": "smithy.api#Blob", - "traits": { - "smithy.api#documentation": "

Contents of the function package.

", - "smithy.api#httpPayload": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageDescriptor": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolFunctionPackageDescriptorInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolFunctionPackageDescriptorOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets a function package descriptor in a function package.

\n

A function package descriptor is a .yaml file in a function package that uses the TOSCA standard to describe how the network function in the function package should run on your network.

\n

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

", - "smithy.api#examples": [ - { - "title": "Get the descriptor of a function package", - "input": { - "accept": "text/plain", - "vnfPkgId": "fp-07aa863e53460a2a6" - }, - "output": { - "contentType": "text/plain", - "vnfd": "dGVzdCBjb250ZW50IGhlcmU=" - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/vnfd" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageDescriptorInput": { - "type": "structure", - "members": { - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

ID of the function package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "accept": { - "target": "com.amazonaws.tnb#DescriptorContentType", - "traits": { - "smithy.api#documentation": "

Indicates which content types, expressed as MIME types, the client is able to\n understand.

", - "smithy.api#httpHeader": "Accept", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageDescriptorOutput": { - "type": "structure", - "members": { - "contentType": { - "target": "com.amazonaws.tnb#DescriptorContentType", - "traits": { - "smithy.api#documentation": "

Indicates the media type of the resource.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "vnfd": { - "target": "smithy.api#Blob", - "traits": { - "smithy.api#documentation": "

Contents of the function package descriptor.

", - "smithy.api#httpPayload": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageInput": { - "type": "structure", - "members": { - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

ID of the function package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageMetadata": { - "type": "structure", - "members": { - "vnfd": { - "target": "com.amazonaws.tnb#FunctionArtifactMeta", - "traits": { - "smithy.api#documentation": "

Metadata related to the function package descriptor of the function package.

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

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata related to the function package.

\n

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

" - } - }, - "com.amazonaws.tnb#GetSolFunctionPackageOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

Function package ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#VnfPkgArn", - "traits": { - "smithy.api#documentation": "

Function package ARN.

", - "smithy.api#required": {} - } - }, - "onboardingState": { - "target": "com.amazonaws.tnb#OnboardingState", - "traits": { - "smithy.api#documentation": "

Function package onboarding state.

", - "smithy.api#required": {} - } - }, - "operationalState": { - "target": "com.amazonaws.tnb#OperationalState", - "traits": { - "smithy.api#documentation": "

Function package operational state.

", - "smithy.api#required": {} - } - }, - "usageState": { - "target": "com.amazonaws.tnb#UsageState", - "traits": { - "smithy.api#documentation": "

Function package usage state.

", - "smithy.api#required": {} - } - }, - "vnfdId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Function package descriptor ID.

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

Network function provider.

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

Network function product name.

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

Function package descriptor version.

" - } - }, - "metadata": { - "target": "com.amazonaws.tnb#GetSolFunctionPackageMetadata" - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolInstantiatedVnfInfo": { - "type": "structure", - "members": { - "vnfState": { - "target": "com.amazonaws.tnb#VnfOperationalState", - "traits": { - "smithy.api#documentation": "

State of the network function.

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

Information about a network function.

\n

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

" - } - }, - "com.amazonaws.tnb#GetSolNetworkInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolNetworkInstanceInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolNetworkInstanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the details of the network instance.

\n

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

", - "smithy.api#examples": [ - { - "title": "Get a Sol Network Instance details", - "input": { - "nsInstanceId": "ni-07aa863e53460a2a6" - }, - "output": { - "id": "ni-07aa863e53460a2a6", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-instance/ni-07aa863e53460a2a6", - "nsInstanceName": "CITY Instance", - "nsInstanceDescription": "Network service for CITY", - "nsdId": "6625a858-2157-4d74-9197-a6ff67d51f3e", - "nsdInfoId": "np-07aa863e53460a2a6", - "nsState": "INSTANTIATED", - "metadata": { - "createdAt": "2022-06-10T19:48:33Z", - "lastModified": "2022-06-10T19:48:33Z" - }, - "lcmOpInfo": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241" - } - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/nslcm/v1/ns_instances/{nsInstanceId}", - "code": 200 - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkInstanceInput": { - "type": "structure", - "members": { - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkInstanceMetadata": { - "type": "structure", - "members": { - "createdAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

The metadata of a network instance.

\n

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

" - } - }, - "com.amazonaws.tnb#GetSolNetworkInstanceOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

Network instance ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsInstanceArn", - "traits": { - "smithy.api#documentation": "

Network instance ARN.

", - "smithy.api#required": {} - } - }, - "nsInstanceName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network instance name.

", - "smithy.api#required": {} - } - }, - "nsInstanceDescription": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network instance description.

", - "smithy.api#required": {} - } - }, - "nsdId": { - "target": "com.amazonaws.tnb#NsdId", - "traits": { - "smithy.api#documentation": "

Network service descriptor ID.

", - "smithy.api#required": {} - } - }, - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

Network service descriptor info ID.

", - "smithy.api#required": {} - } - }, - "nsState": { - "target": "com.amazonaws.tnb#NsState", - "traits": { - "smithy.api#documentation": "

Network instance state.

" - } - }, - "lcmOpInfo": { - "target": "com.amazonaws.tnb#LcmOperationInfo" - }, - "metadata": { - "target": "com.amazonaws.tnb#GetSolNetworkInstanceMetadata", - "traits": { - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkOperation": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolNetworkOperationInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolNetworkOperationOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the details of a network operation, including the tasks involved in the network\n operation and the status of the tasks.

\n

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

", - "smithy.api#examples": [ - { - "title": "Get Sol Network Instantiate operation", - "input": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241" - }, - "output": { - "id": "no-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "operationState": "COMPLETED", - "lcmOperationType": "INSTANTIATE", - "metadata": { - "instantiateMetadata": { - "nsdInfoId": "np-0d0f3e2eae4fc1ac1", - "additionalParamsForNs": { - "cidr_block": "10.0.0.0/16", - "availability_zone": "us-west-2a" - } - }, - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - }, - "tasks": [ - { - "taskName": "HookExecution", - "taskContext": { - "cloudWatchLogsARN": "arn:aws:logs:us-east-1:123456789000:log-group:/aws/codebuild/TestProject:log-stream:a4dc6b0b-2ea3-48c5-bb30-636c4f376b81" - }, - "taskStatus": "IN_PROGRESS", - "taskStartTime": "2022-06-10T19:48:34Z", - "taskEndTime": "2022-06-10T21:48:33Z" - } - ] - } - }, - { - "title": "Get Sol Network Update operation", - "input": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241" - }, - "output": { - "id": "no-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "operationState": "COMPLETED", - "lcmOperationType": "UPDATE", - "updateType": "UPDATE_NS", - "metadata": { - "updateNsMetadata": { - "nsdInfoId": "np-0d0f3e2eae4fc1ac1", - "additionalParamsForNs": { - "cidr_block": "10.0.0.0/16", - "availability_zone": "us-west-2a" - } - }, - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - }, - "tasks": [ - { - "taskName": "HookExecution", - "taskContext": { - "cloudWatchLogsARN": "arn:aws:logs:us-east-1:123456789000:log-group:/aws/codebuild/TestProject:log-stream:a4dc6b0b-2ea3-48c5-bb30-636c4f376b81" - }, - "taskStatus": "IN_PROGRESS", - "taskStartTime": "2022-06-10T19:48:34Z", - "taskEndTime": "2022-06-10T21:48:33Z" - } - ] - } - }, - { - "title": "Get Sol Network Update operation", - "input": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241" - }, - "output": { - "id": "no-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "operationState": "COMPLETED", - "lcmOperationType": "UPDATE", - "updateType": "MODIFY_VNF_INFORMATION", - "metadata": { - "modifyVnfInfoMetadata": { - "vnfInstanceId": "fi-0d5b823eb5c2a9241", - "vnfConfigurableProperties": { - "pcf.port": "8080", - "pcf.pods": "10" - } - }, - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - }, - "tasks": [ - { - "taskName": "HookExecution", - "taskContext": { - "cloudWatchLogsARN": "arn:aws:logs:us-east-1:123456789000:log-group:/aws/codebuild/TestProject:log-stream:a4dc6b0b-2ea3-48c5-bb30-636c4f376b81" - }, - "taskStatus": "IN_PROGRESS", - "taskStartTime": "2022-06-10T19:48:34Z", - "taskEndTime": "2022-06-10T21:48:33Z" - } - ] - } - }, - { - "title": "Get Sol Network Instantiate operation which has a failure", - "input": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241" - }, - "output": { - "id": "no-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "operationState": "FAILED", - "lcmOperationType": "INSTANTIATE", - "error": { - "title": "InternalServerException", - "detail": "The service encountered an error. Sorry for the inconvenience." - }, - "metadata": { - "createdAt": "2022-06-10T19:48:33Z", - "lastModified": "2022-06-10T19:48:33Z" - }, - "tasks": [ - { - "taskName": "HookExecution", - "taskContext": { - "cloudWatchLogsARN": "arn:aws:logs:us-east-1:123456789000:log-group:/aws/codebuild/TestProject:log-stream:a4dc6b0b-2ea3-48c5-bb30-636c4f376b81" - }, - "taskStatus": "IN_PROGRESS", - "taskStartTime": "2022-06-10T19:48:34Z", - "taskEndTime": "2022-06-10T21:48:33Z" - }, - { - "taskName": "HookExecution", - "taskErrorDetails": { - "cause": "InternalServerException", - "details": "The service encountered an error. Sorry for the inconvenience." - }, - "taskStatus": "ERROR", - "taskStartTime": "2022-06-10T19:48:34Z", - "taskEndTime": "2022-06-10T21:48:33Z" - } - ] - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkOperationInput": { - "type": "structure", - "members": { - "nsLcmOpOccId": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

The identifier of the network operation.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkOperationMetadata": { - "type": "structure", - "members": { - "updateNsMetadata": { - "target": "com.amazonaws.tnb#UpdateNsMetadata", - "traits": { - "smithy.api#documentation": "

Metadata related to the network operation occurrence for network instance updates.\n This is populated only if the lcmOperationType is UPDATE and the\n updateType is UPDATE_NS.

" - } - }, - "modifyVnfInfoMetadata": { - "target": "com.amazonaws.tnb#ModifyVnfInfoMetadata", - "traits": { - "smithy.api#documentation": "

Metadata related to the network operation occurrence for network function updates in a network instance.\n This is populated only if the lcmOperationType is UPDATE and the\n updateType is MODIFY_VNF_INFORMATION.

" - } - }, - "instantiateMetadata": { - "target": "com.amazonaws.tnb#InstantiateMetadata", - "traits": { - "smithy.api#documentation": "

Metadata related to the network operation occurrence for network instantiation.\n This is populated only if the lcmOperationType is INSTANTIATE.

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

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata related to a network operation occurrence.

\n

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

" - } - }, - "com.amazonaws.tnb#GetSolNetworkOperationOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

ID of this network operation occurrence.

" - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsLcmOpOccArn", - "traits": { - "smithy.api#documentation": "

Network operation ARN.

", - "smithy.api#required": {} - } - }, - "operationState": { - "target": "com.amazonaws.tnb#NsLcmOperationState", - "traits": { - "smithy.api#documentation": "

The state of the network operation.

" - } - }, - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network operation instance.

" - } - }, - "lcmOperationType": { - "target": "com.amazonaws.tnb#LcmOperationType", - "traits": { - "smithy.api#documentation": "

Type of the operation represented by this occurrence.

" - } - }, - "updateType": { - "target": "com.amazonaws.tnb#UpdateSolNetworkType", - "traits": { - "smithy.api#documentation": "

Type of the update. Only present if the network operation\n lcmOperationType is UPDATE.

" - } - }, - "error": { - "target": "com.amazonaws.tnb#ProblemDetails", - "traits": { - "smithy.api#documentation": "

Error related to this specific network operation occurrence.

" - } - }, - "metadata": { - "target": "com.amazonaws.tnb#GetSolNetworkOperationMetadata", - "traits": { - "smithy.api#documentation": "

Metadata of this network operation occurrence.

" - } - }, - "tasks": { - "target": "com.amazonaws.tnb#GetSolNetworkOperationTasksList", - "traits": { - "smithy.api#documentation": "

All tasks associated with this operation occurrence.

" - } - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkOperationTaskDetails": { - "type": "structure", - "members": { - "taskName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Task name.

" - } - }, - "taskContext": { - "target": "com.amazonaws.tnb#StringMap", - "traits": { - "smithy.api#documentation": "

Context for the network operation task.

" - } - }, - "taskErrorDetails": { - "target": "com.amazonaws.tnb#ErrorInfo", - "traits": { - "smithy.api#documentation": "

Task error details.

" - } - }, - "taskStatus": { - "target": "com.amazonaws.tnb#TaskStatus", - "traits": { - "smithy.api#documentation": "

Task status.

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

Task start time.

", - "smithy.api#timestampFormat": "date-time" - } - }, - "taskEndTime": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

Task end time.

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

Gets the details of a network operation.

\n

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

" - } - }, - "com.amazonaws.tnb#GetSolNetworkOperationTasksList": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#GetSolNetworkOperationTaskDetails" - } - }, - "com.amazonaws.tnb#GetSolNetworkPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolNetworkPackageInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolNetworkPackageOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the details of a network package.

\n

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

", - "smithy.api#examples": [ - { - "title": "Describe an individual Sol network package", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241" - }, - "output": { - "id": "np-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", - "nsdId": "be1abe66-1fcc-11ec-9621-0242ac130002", - "nsdName": "Sample-City", - "nsdVersion": "1.0", - "vnfPkgIds": [ - "fp-0b627c4a170a97f79", - "fp-8c253b2e898d23f92" - ], - "nsdOnboardingState": "ONBOARDED", - "nsdOperationalState": "ENABLED", - "nsdUsageState": "IN_USE", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z", - "nsd": { - "overrides": [ - { - "name": "cidr_block", - "defaultValue": "10.0.0.0/24" - }, - { - "name": "some_vnf.vnf_prop" - } - ] - } - } - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolNetworkPackageContentInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolNetworkPackageContentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the contents of a network package.

\n

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

", - "smithy.api#examples": [ - { - "title": "Get a network package Content", - "input": { - "accept": "application/zip", - "nsdInfoId": "np-0d5b823eb5c2a9241" - }, - "output": { - "contentType": "application/zip", - "nsdContent": "dGVzdCBjb250ZW50IGhlcmU=" - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageContentInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor in the network package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "accept": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

The format of the package you want to download from the network package.

", - "smithy.api#httpHeader": "Accept", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageContentOutput": { - "type": "structure", - "members": { - "contentType": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

Indicates the media type of the resource.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "nsdContent": { - "target": "smithy.api#Blob", - "traits": { - "smithy.api#documentation": "

Content of the network service descriptor in the network package.

", - "smithy.api#httpPayload": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageDescriptor": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#GetSolNetworkPackageDescriptorInput" - }, - "output": { - "target": "com.amazonaws.tnb#GetSolNetworkPackageDescriptorOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Gets the content of the network service descriptor.

\n

A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.

", - "smithy.api#examples": [ - { - "title": "Get the descriptor of a Network Pacakge", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241" - }, - "output": { - "contentType": "text/plain", - "nsd": "dGVzdCBjb250ZW50IGhlcmU=" - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageDescriptorInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor in the network package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageDescriptorOutput": { - "type": "structure", - "members": { - "contentType": { - "target": "com.amazonaws.tnb#DescriptorContentType", - "traits": { - "smithy.api#documentation": "

Indicates the media type of the resource.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "nsd": { - "target": "smithy.api#Blob", - "traits": { - "smithy.api#documentation": "

Contents of the network service descriptor in the network package.

", - "smithy.api#httpPayload": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor in the network package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageMetadata": { - "type": "structure", - "members": { - "nsd": { - "target": "com.amazonaws.tnb#NetworkArtifactMeta", - "traits": { - "smithy.api#documentation": "

Metadata related to the onboarded network service descriptor in the network\n package.

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

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata associated with a network package.

\n

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

" - } - }, - "com.amazonaws.tnb#GetSolNetworkPackageOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

Network package ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsdInfoArn", - "traits": { - "smithy.api#documentation": "

Network package ARN.

", - "smithy.api#required": {} - } - }, - "nsdOnboardingState": { - "target": "com.amazonaws.tnb#NsdOnboardingState", - "traits": { - "smithy.api#documentation": "

Network service descriptor onboarding state.

", - "smithy.api#required": {} - } - }, - "nsdOperationalState": { - "target": "com.amazonaws.tnb#NsdOperationalState", - "traits": { - "smithy.api#documentation": "

Network service descriptor operational state.

", - "smithy.api#required": {} - } - }, - "nsdUsageState": { - "target": "com.amazonaws.tnb#NsdUsageState", - "traits": { - "smithy.api#documentation": "

Network service descriptor usage state.

", - "smithy.api#required": {} - } - }, - "nsdId": { - "target": "com.amazonaws.tnb#NsdId", - "traits": { - "smithy.api#documentation": "

Network service descriptor ID.

", - "smithy.api#required": {} - } - }, - "nsdName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network service descriptor name.

", - "smithy.api#required": {} - } - }, - "nsdVersion": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network service descriptor version.

", - "smithy.api#required": {} - } - }, - "vnfPkgIds": { - "target": "com.amazonaws.tnb#VnfPkgIdList", - "traits": { - "smithy.api#documentation": "

Identifies the function package for the function package descriptor referenced by the\n onboarded network package.

", - "smithy.api#required": {} - } - }, - "metadata": { - "target": "com.amazonaws.tnb#GetSolNetworkPackageMetadata", - "traits": { - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#GetSolVnfInfo": { - "type": "structure", - "members": { - "vnfState": { - "target": "com.amazonaws.tnb#VnfOperationalState", - "traits": { - "smithy.api#documentation": "

State of the network function instance.

" - } - }, - "vnfcResourceInfo": { - "target": "com.amazonaws.tnb#GetSolVnfcResourceInfoList", - "traits": { - "smithy.api#documentation": "

Compute info used by the network function instance.

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

Information about the network function.

\n

A network function instance is a function in a function package .

" - } - }, - "com.amazonaws.tnb#GetSolVnfcResourceInfo": { - "type": "structure", - "members": { - "metadata": { - "target": "com.amazonaws.tnb#GetSolVnfcResourceInfoMetadata", - "traits": { - "smithy.api#documentation": "

The metadata of the network function compute.

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

Details of resource associated with a network function.

\n

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

" - } - }, - "com.amazonaws.tnb#GetSolVnfcResourceInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#GetSolVnfcResourceInfo" - } - }, - "com.amazonaws.tnb#GetSolVnfcResourceInfoMetadata": { - "type": "structure", - "members": { - "nodeGroup": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Information about the node group.

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

Information about the cluster.

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

Information about the helm chart.

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

The metadata of a network function.

\n

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

" - } - }, - "com.amazonaws.tnb#InstantiateMetadata": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

The network service descriptor used for instantiating the network instance.

", - "smithy.api#required": {} - } - }, - "additionalParamsForNs": { - "target": "smithy.api#Document", - "traits": { - "smithy.api#documentation": "

The configurable properties used during instantiation.

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

Metadata related to the configuration properties used during instantiation of the network instance.

" - } - }, - "com.amazonaws.tnb#InstantiateSolNetworkInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#InstantiateSolNetworkInstanceInput" - }, - "output": { - "target": "com.amazonaws.tnb#InstantiateSolNetworkInstanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Instantiates a network instance.

\n

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

\n

Before you can instantiate a network instance, you have to create a network instance.\n For more information, see CreateSolNetworkInstance.

", - "smithy.api#examples": [ - { - "title": "Instantiate a Sol Network Instance", - "input": { - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "tags": { - "Name": "Resource" - } - }, - "output": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241", - "tags": { - "Name": "Resource" - } - } - }, - { - "title": "Instantiate a Sol Network Instance with Overrides", - "input": { - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "additionalParamsForNs": { - "cidr_block": "10.0.0.0/16", - "availability_zone": "us-west-2a" - } - }, - "output": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241" - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/sol/nslcm/v1/ns_instances/{nsInstanceId}/instantiate", - "code": 201 - } - } - }, - "com.amazonaws.tnb#InstantiateSolNetworkInstanceInput": { - "type": "structure", - "members": { - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dryRun": { - "target": "smithy.api#Boolean", - "traits": { - "smithy.api#documentation": "

A check for whether you have the required permissions for the action without actually making the request \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.

", - "smithy.api#httpQuery": "dry_run" - } - }, - "additionalParamsForNs": { - "target": "smithy.api#Document", - "traits": { - "smithy.api#documentation": "

Provides values for the configurable properties.

" - } - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#InstantiateSolNetworkInstanceOutput": { - "type": "structure", - "members": { - "nsLcmOpOccId": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

The identifier of the network operation.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Unexpected error occurred. Problem on the server.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.tnb#LcmOperationInfo": { - "type": "structure", - "members": { - "nsLcmOpOccId": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

The identifier of the network operation.

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

Lifecycle management operation details on the network instance.

\n

Lifecycle management operations are deploy, update, or delete operations.

" - } - }, - "com.amazonaws.tnb#LcmOperationType": { - "type": "enum", - "members": { - "INSTANTIATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSTANTIATE" - } - }, - "UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE" - } - }, - "TERMINATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERMINATE" - } - } - } - }, - "com.amazonaws.tnb#ListSolFunctionInstanceInfo": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#VnfInstanceId", - "traits": { - "smithy.api#documentation": "

Network function instance ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#VnfInstanceArn", - "traits": { - "smithy.api#documentation": "

Network function instance ARN.

", - "smithy.api#required": {} - } - }, - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

Network instance ID.

", - "smithy.api#required": {} - } - }, - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

Function package ID.

", - "smithy.api#required": {} - } - }, - "vnfPkgName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Function package name.

" - } - }, - "instantiationState": { - "target": "com.amazonaws.tnb#VnfInstantiationState", - "traits": { - "smithy.api#documentation": "

Network function instance instantiation state.

", - "smithy.api#required": {} - } - }, - "instantiatedVnfInfo": { - "target": "com.amazonaws.tnb#GetSolInstantiatedVnfInfo" - }, - "metadata": { - "target": "com.amazonaws.tnb#ListSolFunctionInstanceMetadata", - "traits": { - "smithy.api#documentation": "

Network function instance metadata.

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

Lists information about a network function instance.

\n

A network function instance is a function in a function package .

" - } - }, - "com.amazonaws.tnb#ListSolFunctionInstanceMetadata": { - "type": "structure", - "members": { - "createdAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

When the network function instance was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

When the network function instance was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Lists network function instance metadata.

\n

A network function instance is a function in a function package .

" - } - }, - "com.amazonaws.tnb#ListSolFunctionInstanceResources": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#ListSolFunctionInstanceInfo" - } - }, - "com.amazonaws.tnb#ListSolFunctionInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ListSolFunctionInstancesInput" - }, - "output": { - "target": "com.amazonaws.tnb#ListSolFunctionInstancesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists network function instances.

\n

A network function instance is a function in a function package .

", - "smithy.api#examples": [ - { - "title": "List Sol Function instances", - "input": {}, - "output": { - "functionInstances": [ - { - "id": "fi-b9439c34c1ef86c54", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-instance/fi-b9439c34c1ef86c54", - "nsInstanceId": "ni-07aa863e53460a2a6", - "vnfPkgId": "fp-07aa863e53460a2a6", - "instantiationState": "INSTANTIATED", - "instantiatedVnfInfo": { - "vnfState": "STARTED" - }, - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - }, - { - "id": "fi-b9439c34c1efabcd1", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-instance/fi-b9439c34c1efabcd1", - "nsInstanceId": "ni-07aa863e53460a123", - "vnfPkgId": "fp-146a863e53460a2a6", - "instantiationState": "INSTANTIATED", - "instantiatedVnfInfo": { - "vnfState": "STOPPED" - }, - "metadata": { - "createdAt": "2022-06-10T11:48:34Z", - "lastModified": "2023-06-28T21:48:33Z" - } - } - ] - } - }, - { - "title": "List Sol Function Instances with nextToken and maxResults", - "input": { - "maxResults": 25, - "nextToken": "" - }, - "output": { - "functionInstances": [ - { - "id": "fi-b9439c34c1ef86c54", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-instance/fi-b9439c34c1ef86c54", - "nsInstanceId": "ni-07aa863e53460a2a6", - "vnfPkgId": "fp-07aa863e53460a2a6", - "instantiationState": "INSTANTIATED", - "instantiatedVnfInfo": { - "vnfState": "STARTED" - }, - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/vnflcm/v1/vnf_instances" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "functionInstances" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#ListSolFunctionInstancesInput": { - "type": "structure", - "members": { - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response.

", - "smithy.api#httpQuery": "max_results", - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextpage_opaque_marker" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#ListSolFunctionInstancesOutput": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" - } - }, - "functionInstances": { - "target": "com.amazonaws.tnb#ListSolFunctionInstanceResources", - "traits": { - "smithy.api#documentation": "

Network function instances.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ListSolFunctionPackageInfo": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

ID of the function package.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#VnfPkgArn", - "traits": { - "smithy.api#documentation": "

Function package ARN.

", - "smithy.api#required": {} - } - }, - "onboardingState": { - "target": "com.amazonaws.tnb#OnboardingState", - "traits": { - "smithy.api#documentation": "

Onboarding state of the function package.

", - "smithy.api#required": {} - } - }, - "operationalState": { - "target": "com.amazonaws.tnb#OperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the function package.

", - "smithy.api#required": {} - } - }, - "usageState": { - "target": "com.amazonaws.tnb#UsageState", - "traits": { - "smithy.api#documentation": "

Usage state of the function package.

", - "smithy.api#required": {} - } - }, - "vnfdId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Identifies the function package and the function package descriptor.

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

Provider of the function package and the function package descriptor.

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

The product name for the network function.

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

Identifies the version of the function package descriptor.

" - } - }, - "metadata": { - "target": "com.amazonaws.tnb#ListSolFunctionPackageMetadata", - "traits": { - "smithy.api#documentation": "

The metadata of the function package.

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

Information about a function package.

\n

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

" - } - }, - "com.amazonaws.tnb#ListSolFunctionPackageMetadata": { - "type": "structure", - "members": { - "createdAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Details for the function package metadata.

\n

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

" - } - }, - "com.amazonaws.tnb#ListSolFunctionPackageResources": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#ListSolFunctionPackageInfo" - } - }, - "com.amazonaws.tnb#ListSolFunctionPackages": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ListSolFunctionPackagesInput" - }, - "output": { - "target": "com.amazonaws.tnb#ListSolFunctionPackagesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists information about function packages.

\n

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

", - "smithy.api#examples": [ - { - "title": "List information about multiple function packages without PaginationToken", - "input": { - "maxResults": 25, - "nextToken": "" - }, - "output": { - "nextToken": "ug2E9SheCpyAmeLItmHF99a8GNI6yAHxXIvgBkdiA2ixKvqdhYpNBLWHDl6vGnWt7Y4CB6m1Dkz86gSwcDouMO1pSrN%2BlGY2kbNtfTeMgnuB6bmwP/UU12r7MkHQyPCWMYG8OuCXkDBOYeX8qjRDTJ5vxAyrwtynaB6XDNDZA2DscCjcD7kpNzf3xlPRCwd6", - "functionPackages": [ - { - "id": "fp-07aa863e53460a2a6", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-package/fp-07aa863e53460a2a6", - "onboardingState": "ONBOARDED", - "operationalState": "ENABLED", - "usageState": "IN_USE", - "vnfdId": "arn:aws:tnb:123456789000:vnf/nrf", - "vnfProvider": "VNFBuilder", - "vnfProductName": "NRF", - "vnfdVersion": "1.0", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - }, - { - "title": "List information about multiple function packages with PaginationToken", - "input": { - "maxResults": 25, - "nextToken": "ug2E9SheCpyAmeLItmHF99a8GNI6yAHxXIvgBkdiA2ixKvqdhYpNBLWHDl6vGnWt7Y4CB6m1Dkz86gSwcDouMO1pSrN%2BlGY2kbNtfTeMgnuB6bmwP/UU12r7MkHQyPCWMYG8OuCXkDBOYeX8qjRDTJ5vxAyrwtynaB6XDNDZA2DscCjcD7kpNzf3xlPRCwd6" - }, - "output": { - "nextToken": "ug2E9SheCpyAmeLItmHF98uvZTosFhZ1wyglENkc3UZ12UuRLmtGtojRynFjRR5zW%2FycBL6QX8AU%2B1IRWL%2BVjNNL7KBiaD87KM9WcUMQzryLtOazGHexujJncJJ0YGsxSLSrmPGx7dM1EoNKX8oxYA%3D%3D", - "functionPackages": [ - { - "id": "fp-07aa863e53460a2a6", - "arn": "arn:aws:tnb:us-west-2:123456789000:function-package/fp-07aa863e53460a2a6", - "onboardingState": "ONBOARDED", - "operationalState": "ENABLED", - "usageState": "IN_USE", - "vnfdId": "arn:aws:tnb:123456789000:vnf/nrf", - "vnfProvider": "VNFBuilder", - "vnfProductName": "NRF", - "vnfdVersion": "1.0", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - }, - { - "title": "No more function packages to return", - "input": { - "maxResults": 25, - "nextToken": "ug2E9SheCpyAmeLItmHF98uvZTosFhZ1wyglENkc3UZ12UuRLmtGtojRynFjRR5zW%2FycBL6QX8AU%2B1IRWL%2BVjNNL7KBiaD87KM9WcUMQzryLtOazGHexujJncJJ0YGsxSLSrmPGx7dM1EoNKX8oxYA%3D%3D" - }, - "output": { - "functionPackages": [] - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/vnfpkgm/v1/vnf_packages" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "functionPackages" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#ListSolFunctionPackagesInput": { - "type": "structure", - "members": { - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response.

", - "smithy.api#httpQuery": "max_results", - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextpage_opaque_marker" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#ListSolFunctionPackagesOutput": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" - } - }, - "functionPackages": { - "target": "com.amazonaws.tnb#ListSolFunctionPackageResources", - "traits": { - "smithy.api#documentation": "

Function packages. A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkInstanceInfo": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network instance.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsInstanceArn", - "traits": { - "smithy.api#documentation": "

Network instance ARN.

", - "smithy.api#required": {} - } - }, - "nsInstanceName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Human-readable name of the network instance.

", - "smithy.api#required": {} - } - }, - "nsInstanceDescription": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Human-readable description of the network instance.

", - "smithy.api#required": {} - } - }, - "nsdId": { - "target": "com.amazonaws.tnb#NsdId", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "nsState": { - "target": "com.amazonaws.tnb#NsState", - "traits": { - "smithy.api#documentation": "

The state of the network instance.

", - "smithy.api#required": {} - } - }, - "metadata": { - "target": "com.amazonaws.tnb#ListSolNetworkInstanceMetadata", - "traits": { - "smithy.api#documentation": "

The metadata of the network instance.

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

Info about the specific network instance.

\n

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

" - } - }, - "com.amazonaws.tnb#ListSolNetworkInstanceMetadata": { - "type": "structure", - "members": { - "createdAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata details for a network instance.

\n

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

" - } - }, - "com.amazonaws.tnb#ListSolNetworkInstanceResources": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#ListSolNetworkInstanceInfo" - } - }, - "com.amazonaws.tnb#ListSolNetworkInstances": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ListSolNetworkInstancesInput" - }, - "output": { - "target": "com.amazonaws.tnb#ListSolNetworkInstancesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists your network instances.

\n

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

", - "smithy.api#examples": [ - { - "title": "List Sol Network Instantiate instances", - "input": {}, - "output": { - "networkInstances": [ - { - "id": "ni-07aa863e53460a2a6", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-instance/ni-07aa863e53460a2a6", - "nsInstanceName": "CITY Instance", - "nsInstanceDescription": "Network service for CITY", - "nsdId": "e851fd14-abe3-4535-85e6-6060636fd519", - "nsdInfoId": "np-0d5b823eb5c2a9241", - "nsState": "INSTANTIATED", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - }, - { - "title": "List Sol Network Instances with nextToken and maxResults", - "input": { - "maxResults": 25, - "nextToken": "" - }, - "output": { - "networkInstances": [ - { - "id": "ni-07aa863e53460a2a6", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-instance/ni-07aa863e53460a2a6", - "nsInstanceName": "CITY Instance", - "nsInstanceDescription": "Network service for CITY", - "nsdId": "e851fd14-abe3-4535-85e6-6060636fd519", - "nsdInfoId": "np-0d5b823eb5c2a9241", - "nsState": "INSTANTIATED", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/nslcm/v1/ns_instances" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "networkInstances" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkInstancesInput": { - "type": "structure", - "members": { - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response.

", - "smithy.api#httpQuery": "max_results", - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextpage_opaque_marker" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkInstancesOutput": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" - } - }, - "networkInstances": { - "target": "com.amazonaws.tnb#ListSolNetworkInstanceResources", - "traits": { - "smithy.api#documentation": "

Lists network instances.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkOperations": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ListSolNetworkOperationsInput" - }, - "output": { - "target": "com.amazonaws.tnb#ListSolNetworkOperationsOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists details for a network operation, including when the operation started and the\n status of the operation.

\n

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

", - "smithy.api#examples": [ - { - "title": "List Sol Network Instantiate operations", - "input": {}, - "output": { - "networkOperations": [ - { - "id": "no-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "operationState": "COMPLETED", - "lcmOperationType": "INSTANTIATE", - "metadata": { - "nsdInfoId": "np-0d0f3e2eae4fc1ac1", - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - }, - { - "title": "List Sol Network Instantiate operations with nextToken and maxResults", - "input": { - "maxResults": 25, - "nextToken": "" - }, - "output": { - "networkOperations": [ - { - "id": "no-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "operationState": "COMPLETED", - "lcmOperationType": "INSTANTIATE", - "error": { - "title": "InsufficientInstanceCapacity", - "detail": "An error occurred (InsufficientInstanceCapacity) when calling the RunInstances operation (reached max retries: 4). We currently do not have sufficient capacity in the Availability Zone you requested" - }, - "metadata": { - "nsdInfoId": "np-0d0f3e2eae4fc1ac1", - "createdAt": "2022-06-10T19:48:33Z", - "lastModified": "2022-06-10T19:48:33Z" - } - } - ] - } - }, - { - "title": "List Sol Network Update operations", - "input": { - "nsInstanceId": "ni-0d5b823eb5c2a9241" - }, - "output": { - "networkOperations": [ - { - "id": "no-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "operationState": "COMPLETED", - "lcmOperationType": "UPDATE", - "updateType": "MODIFY_VNF_INFORMATION", - "metadata": { - "vnfInstanceId": "fi-0d5b823eb5c2a9241", - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - }, - { - "title": "List Sol Network Update operations", - "input": { - "nsInstanceId": "ni-0d5b823eb5c2a9241" - }, - "output": { - "networkOperations": [ - { - "id": "no-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-operation/no-0d5b823eb5c2a9241", - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "operationState": "COMPLETED", - "lcmOperationType": "UPDATE", - "updateType": "UPDATE_NS", - "metadata": { - "nsdInfoId": "np-0d0f3e2eae4fc1ac1", - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/nslcm/v1/ns_lcm_op_occs" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "networkOperations" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkOperationsInfo": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

ID of this network operation.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsLcmOpOccArn", - "traits": { - "smithy.api#documentation": "

Network operation ARN.

", - "smithy.api#required": {} - } - }, - "operationState": { - "target": "com.amazonaws.tnb#NsLcmOperationState", - "traits": { - "smithy.api#documentation": "

The state of the network operation.

", - "smithy.api#required": {} - } - }, - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network instance related to this operation.

", - "smithy.api#required": {} - } - }, - "lcmOperationType": { - "target": "com.amazonaws.tnb#LcmOperationType", - "traits": { - "smithy.api#documentation": "

Type of lifecycle management network operation.

", - "smithy.api#required": {} - } - }, - "updateType": { - "target": "com.amazonaws.tnb#UpdateSolNetworkType", - "traits": { - "smithy.api#documentation": "

Type of the update. Only present if the network operation lcmOperationType is UPDATE.

" - } - }, - "error": { - "target": "com.amazonaws.tnb#ProblemDetails", - "traits": { - "smithy.api#documentation": "

Error related to this specific network operation.

" - } - }, - "metadata": { - "target": "com.amazonaws.tnb#ListSolNetworkOperationsMetadata", - "traits": { - "smithy.api#documentation": "

Metadata related to this network operation.

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

Information parameters for a network operation.

" - } - }, - "com.amazonaws.tnb#ListSolNetworkOperationsInput": { - "type": "structure", - "members": { - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

Network instance id filter, to retrieve network operations associated to a network instance.

", - "smithy.api#httpQuery": "nsInstanceId" - } - }, - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response.

", - "smithy.api#httpQuery": "max_results", - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextpage_opaque_marker" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkOperationsMetadata": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

The network service descriptor id used for the operation.

\n

Only present if the updateType is UPDATE_NS.

" - } - }, - "vnfInstanceId": { - "target": "com.amazonaws.tnb#VnfInstanceId", - "traits": { - "smithy.api#documentation": "

The network function id used for the operation.

\n

Only present if the updateType is MODIFY_VNF_INFO.

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

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata related to a network operation.

\n

A network operation is any operation that is done to your network, such as network instance instantiation or termination.

" - } - }, - "com.amazonaws.tnb#ListSolNetworkOperationsOutput": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" - } - }, - "networkOperations": { - "target": "com.amazonaws.tnb#ListSolNetworkOperationsResources", - "traits": { - "smithy.api#documentation": "

Lists network operation occurrences. Lifecycle management operations are deploy, update, or delete operations.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkOperationsResources": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#ListSolNetworkOperationsInfo" - } - }, - "com.amazonaws.tnb#ListSolNetworkPackageInfo": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the individual network package.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsdInfoArn", - "traits": { - "smithy.api#documentation": "

Network package ARN.

", - "smithy.api#required": {} - } - }, - "nsdOnboardingState": { - "target": "com.amazonaws.tnb#NsdOnboardingState", - "traits": { - "smithy.api#documentation": "

Onboarding state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "nsdOperationalState": { - "target": "com.amazonaws.tnb#NsdOperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "nsdUsageState": { - "target": "com.amazonaws.tnb#NsdUsageState", - "traits": { - "smithy.api#documentation": "

Usage state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - }, - "nsdId": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor on which the network package is based.

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

Name of the onboarded network service descriptor in the network package.

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

Version of the onboarded network service descriptor in the network package.

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

Designer of the onboarded network service descriptor in the network package.

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

Identifies a network service descriptor in a version independent manner.

" - } - }, - "vnfPkgIds": { - "target": "com.amazonaws.tnb#VnfPkgIdList", - "traits": { - "smithy.api#documentation": "

Identifies the function package for the function package descriptor referenced by the\n onboarded network package.

" - } - }, - "metadata": { - "target": "com.amazonaws.tnb#ListSolNetworkPackageMetadata", - "traits": { - "smithy.api#documentation": "

The metadata of the network package.

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

Details of a network package.

\n

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

" - } - }, - "com.amazonaws.tnb#ListSolNetworkPackageMetadata": { - "type": "structure", - "members": { - "createdAt": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was created.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - }, - "lastModified": { - "target": "smithy.api#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that the resource was last modified.

", - "smithy.api#required": {}, - "smithy.api#timestampFormat": "date-time" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata related to a network package.

\n

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

" - } - }, - "com.amazonaws.tnb#ListSolNetworkPackageResources": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#ListSolNetworkPackageInfo" - } - }, - "com.amazonaws.tnb#ListSolNetworkPackages": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ListSolNetworkPackagesInput" - }, - "output": { - "target": "com.amazonaws.tnb#ListSolNetworkPackagesOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists network packages.

\n

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

", - "smithy.api#examples": [ - { - "title": "List information about multiple network packages without PaginationToken", - "input": { - "maxResults": 25, - "nextToken": "" - }, - "output": { - "nextToken": "ug2E9SheCpyAmeLItmHF99a8GNI6yAHxXIvgBkdiA2ixKvqdhYpNBLWHDl6vGnWt7Y4CB6m1Dkz86gSwcDouMO1pSrN%2BlGY2kbNtfTeMgnuB6bmwP/UU12r7MkHQyPCWMYG8OuCXkDBOYeX8qjRDTJ5vxAyrwtynaB6XDNDZA2DscCjcD7kpNzf3xlPRCwd6", - "networkPackages": [ - { - "id": "np-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", - "nsdId": "be1abe66-1fcc-11ec-9621-0242ac130002", - "nsdName": "Sample-City", - "nsdVersion": "1.0", - "nsdDesigner": "Sample", - "nsdInvariantId": "SAMPLE_CITY", - "vnfPkgIds": [ - "fp-0b627c4a170a97f79", - "fp-09a2ba09fad0212cd" - ], - "nsdOnboardingState": "ONBOARDED", - "nsdOperationalState": "ENABLED", - "nsdUsageState": "IN_USE", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - }, - { - "id": "np-0d5b823eb5c2a9789", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9789", - "nsdOnboardingState": "CREATED", - "nsdOperationalState": "DISABLED", - "nsdUsageState": "NOT_IN_USE", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - }, - { - "title": "List information about multiple network packages with PaginationToken", - "input": { - "maxResults": 25, - "nextToken": "ug2E9SheCpyAmeLItmHF95t1rBBsFyzy5hsuauDTqaukll3AGHaTz%2B4utHS3OMuMcyKW6Hmk25aB6wtV%2BFxCx9Adw5fDSq9D8lVa6sr0Sq0BF7Fj0mYegd0a/XiFP4j/58ZIrtRl0M3Z55Z/wTqwIietXJVfFX84ZnIMjiEiFb3KIIdrKS8vSgMZ18t3Gj5p" - }, - "output": { - "nextToken": "ug2E9SheCpyAmeLItmHF93AYTN36C2xOijk0IW9FbkywwkM3QphGA%2BMbsKhEhOl3nacLxMMiBL9WOhOdo/ZCXfmS2/tHpzuWjvSODvivIJONDw3bUxYqjsT2w/lDWekKm9cRGhLaK6kCr1XBvm3USj/r6dBDL3gHYrwfmEGL7MRffCgc2IqYOL6O2Mhvbn89", - "networkPackages": [ - { - "id": "np-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", - "nsdId": "be1abe66-1fcc-11ec-9621-0242ac130002", - "nsdName": "Sample-City", - "nsdVersion": "1.0", - "nsdDesigner": "Sample", - "nsdInvariantId": "SAMPLE_CITY", - "vnfPkgIds": [ - "fp-0b627c4a170a97f79", - "fp-09a2ba09fad0212cd" - ], - "nsdOnboardingState": "ONBOARDED", - "nsdOperationalState": "ENABLED", - "nsdUsageState": "IN_USE", - "metadata": { - "createdAt": "2022-06-10T19:48:34Z", - "lastModified": "2022-06-10T21:48:33Z" - } - } - ] - } - }, - { - "title": "No more network packages to return", - "input": {}, - "output": { - "networkPackages": [] - } - } - ], - "smithy.api#http": { - "method": "GET", - "uri": "/sol/nsd/v1/ns_descriptors" - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults", - "items": "networkPackages" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkPackagesInput": { - "type": "structure", - "members": { - "maxResults": { - "target": "smithy.api#Integer", - "traits": { - "smithy.api#documentation": "

The maximum number of results to include in the response.

", - "smithy.api#httpQuery": "max_results", - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token for the next page of results.

", - "smithy.api#httpQuery": "nextpage_opaque_marker" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#ListSolNetworkPackagesOutput": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.tnb#PaginationToken", - "traits": { - "smithy.api#documentation": "

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" - } - }, - "networkPackages": { - "target": "com.amazonaws.tnb#ListSolNetworkPackageResources", - "traits": { - "smithy.api#documentation": "

Network packages. A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ListTagsForResourceInput" - }, - "output": { - "target": "com.amazonaws.tnb#ListTagsForResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists tags for AWS TNB resources.

", - "smithy.api#http": { - "uri": "/tags/{resourceArn}", - "method": "GET" - }, - "smithy.api#readonly": {} - } - }, - "com.amazonaws.tnb#ListTagsForResourceInput": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.tnb#TNBResourceArn", - "traits": { - "smithy.api#documentation": "

Resource ARN.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#ListTagsForResourceOutput": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ModifyVnfInfoMetadata": { - "type": "structure", - "members": { - "vnfInstanceId": { - "target": "com.amazonaws.tnb#VnfInstanceId", - "traits": { - "smithy.api#documentation": "

The network function instance that was updated in the network instance.

", - "smithy.api#required": {} - } - }, - "vnfConfigurableProperties": { - "target": "smithy.api#Document", - "traits": { - "smithy.api#documentation": "

The configurable properties used during update of the network function instance.

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

Metadata related to the configuration properties used during update of a specific\n network function in a network instance.

" - } - }, - "com.amazonaws.tnb#NetworkArtifactMeta": { - "type": "structure", - "members": { - "overrides": { - "target": "com.amazonaws.tnb#OverrideList", - "traits": { - "smithy.api#documentation": "

Lists network package overrides.

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

Metadata for network package artifacts.

\n

Artifacts are the contents of the package descriptor file and the state of the package.

" - } - }, - "com.amazonaws.tnb#NsInstanceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(network-instance/ni-[a-f0-9]{17})$" - } - }, - "com.amazonaws.tnb#NsInstanceId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^ni-[a-f0-9]{17}$" - } - }, - "com.amazonaws.tnb#NsLcmOpOccArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(network-operation/no-[a-f0-9]{17})$" - } - }, - "com.amazonaws.tnb#NsLcmOpOccId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^no-[a-f0-9]{17}$" - } - }, - "com.amazonaws.tnb#NsLcmOperationState": { - "type": "enum", - "members": { - "PROCESSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROCESSING" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "CANCELLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLING" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - } - } - }, - "com.amazonaws.tnb#NsState": { - "type": "enum", - "members": { - "INSTANTIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSTANTIATED" - } - }, - "NOT_INSTANTIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_INSTANTIATED" - } - }, - "UPDATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATED" - } - }, - "IMPAIRED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMPAIRED" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FAILED" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "INSTANTIATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSTANTIATE_IN_PROGRESS" - } - }, - "INTENT_TO_UPDATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTENT_TO_UPDATE_IN_PROGRESS" - } - }, - "UPDATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_IN_PROGRESS" - } - }, - "TERMINATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERMINATE_IN_PROGRESS" - } - } - } - }, - "com.amazonaws.tnb#NsdId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - }, - "com.amazonaws.tnb#NsdInfoArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(network-package/np-[a-f0-9]{17})$" - } - }, - "com.amazonaws.tnb#NsdInfoId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^np-[a-f0-9]{17}$" - } - }, - "com.amazonaws.tnb#NsdOnboardingState": { - "type": "enum", - "members": { - "CREATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATED" - } - }, - "ONBOARDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ONBOARDED" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR" - } - } - } - }, - "com.amazonaws.tnb#NsdOperationalState": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.tnb#NsdUsageState": { - "type": "enum", - "members": { - "IN_USE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_USE" - } - }, - "NOT_IN_USE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_IN_USE" - } - } - } - }, - "com.amazonaws.tnb#OnboardingState": { - "type": "enum", - "members": { - "CREATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATED" - } - }, - "ONBOARDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ONBOARDED" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR" - } - } - } - }, - "com.amazonaws.tnb#OperationalState": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.tnb#OverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#ToscaOverride" - } - }, - "com.amazonaws.tnb#PackageContentType": { - "type": "enum", - "members": { - "APPLICATION_ZIP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "application/zip" - } - } - } - }, - "com.amazonaws.tnb#PaginationToken": { - "type": "string" - }, - "com.amazonaws.tnb#ProblemDetails": { - "type": "structure", - "members": { - "detail": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

A human-readable explanation specific to this occurrence of the problem.

", - "smithy.api#required": {} - } - }, - "title": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

A human-readable title of the problem type.

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

Details related to problems with AWS TNB resources.

" - } - }, - "com.amazonaws.tnb#PutSolFunctionPackageContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#PutSolFunctionPackageContentInput" - }, - "output": { - "target": "com.amazonaws.tnb#PutSolFunctionPackageContentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Uploads the contents of a function package.

\n

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

", - "smithy.api#examples": [ - { - "title": "Upload a function package content", - "input": { - "vnfPkgId": "fp-07aa863e53460a2a6", - "contentType": "application/zip", - "file": "UEsDBBQAAAAAAPqLiVMAAAAAAAAAAAAAAAAMACAAZnJlZTVnYy1hbWYvVVQNAAcIrrJhBK" - }, - "output": { - "id": "fp-07aa863e53460a2a6", - "vnfdId": "0d72acd9-e45d-4644-9bcd-1fe67cd0e2c8", - "vnfProductName": "Sample AMF", - "vnfProvider": "Sample", - "vnfdVersion": "1.0.0", - "metadata": { - "vnfd": { - "overrides": [] - } - } - } - } - ], - "smithy.api#http": { - "method": "PUT", - "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content", - "code": 202 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#PutSolFunctionPackageContentInput": { - "type": "structure", - "members": { - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

Function package ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "contentType": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

Function package content type.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "file": { - "target": "com.amazonaws.tnb#SensitiveBlob", - "traits": { - "smithy.api#documentation": "

Function package file.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#PutSolFunctionPackageContentMetadata": { - "type": "structure", - "members": { - "vnfd": { - "target": "com.amazonaws.tnb#FunctionArtifactMeta" - } - }, - "traits": { - "smithy.api#documentation": "

Update metadata in a function package.

\n

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

" - } - }, - "com.amazonaws.tnb#PutSolFunctionPackageContentOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

Function package ID.

", - "smithy.api#required": {} - } - }, - "vnfdId": { - "target": "com.amazonaws.tnb#VnfdId", - "traits": { - "smithy.api#documentation": "

Function package descriptor ID.

", - "smithy.api#required": {} - } - }, - "vnfProductName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Function product name.

", - "smithy.api#required": {} - } - }, - "vnfProvider": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Function provider.

", - "smithy.api#required": {} - } - }, - "vnfdVersion": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Function package descriptor version.

", - "smithy.api#required": {} - } - }, - "metadata": { - "target": "com.amazonaws.tnb#PutSolFunctionPackageContentMetadata", - "traits": { - "smithy.api#documentation": "

Function package metadata.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#PutSolNetworkPackageContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#PutSolNetworkPackageContentInput" - }, - "output": { - "target": "com.amazonaws.tnb#PutSolNetworkPackageContentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Uploads the contents of a network package.

\n

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

", - "smithy.api#examples": [ - { - "title": "Upload the network package content of an NSD archive", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241", - "contentType": "application/zip", - "file": "UEsDBBQAAAAAAPqLiVMAAAAAAAAAAAAAA" - }, - "output": { - "id": "np-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", - "nsdId": "0d72acd9-e45d-4644-9bcd-1fe67cd0e2c8", - "nsdName": "Sample Single Cluster", - "nsdVersion": "1.0.0", - "vnfPkgIds": [ - "fp-1234567890abcdabc", - "fp-0b627c4a170a97f79" - ], - "metadata": { - "nsd": { - "overrides": [ - { - "name": "cidr_block", - "defaultValue": "10.0.0.0/24" - }, - { - "name": "some_vnf.vnf_prop" - } - ] - } - } - } - } - ], - "smithy.api#http": { - "method": "PUT", - "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#PutSolNetworkPackageContentInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

Network service descriptor info ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "contentType": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

Network package content type.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "file": { - "target": "com.amazonaws.tnb#SensitiveBlob", - "traits": { - "smithy.api#documentation": "

Network package file.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#PutSolNetworkPackageContentMetadata": { - "type": "structure", - "members": { - "nsd": { - "target": "com.amazonaws.tnb#NetworkArtifactMeta" - } - }, - "traits": { - "smithy.api#documentation": "

Update metadata in a network package.

\n

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

" - } - }, - "com.amazonaws.tnb#PutSolNetworkPackageContentOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

Network package ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsdInfoArn", - "traits": { - "smithy.api#documentation": "

Network package ARN.

", - "smithy.api#required": {} - } - }, - "nsdId": { - "target": "com.amazonaws.tnb#NsdId", - "traits": { - "smithy.api#documentation": "

Network service descriptor ID.

", - "smithy.api#required": {} - } - }, - "nsdName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network service descriptor name.

", - "smithy.api#required": {} - } - }, - "nsdVersion": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network service descriptor version.

", - "smithy.api#required": {} - } - }, - "vnfPkgIds": { - "target": "com.amazonaws.tnb#VnfPkgIdList", - "traits": { - "smithy.api#documentation": "

Function package IDs.

", - "smithy.api#required": {} - } - }, - "metadata": { - "target": "com.amazonaws.tnb#PutSolNetworkPackageContentMetadata", - "traits": { - "smithy.api#documentation": "

Network package metadata.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Request references a resource that doesn't exist.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.tnb#SensitiveBlob": { - "type": "blob", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.tnb#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Service quotas have been exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.tnb#StringMap": { - "type": "map", - "key": { - "target": "smithy.api#String" - }, - "value": { - "target": "smithy.api#String" - } - }, - "com.amazonaws.tnb#TNB": { - "type": "service", - "version": "2008-10-21", - "operations": [ - { - "target": "com.amazonaws.tnb#CancelSolNetworkOperation" - }, - { - "target": "com.amazonaws.tnb#CreateSolFunctionPackage" - }, - { - "target": "com.amazonaws.tnb#CreateSolNetworkInstance" - }, - { - "target": "com.amazonaws.tnb#CreateSolNetworkPackage" - }, - { - "target": "com.amazonaws.tnb#DeleteSolFunctionPackage" - }, - { - "target": "com.amazonaws.tnb#DeleteSolNetworkInstance" - }, - { - "target": "com.amazonaws.tnb#DeleteSolNetworkPackage" - }, - { - "target": "com.amazonaws.tnb#GetSolFunctionInstance" - }, - { - "target": "com.amazonaws.tnb#GetSolFunctionPackage" - }, - { - "target": "com.amazonaws.tnb#GetSolFunctionPackageContent" - }, - { - "target": "com.amazonaws.tnb#GetSolFunctionPackageDescriptor" - }, - { - "target": "com.amazonaws.tnb#GetSolNetworkInstance" - }, - { - "target": "com.amazonaws.tnb#GetSolNetworkOperation" - }, - { - "target": "com.amazonaws.tnb#GetSolNetworkPackage" - }, - { - "target": "com.amazonaws.tnb#GetSolNetworkPackageContent" - }, - { - "target": "com.amazonaws.tnb#GetSolNetworkPackageDescriptor" - }, - { - "target": "com.amazonaws.tnb#InstantiateSolNetworkInstance" - }, - { - "target": "com.amazonaws.tnb#ListSolFunctionInstances" - }, - { - "target": "com.amazonaws.tnb#ListSolFunctionPackages" - }, - { - "target": "com.amazonaws.tnb#ListSolNetworkInstances" - }, - { - "target": "com.amazonaws.tnb#ListSolNetworkOperations" - }, - { - "target": "com.amazonaws.tnb#ListSolNetworkPackages" - }, - { - "target": "com.amazonaws.tnb#ListTagsForResource" - }, - { - "target": "com.amazonaws.tnb#PutSolFunctionPackageContent" - }, - { - "target": "com.amazonaws.tnb#PutSolNetworkPackageContent" - }, - { - "target": "com.amazonaws.tnb#TagResource" - }, - { - "target": "com.amazonaws.tnb#TerminateSolNetworkInstance" - }, - { - "target": "com.amazonaws.tnb#UntagResource" - }, - { - "target": "com.amazonaws.tnb#UpdateSolFunctionPackage" - }, - { - "target": "com.amazonaws.tnb#UpdateSolNetworkInstance" - }, - { - "target": "com.amazonaws.tnb#UpdateSolNetworkPackage" - }, - { - "target": "com.amazonaws.tnb#ValidateSolFunctionPackageContent" - }, - { - "target": "com.amazonaws.tnb#ValidateSolNetworkPackageContent" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "tnb", - "apiVersion": "v1", - "arnNamespace": "tnb" - }, - "aws.auth#sigv4": { - "name": "tnb" - }, - "aws.protocols#restJson1": {}, - "smithy.api#cors": { - "additionalAllowedHeaders": [ - "*", - "content-type", - "x-amz-content-sha256", - "x-amz-user-agent", - "x-amzn-platform-id", - "x-amzn-trace-id" - ], - "additionalExposedHeaders": [ - "x-amzn-errortype", - "x-amzn-requestid", - "x-amzn-trace-id" - ], - "maxAge": 86400 - }, - "smithy.api#documentation": "

\n Amazon Web Services Telco Network Builder (TNB) is a network automation service that helps\n you deploy and manage telecom networks. AWS TNB helps you with the lifecycle management of\n your telecommunication network functions throughout planning, deployment, and\n post-deployment activities.

", - "smithy.api#title": "AWS Telco Network Builder", - "smithy.rules#endpointBdd": { - "version": "1.1", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - }, - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "results": [ - { - "conditions": [], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://tnb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://tnb-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://tnb.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://tnb.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "root": 2, - "nodeCount": 13, - "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://tnb-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://tnb-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://tnb.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://tnb.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "type": "tree" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://tnb.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://tnb.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://tnb.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://tnb.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.tnb#TNBResourceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:aws:tnb:[a-z0-9-]+:[^:]*:.*$" - } - }, - "com.amazonaws.tnb#TagKey": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(?!aws:).{1,128}$" - } - }, - "com.amazonaws.tnb#TagKeys": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.tnb#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.tnb#TagKey" - }, - "value": { - "target": "com.amazonaws.tnb#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.tnb#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#TagResourceInput" - }, - "output": { - "target": "com.amazonaws.tnb#TagResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Tags an AWS TNB resource.

\n

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

", - "smithy.api#http": { - "uri": "/tags/{resourceArn}", - "method": "POST" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#TagResourceInput": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.tnb#TNBResourceArn", - "traits": { - "smithy.api#documentation": "

Resource ARN.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#TagResourceOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.tnb#TaskStatus": { - "type": "enum", - "members": { - "SCHEDULED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCHEDULED" - } - }, - "STARTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTED" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ERROR" - } - }, - "SKIPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SKIPPED" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - } - } - }, - "com.amazonaws.tnb#TerminateSolNetworkInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#TerminateSolNetworkInstanceInput" - }, - "output": { - "target": "com.amazonaws.tnb#TerminateSolNetworkInstanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Terminates a network instance.

\n

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

\n

You must terminate a network instance before you can delete it.

", - "smithy.api#examples": [ - { - "title": "Terminate a Sol Network Instance", - "input": { - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "tags": { - "Name": "Resource" - } - }, - "output": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241", - "tags": { - "Name": "Resource" - } - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/sol/nslcm/v1/ns_instances/{nsInstanceId}/terminate", - "code": 201 - } - } - }, - "com.amazonaws.tnb#TerminateSolNetworkInstanceInput": { - "type": "structure", - "members": { - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#TerminateSolNetworkInstanceOutput": { - "type": "structure", - "members": { - "nsLcmOpOccId": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

The identifier of the network operation.

" - } - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Exception caused by throttling.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.tnb#ToscaOverride": { - "type": "structure", - "members": { - "name": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Name of the TOSCA override.

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

Default value for the override.

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

Overrides of the TOSCA node.

" - } - }, - "com.amazonaws.tnb#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#UntagResourceInput" - }, - "output": { - "target": "com.amazonaws.tnb#UntagResourceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Untags an AWS TNB resource.

\n

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.

", - "smithy.api#http": { - "uri": "/tags/{resourceArn}", - "method": "DELETE" - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#UntagResourceInput": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.tnb#TNBResourceArn", - "traits": { - "smithy.api#documentation": "

Resource ARN.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.tnb#TagKeys", - "traits": { - "smithy.api#documentation": "

Tag keys.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#UntagResourceOutput": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#UpdateNsMetadata": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

The network service descriptor used for updating the network instance.

", - "smithy.api#required": {} - } - }, - "additionalParamsForNs": { - "target": "smithy.api#Document", - "traits": { - "smithy.api#documentation": "

The configurable properties used during update.

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

Metadata related to the configuration properties used during update of a network instance.

" - } - }, - "com.amazonaws.tnb#UpdateSolFunctionPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#UpdateSolFunctionPackageInput" - }, - "output": { - "target": "com.amazonaws.tnb#UpdateSolFunctionPackageOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the operational state of function package.

\n

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

", - "smithy.api#examples": [ - { - "title": "Enable a function package's Operational State", - "input": { - "vnfPkgId": "fp-07aa863e53460a2a6", - "operationalState": "ENABLED" - }, - "output": { - "operationalState": "ENABLED" - } - }, - { - "title": "Disable a function package's Operational State", - "input": { - "vnfPkgId": "fp-07aa863e53460a2a6", - "operationalState": "DISABLED" - }, - "output": { - "operationalState": "DISABLED" - } - } - ], - "smithy.api#http": { - "method": "PATCH", - "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}" - } - } - }, - "com.amazonaws.tnb#UpdateSolFunctionPackageInput": { - "type": "structure", - "members": { - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

ID of the function package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "operationalState": { - "target": "com.amazonaws.tnb#OperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the function package.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#UpdateSolFunctionPackageOutput": { - "type": "structure", - "members": { - "operationalState": { - "target": "com.amazonaws.tnb#OperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the function package.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#UpdateSolNetworkInstance": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#UpdateSolNetworkInstanceInput" - }, - "output": { - "target": "com.amazonaws.tnb#UpdateSolNetworkInstanceOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Update a network instance.

\n

A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

\n

Choose the updateType parameter to target the necessary update of the network instance.

", - "smithy.api#examples": [ - { - "title": "Update a Sol Network Instance", - "input": { - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "updateType": "MODIFY_VNF_INFORMATION", - "modifyVnfInfoData": { - "vnfInstanceId": "fi-0d5b823eb5c2a9241", - "vnfConfigurableProperties": { - "pcf.port": "8080", - "pcf.pods": "10" - } - }, - "tags": { - "Name": "Resource" - } - }, - "output": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241", - "tags": { - "Name": "Resource" - } - } - }, - { - "title": "Update a Sol Network Instance", - "input": { - "nsInstanceId": "ni-0d5b823eb5c2a9241", - "updateType": "UPDATE_NS", - "updateNs": { - "nsdInfoId": "np-0d5b823eb5c2a9241", - "additionalParamsForNs": { - "cidr_block": "10.0.0.0/16", - "availability_zone": "us-west-2a" - } - }, - "tags": { - "Name": "Resource" - } - }, - "output": { - "nsLcmOpOccId": "no-0d5b823eb5c2a9241", - "tags": { - "Name": "Resource" - } - } - } - ], - "smithy.api#http": { - "method": "POST", - "uri": "/sol/nslcm/v1/ns_instances/{nsInstanceId}/update", - "code": 201 - } - } - }, - "com.amazonaws.tnb#UpdateSolNetworkInstanceInput": { - "type": "structure", - "members": { - "nsInstanceId": { - "target": "com.amazonaws.tnb#NsInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network instance.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "updateType": { - "target": "com.amazonaws.tnb#UpdateSolNetworkType", - "traits": { - "smithy.api#documentation": "

The type of update.

\n ", - "smithy.api#required": {} - } - }, - "modifyVnfInfoData": { - "target": "com.amazonaws.tnb#UpdateSolNetworkModify", - "traits": { - "smithy.api#documentation": "

Identifies the network function information parameters and/or the configurable\n properties of the network function to be modified.

\n

Include this property only if the update type is MODIFY_VNF_INFORMATION.

" - } - }, - "updateNs": { - "target": "com.amazonaws.tnb#UpdateSolNetworkServiceData", - "traits": { - "smithy.api#documentation": "

Identifies the network service descriptor and the configurable\n properties of the descriptor, to be used for the update.

\n

Include this property only if the update type is UPDATE_NS.

" - } - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#UpdateSolNetworkInstanceOutput": { - "type": "structure", - "members": { - "nsLcmOpOccId": { - "target": "com.amazonaws.tnb#NsLcmOpOccId", - "traits": { - "smithy.api#documentation": "

The identifier of the network operation.

" - } - }, - "tags": { - "target": "com.amazonaws.tnb#TagMap", - "traits": { - "smithy.api#documentation": "

A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. When you use this API, the tags are only applied to the network operation that is created. These tags are not applied to the network instance. Use tags to search and filter your resources or track your Amazon Web Services costs.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#UpdateSolNetworkModify": { - "type": "structure", - "members": { - "vnfInstanceId": { - "target": "com.amazonaws.tnb#VnfInstanceId", - "traits": { - "smithy.api#documentation": "

ID of the network function instance.

\n

A network function instance is a function in a function package .

", - "smithy.api#required": {} - } - }, - "vnfConfigurableProperties": { - "target": "smithy.api#Document", - "traits": { - "smithy.api#documentation": "

Provides values for the configurable properties declared in the function package\n descriptor.

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

Information parameters and/or the configurable properties for a network function.

\n

A network function instance is a function in a function package .

" - } - }, - "com.amazonaws.tnb#UpdateSolNetworkPackage": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#UpdateSolNetworkPackageInput" - }, - "output": { - "target": "com.amazonaws.tnb#UpdateSolNetworkPackageOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the operational state of a network package.

\n

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

\n

A network service descriptor is a .yaml file in a network package that uses the TOSCA standard to describe the network functions you want to deploy and the Amazon Web Services infrastructure you want to deploy the network functions on.

", - "smithy.api#examples": [ - { - "title": "Enable a network package's Operational State", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241", - "nsdOperationalState": "ENABLED" - }, - "output": { - "nsdOperationalState": "ENABLED" - } - }, - { - "title": "Disable a network package's Operational State", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241", - "nsdOperationalState": "DISABLED" - }, - "output": { - "nsdOperationalState": "DISABLED" - } - } - ], - "smithy.api#http": { - "method": "PATCH", - "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}" - } - } - }, - "com.amazonaws.tnb#UpdateSolNetworkPackageInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor in the network package.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nsdOperationalState": { - "target": "com.amazonaws.tnb#NsdOperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#UpdateSolNetworkPackageOutput": { - "type": "structure", - "members": { - "nsdOperationalState": { - "target": "com.amazonaws.tnb#NsdOperationalState", - "traits": { - "smithy.api#documentation": "

Operational state of the network service descriptor in the network package.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#UpdateSolNetworkServiceData": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

ID of the network service descriptor.

", - "smithy.api#required": {} - } - }, - "additionalParamsForNs": { - "target": "smithy.api#Document", - "traits": { - "smithy.api#documentation": "

Values for the configurable properties declared in the network service descriptor.

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

Information parameters and/or the configurable properties for a network descriptor used for update.

" - } - }, - "com.amazonaws.tnb#UpdateSolNetworkType": { - "type": "enum", - "members": { - "MODIFY_VNF_INFORMATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MODIFY_VNF_INFORMATION" - } - }, - "UPDATE_NS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_NS" - } - } - } - }, - "com.amazonaws.tnb#UsageState": { - "type": "enum", - "members": { - "IN_USE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_USE" - } - }, - "NOT_IN_USE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_IN_USE" - } - } - } - }, - "com.amazonaws.tnb#ValidateSolFunctionPackageContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ValidateSolFunctionPackageContentInput" - }, - "output": { - "target": "com.amazonaws.tnb#ValidateSolFunctionPackageContentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Validates function package content. This can be used as a dry run before uploading\n function package content with PutSolFunctionPackageContent.

\n

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

", - "smithy.api#examples": [ - { - "title": "Validate a Function Package content", - "input": { - "vnfPkgId": "fp-07aa863e53460a2a6", - "contentType": "application/zip", - "file": "UEsDBBQAAAAAAPqLiVMAAAAAAAAAAAAAAAAMACAAZnJlZTVnYy1hbWYvVVQNAAcIrrJhBK" - }, - "output": { - "id": "fp-07aa863e53460a2a6", - "vnfdId": "0d72acd9-e45d-4644-9bcd-1fe67cd0e2c8", - "vnfProductName": "Sample AMF", - "vnfProvider": "Sample", - "vnfdVersion": "1.0.0", - "metadata": { - "vnfd": { - "overrides": [] - } - } - } - } - ], - "smithy.api#http": { - "method": "PUT", - "uri": "/sol/vnfpkgm/v1/vnf_packages/{vnfPkgId}/package_content/validate", - "code": 202 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#ValidateSolFunctionPackageContentInput": { - "type": "structure", - "members": { - "vnfPkgId": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

Function package ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "contentType": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

Function package content type.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "file": { - "target": "com.amazonaws.tnb#SensitiveBlob", - "traits": { - "smithy.api#documentation": "

Function package file.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#ValidateSolFunctionPackageContentMetadata": { - "type": "structure", - "members": { - "vnfd": { - "target": "com.amazonaws.tnb#FunctionArtifactMeta" - } - }, - "traits": { - "smithy.api#documentation": "

Validates function package content metadata.

\n

A function package is a .zip file in CSAR (Cloud Service Archive) format that contains a network function (an ETSI standard telecommunication application) and function package descriptor that uses the TOSCA standard to describe how the network functions should run on your network.

" - } - }, - "com.amazonaws.tnb#ValidateSolFunctionPackageContentOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#VnfPkgId", - "traits": { - "smithy.api#documentation": "

Function package ID.

", - "smithy.api#required": {} - } - }, - "vnfdId": { - "target": "com.amazonaws.tnb#VnfdId", - "traits": { - "smithy.api#documentation": "

Function package descriptor ID.

", - "smithy.api#required": {} - } - }, - "vnfProductName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network function product name.

", - "smithy.api#required": {} - } - }, - "vnfProvider": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network function provider.

", - "smithy.api#required": {} - } - }, - "vnfdVersion": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Function package descriptor version.

", - "smithy.api#required": {} - } - }, - "metadata": { - "target": "com.amazonaws.tnb#ValidateSolFunctionPackageContentMetadata", - "traits": { - "smithy.api#documentation": "

Function package metadata.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ValidateSolNetworkPackageContent": { - "type": "operation", - "input": { - "target": "com.amazonaws.tnb#ValidateSolNetworkPackageContentInput" - }, - "output": { - "target": "com.amazonaws.tnb#ValidateSolNetworkPackageContentOutput" - }, - "errors": [ - { - "target": "com.amazonaws.tnb#AccessDeniedException" - }, - { - "target": "com.amazonaws.tnb#InternalServerException" - }, - { - "target": "com.amazonaws.tnb#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.tnb#ThrottlingException" - }, - { - "target": "com.amazonaws.tnb#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Validates network package content. This can be used as a dry run before uploading\n network package content with PutSolNetworkPackageContent.

\n

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

", - "smithy.api#examples": [ - { - "title": "Validate the network package content of a NSD archive", - "input": { - "nsdInfoId": "np-0d5b823eb5c2a9241", - "contentType": "application/zip", - "file": "UEsDBBQAAAAAAPqLiVMAAAAAAAAAAAAAA" - }, - "output": { - "id": "np-0d5b823eb5c2a9241", - "arn": "arn:aws:tnb:us-west-2:123456789000:network-package/np-0d5b823eb5c2a9241", - "nsdId": "0d72acd9-e45d-4644-9bcd-1fe67cd0e2c8", - "nsdName": "Sample Single Cluster", - "nsdVersion": "1.0.0", - "vnfPkgIds": [ - "fp-1234567890abcdabc", - "fp-0b627c4a170a97f79" - ], - "metadata": { - "nsd": { - "overrides": [ - { - "name": "cidr_block", - "defaultValue": "10.0.0.0/24" - }, - { - "name": "some_vnf.vnf_prop" - } - ] - } - } - } - } - ], - "smithy.api#http": { - "method": "PUT", - "uri": "/sol/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content/validate", - "code": 200 - }, - "smithy.api#idempotent": {} - } - }, - "com.amazonaws.tnb#ValidateSolNetworkPackageContentInput": { - "type": "structure", - "members": { - "nsdInfoId": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

Network service descriptor file.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "contentType": { - "target": "com.amazonaws.tnb#PackageContentType", - "traits": { - "smithy.api#documentation": "

Network package content type.

", - "smithy.api#httpHeader": "Content-Type" - } - }, - "file": { - "target": "com.amazonaws.tnb#SensitiveBlob", - "traits": { - "smithy.api#documentation": "

Network package file.

", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.tnb#ValidateSolNetworkPackageContentMetadata": { - "type": "structure", - "members": { - "nsd": { - "target": "com.amazonaws.tnb#NetworkArtifactMeta" - } - }, - "traits": { - "smithy.api#documentation": "

Validates network package content metadata.

\n

A network package is a .zip file in CSAR (Cloud Service Archive) format defines the function packages you want to deploy and the Amazon Web Services infrastructure you want to deploy them on.

" - } - }, - "com.amazonaws.tnb#ValidateSolNetworkPackageContentOutput": { - "type": "structure", - "members": { - "id": { - "target": "com.amazonaws.tnb#NsdInfoId", - "traits": { - "smithy.api#documentation": "

Network package ID.

", - "smithy.api#required": {} - } - }, - "arn": { - "target": "com.amazonaws.tnb#NsdInfoArn", - "traits": { - "smithy.api#documentation": "

Network package ARN.

", - "smithy.api#required": {} - } - }, - "nsdId": { - "target": "com.amazonaws.tnb#NsdId", - "traits": { - "smithy.api#documentation": "

Network service descriptor ID.

", - "smithy.api#required": {} - } - }, - "nsdName": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network service descriptor name.

", - "smithy.api#required": {} - } - }, - "nsdVersion": { - "target": "smithy.api#String", - "traits": { - "smithy.api#documentation": "

Network service descriptor version.

", - "smithy.api#required": {} - } - }, - "vnfPkgIds": { - "target": "com.amazonaws.tnb#VnfPkgIdList", - "traits": { - "smithy.api#documentation": "

Function package IDs.

", - "smithy.api#required": {} - } - }, - "metadata": { - "target": "com.amazonaws.tnb#ValidateSolNetworkPackageContentMetadata", - "traits": { - "smithy.api#documentation": "

Network package metadata.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.tnb#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "smithy.api#String", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Unable to process the request because the client provided input failed to satisfy\n request constraints.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.tnb#VnfInstanceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(function-instance/fi-[a-f0-9]{17})$" - } - }, - "com.amazonaws.tnb#VnfInstanceId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^fi-[a-f0-9]{17}$" - } - }, - "com.amazonaws.tnb#VnfInstantiationState": { - "type": "enum", - "members": { - "INSTANTIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSTANTIATED" - } - }, - "NOT_INSTANTIATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOT_INSTANTIATED" - } - } - } - }, - "com.amazonaws.tnb#VnfOperationalState": { - "type": "enum", - "members": { - "STARTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTED" - } - }, - "STOPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOPPED" - } - } - } - }, - "com.amazonaws.tnb#VnfPkgArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:(aws|aws-cn|aws-iso|aws-iso-b|aws-us-gov):tnb:([a-z]{2}(-(gov|isob|iso))?-(east|west|north|south|central){1,2}-[0-9]):\\d{12}:(function-package/fp-[a-f0-9]{17})$" - } - }, - "com.amazonaws.tnb#VnfPkgId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^fp-[a-f0-9]{17}$" - } - }, - "com.amazonaws.tnb#VnfPkgIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.tnb#VnfPkgId" - } - }, - "com.amazonaws.tnb#VnfdId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" - } - } - } -} \ No newline at end of file From e02b279cada8cf56ba11f1f0ba3f1c3b4802261e Mon Sep 17 00:00:00 2001 From: rchache <105247787+rchache@users.noreply.github.com> Date: Tue, 20 Oct 2026 15:15:22 -0400 Subject: [PATCH 2/5] Delete models/finspace directory --- .../2021-03-12/finspace-2021-03-12.json | 10089 ---------------- 1 file changed, 10089 deletions(-) delete mode 100644 models/finspace/service/2021-03-12/finspace-2021-03-12.json diff --git a/models/finspace/service/2021-03-12/finspace-2021-03-12.json b/models/finspace/service/2021-03-12/finspace-2021-03-12.json deleted file mode 100644 index 9ea6a575e..000000000 --- a/models/finspace/service/2021-03-12/finspace-2021-03-12.json +++ /dev/null @@ -1,10089 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.finspace#AWSHabaneroManagementService": { - "type": "service", - "version": "2021-03-12", - "operations": [ - { - "target": "com.amazonaws.finspace#CreateEnvironment" - }, - { - "target": "com.amazonaws.finspace#CreateKxChangeset" - }, - { - "target": "com.amazonaws.finspace#CreateKxCluster" - }, - { - "target": "com.amazonaws.finspace#CreateKxDatabase" - }, - { - "target": "com.amazonaws.finspace#CreateKxDataview" - }, - { - "target": "com.amazonaws.finspace#CreateKxEnvironment" - }, - { - "target": "com.amazonaws.finspace#CreateKxScalingGroup" - }, - { - "target": "com.amazonaws.finspace#CreateKxUser" - }, - { - "target": "com.amazonaws.finspace#CreateKxVolume" - }, - { - "target": "com.amazonaws.finspace#DeleteEnvironment" - }, - { - "target": "com.amazonaws.finspace#DeleteKxCluster" - }, - { - "target": "com.amazonaws.finspace#DeleteKxClusterNode" - }, - { - "target": "com.amazonaws.finspace#DeleteKxDatabase" - }, - { - "target": "com.amazonaws.finspace#DeleteKxDataview" - }, - { - "target": "com.amazonaws.finspace#DeleteKxEnvironment" - }, - { - "target": "com.amazonaws.finspace#DeleteKxScalingGroup" - }, - { - "target": "com.amazonaws.finspace#DeleteKxUser" - }, - { - "target": "com.amazonaws.finspace#DeleteKxVolume" - }, - { - "target": "com.amazonaws.finspace#GetEnvironment" - }, - { - "target": "com.amazonaws.finspace#GetKxChangeset" - }, - { - "target": "com.amazonaws.finspace#GetKxCluster" - }, - { - "target": "com.amazonaws.finspace#GetKxConnectionString" - }, - { - "target": "com.amazonaws.finspace#GetKxDatabase" - }, - { - "target": "com.amazonaws.finspace#GetKxDataview" - }, - { - "target": "com.amazonaws.finspace#GetKxEnvironment" - }, - { - "target": "com.amazonaws.finspace#GetKxScalingGroup" - }, - { - "target": "com.amazonaws.finspace#GetKxUser" - }, - { - "target": "com.amazonaws.finspace#GetKxVolume" - }, - { - "target": "com.amazonaws.finspace#ListEnvironments" - }, - { - "target": "com.amazonaws.finspace#ListKxChangesets" - }, - { - "target": "com.amazonaws.finspace#ListKxClusterNodes" - }, - { - "target": "com.amazonaws.finspace#ListKxClusters" - }, - { - "target": "com.amazonaws.finspace#ListKxDatabases" - }, - { - "target": "com.amazonaws.finspace#ListKxDataviews" - }, - { - "target": "com.amazonaws.finspace#ListKxEnvironments" - }, - { - "target": "com.amazonaws.finspace#ListKxScalingGroups" - }, - { - "target": "com.amazonaws.finspace#ListKxUsers" - }, - { - "target": "com.amazonaws.finspace#ListKxVolumes" - }, - { - "target": "com.amazonaws.finspace#ListTagsForResource" - }, - { - "target": "com.amazonaws.finspace#TagResource" - }, - { - "target": "com.amazonaws.finspace#UntagResource" - }, - { - "target": "com.amazonaws.finspace#UpdateEnvironment" - }, - { - "target": "com.amazonaws.finspace#UpdateKxClusterCodeConfiguration" - }, - { - "target": "com.amazonaws.finspace#UpdateKxClusterDatabases" - }, - { - "target": "com.amazonaws.finspace#UpdateKxDatabase" - }, - { - "target": "com.amazonaws.finspace#UpdateKxDataview" - }, - { - "target": "com.amazonaws.finspace#UpdateKxEnvironment" - }, - { - "target": "com.amazonaws.finspace#UpdateKxEnvironmentNetwork" - }, - { - "target": "com.amazonaws.finspace#UpdateKxUser" - }, - { - "target": "com.amazonaws.finspace#UpdateKxVolume" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "finspace", - "arnNamespace": "finspace", - "cloudFormationName": "Finspace", - "cloudTrailEventSource": "finspace.amazonaws.com", - "endpointPrefix": "finspace" - }, - "aws.auth#sigv4": { - "name": "finspace" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The FinSpace management service provides the APIs for managing FinSpace environments.

", - "smithy.api#title": "FinSpace User Environment Management service", - "smithy.rules#endpointBdd": { - "version": "1.1", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - }, - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "results": [ - { - "conditions": [], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://finspace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://finspace-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://finspace.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://finspace.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "root": 2, - "nodeCount": 13, - "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://finspace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://finspace-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://finspace.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://finspace.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.finspace#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.finspace#AttachedClusterList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxClusterName" - } - }, - "com.amazonaws.finspace#AttributeMap": { - "type": "map", - "key": { - "target": "com.amazonaws.finspace#FederationAttributeKey" - }, - "value": { - "target": "com.amazonaws.finspace#FederationAttributeValue" - } - }, - "com.amazonaws.finspace#AutoScalingConfiguration": { - "type": "structure", - "members": { - "minNodeCount": { - "target": "com.amazonaws.finspace#NodeCount", - "traits": { - "smithy.api#documentation": "

The lowest number of nodes to scale. This value must be at least 1 and less than the maxNodeCount. If the nodes in a cluster belong to multiple availability zones, then minNodeCount must be at least 3.

" - } - }, - "maxNodeCount": { - "target": "com.amazonaws.finspace#NodeCount", - "traits": { - "smithy.api#documentation": "

The highest number of nodes to scale. This value cannot be greater than 5.

" - } - }, - "autoScalingMetric": { - "target": "com.amazonaws.finspace#AutoScalingMetric", - "traits": { - "smithy.api#documentation": "

The metric your cluster will track in order to scale in and out. For example, CPU_UTILIZATION_PERCENTAGE is the average CPU usage across all the nodes in a cluster.

" - } - }, - "metricTarget": { - "target": "com.amazonaws.finspace#AutoScalingMetricTarget", - "traits": { - "smithy.api#documentation": "

The desired value of the chosen autoScalingMetric. When the metric drops below this value, the cluster will scale in. When the metric goes above this value, the cluster will scale out. You can set the target value between 1 and 100 percent.

" - } - }, - "scaleInCooldownSeconds": { - "target": "com.amazonaws.finspace#CooldownTime", - "traits": { - "smithy.api#documentation": "

The duration in seconds that FinSpace will wait after a scale in event before initiating another scaling event.

" - } - }, - "scaleOutCooldownSeconds": { - "target": "com.amazonaws.finspace#CooldownTime", - "traits": { - "smithy.api#documentation": "

The duration in seconds that FinSpace will wait after a scale out event before initiating another scaling event.

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

The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

" - } - }, - "com.amazonaws.finspace#AutoScalingMetric": { - "type": "enum", - "members": { - "CPU_UTILIZATION_PERCENTAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CPU_UTILIZATION_PERCENTAGE" - } - } - } - }, - "com.amazonaws.finspace#AutoScalingMetricTarget": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.finspace#AvailabilityZoneId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 8, - "max": 12 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.finspace#AvailabilityZoneIds": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#AvailabilityZoneId" - } - }, - "com.amazonaws.finspace#BoxedInteger": { - "type": "integer" - }, - "com.amazonaws.finspace#CapacityConfiguration": { - "type": "structure", - "members": { - "nodeType": { - "target": "com.amazonaws.finspace#NodeType", - "traits": { - "smithy.api#documentation": "

The type that determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance.

\n

You can only specify one of the following values:

\n " - } - }, - "nodeCount": { - "target": "com.amazonaws.finspace#NodeCount", - "traits": { - "smithy.api#documentation": "

The number of instances running in a cluster.

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

A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

" - } - }, - "com.amazonaws.finspace#ChangeRequest": { - "type": "structure", - "members": { - "changeType": { - "target": "com.amazonaws.finspace#ChangeType", - "traits": { - "smithy.api#documentation": "

Defines the type of change request. A changeType can have the following values:

\n ", - "smithy.api#required": {} - } - }, - "s3Path": { - "target": "com.amazonaws.finspace#S3Path", - "traits": { - "smithy.api#documentation": "

Defines the S3 path of the source file that is required to add or update files in a database.

" - } - }, - "dbPath": { - "target": "com.amazonaws.finspace#DbPath", - "traits": { - "smithy.api#documentation": "

Defines the path within the database directory.

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

A list of change request objects.

" - } - }, - "com.amazonaws.finspace#ChangeRequests": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#ChangeRequest" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.finspace#ChangeType": { - "type": "enum", - "members": { - "PUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PUT" - } - }, - "DELETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE" - } - } - } - }, - "com.amazonaws.finspace#ChangesetId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 26 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]+$" - } - }, - "com.amazonaws.finspace#ChangesetStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "PROCESSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROCESSING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - } - } - }, - "com.amazonaws.finspace#ClientToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 36 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.finspace#ClientTokenString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.finspace#ClusterNodeCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.finspace#CodeConfiguration": { - "type": "structure", - "members": { - "s3Bucket": { - "target": "com.amazonaws.finspace#S3Bucket", - "traits": { - "smithy.api#documentation": "

A unique name for the S3 bucket.

" - } - }, - "s3Key": { - "target": "com.amazonaws.finspace#S3Key", - "traits": { - "smithy.api#documentation": "

The full S3 path (excluding bucket) to the .zip file. This file contains the code that is loaded onto the cluster when it's started.

" - } - }, - "s3ObjectVersion": { - "target": "com.amazonaws.finspace#S3ObjectVersion", - "traits": { - "smithy.api#documentation": "

The version of an S3 object.

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

The structure of the customer code available within the running cluster.

" - } - }, - "com.amazonaws.finspace#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - }, - "reason": { - "target": "com.amazonaws.finspace#ErrorMessage2", - "traits": { - "smithy.api#documentation": "

The reason for the conflict exception.

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

There was a conflict with this action, and it could not be completed.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.finspace#CooldownTime": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 100000 - } - } - }, - "com.amazonaws.finspace#CpuCount": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 0.1 - } - } - }, - "com.amazonaws.finspace#CreateEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateEnvironmentRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateEnvironmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Create a new FinSpace environment.

", - "smithy.api#http": { - "method": "POST", - "uri": "/environment", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateEnvironmentRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#EnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the FinSpace environment to be created.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

The description of the FinSpace environment to be created.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The KMS key id to encrypt your data in the FinSpace environment.

" - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "

Add tags to your FinSpace environment.

" - } - }, - "federationMode": { - "target": "com.amazonaws.finspace#FederationMode", - "traits": { - "smithy.api#documentation": "

Authentication mode for the environment.

\n " - } - }, - "federationParameters": { - "target": "com.amazonaws.finspace#FederationParameters", - "traits": { - "smithy.api#documentation": "

Configuration information when authentication mode is FEDERATED.

" - } - }, - "superuserParameters": { - "target": "com.amazonaws.finspace#SuperuserParameters", - "traits": { - "smithy.api#documentation": "

Configuration information for the superuser.

" - } - }, - "dataBundles": { - "target": "com.amazonaws.finspace#DataBundleArns", - "traits": { - "smithy.api#documentation": "

The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateEnvironmentResponse": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

The unique identifier for FinSpace environment that you created.

" - } - }, - "environmentArn": { - "target": "com.amazonaws.finspace#EnvironmentArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the FinSpace environment that you created.

" - } - }, - "environmentUrl": { - "target": "com.amazonaws.finspace#url", - "traits": { - "smithy.api#documentation": "

The sign-in URL for the web application of the FinSpace environment you created.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CreateKxChangeset": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateKxChangesetRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateKxChangesetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n 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

", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/changesets", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxChangesetRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier of the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the kdb database.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "changeRequests": { - "target": "com.amazonaws.finspace#ChangeRequests", - "traits": { - "smithy.api#documentation": "

A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and dbPath. \n A changeType can have the following values:

\n \n

All the change requests require a mandatory dbPath attribute that defines the\n path within the database directory. All database paths must start with a leading / and end\n with a trailing /. The s3Path attribute defines the s3 source file path and is\n required for a PUT change type. The s3path must end with a trailing / if it is\n a directory and must end without a trailing / if it is a file.

\n

Here are few examples of how you can use the change request object:

\n
    \n
  1. \n

    This request adds a single sym file at database root location.

    \n

    \n { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/sym\",\n \"dbPath\":\"/\"}\n

    \n
    2. \n
  2. \n

    This request adds files in the given s3Path under the 2020.01.02\n partition of the database.

    \n

    \n { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/\",\n \"dbPath\":\"/2020.01.02/\"}\n

    \n
    3. \n
  3. \n

    This request adds files in the given s3Path under the\n taq table partition of the database.

    \n

    \n [ { \"changeType\": \"PUT\", \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\",\n \"dbPath\":\"/2020.01.02/taq/\"}]\n

    \n
    4. \n
  4. \n

    This request deletes the 2020.01.02 partition of the database.

    \n

    \n [{ \"changeType\": \"DELETE\", \"dbPath\": \"/2020.01.02/\"} ]\n

    \n
    5. \n
  5. \n

    The DELETE request allows you to delete the existing files under the\n 2020.01.02 partition of the database, and the PUT request adds a\n new taq table under it.

    \n

    \n [ {\"changeType\": \"DELETE\", \"dbPath\":\"/2020.01.02/\"}, {\"changeType\": \"PUT\",\n \"s3Path\":\"s3://bucket/db/2020.01.02/taq/\",\n \"dbPath\":\"/2020.01.02/taq/\"}]\n

    \n
    6. \n
", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxChangesetResponse": { - "type": "structure", - "members": { - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the changeset.

" - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the kdb database.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

" - } - }, - "changeRequests": { - "target": "com.amazonaws.finspace#ChangeRequests", - "traits": { - "smithy.api#documentation": "

A list of change requests.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the changeset was updated 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.

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

Status of the changeset creation process.

\n " - } - }, - "errorInfo": { - "target": "com.amazonaws.finspace#ErrorInfo", - "traits": { - "smithy.api#documentation": "

The details of the error that you receive when creating a changeset. It consists of the type of error and the error message.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CreateKxCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateKxClusterRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateKxClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new kdb cluster.

", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments/{environmentId}/clusters", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxClusterRequest": { - "type": "structure", - "members": { - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "

A unique name for the cluster that you want to create.

", - "smithy.api#required": {} - } - }, - "clusterType": { - "target": "com.amazonaws.finspace#KxClusterType", - "traits": { - "smithy.api#documentation": "

Specifies the type of KDB database that is being created. The following types are available:

\n ", - "smithy.api#required": {} - } - }, - "tickerplantLogConfiguration": { - "target": "com.amazonaws.finspace#TickerplantLogConfiguration", - "traits": { - "smithy.api#documentation": "

\nA configuration to store Tickerplant logs. It consists of\na list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path. \n

" - } - }, - "databases": { - "target": "com.amazonaws.finspace#KxDatabaseConfigurations", - "traits": { - "smithy.api#documentation": "

A list of databases that will be available for querying.

" - } - }, - "cacheStorageConfigurations": { - "target": "com.amazonaws.finspace#KxCacheStorageConfigurations", - "traits": { - "smithy.api#documentation": "

The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

" - } - }, - "autoScalingConfiguration": { - "target": "com.amazonaws.finspace#AutoScalingConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

" - } - }, - "clusterDescription": { - "target": "com.amazonaws.finspace#KxClusterDescription", - "traits": { - "smithy.api#documentation": "

A description of the cluster.

" - } - }, - "capacityConfiguration": { - "target": "com.amazonaws.finspace#CapacityConfiguration", - "traits": { - "smithy.api#documentation": "

A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

" - } - }, - "releaseLabel": { - "target": "com.amazonaws.finspace#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The version of FinSpace managed kdb to run.

", - "smithy.api#required": {} - } - }, - "vpcConfiguration": { - "target": "com.amazonaws.finspace#VpcConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration details about the network where the Privatelink endpoint of the cluster resides.

", - "smithy.api#required": {} - } - }, - "initializationScript": { - "target": "com.amazonaws.finspace#InitializationScriptFilePath", - "traits": { - "smithy.api#documentation": "

Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.

" - } - }, - "commandLineArguments": { - "target": "com.amazonaws.finspace#KxCommandLineArguments", - "traits": { - "smithy.api#documentation": "

Defines the key-value pairs to make them available inside the cluster.

" - } - }, - "code": { - "target": "com.amazonaws.finspace#CodeConfiguration", - "traits": { - "smithy.api#documentation": "

The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

" - } - }, - "executionRole": { - "target": "com.amazonaws.finspace#ExecutionRoleArn", - "traits": { - "smithy.api#documentation": "

An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.

" - } - }, - "savedownStorageConfiguration": { - "target": "com.amazonaws.finspace#KxSavedownStorageConfiguration", - "traits": { - "smithy.api#documentation": "

The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "

The number of availability zones you want to assign per cluster. This can be one of the following

\n ", - "smithy.api#required": {} - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "

The availability zone identifiers for the requested regions.

" - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "

A list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.

" - } - }, - "scalingGroupConfiguration": { - "target": "com.amazonaws.finspace#KxScalingGroupConfiguration", - "traits": { - "smithy.api#documentation": "

The structure that stores the configuration details of a scaling group.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxClusterResponse": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

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

The status of cluster creation.

\n " - } - }, - "statusReason": { - "target": "com.amazonaws.finspace#KxClusterStatusReason", - "traits": { - "smithy.api#documentation": "

The error message when a failed state occurs.

" - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "

A unique name for the cluster.

" - } - }, - "clusterType": { - "target": "com.amazonaws.finspace#KxClusterType", - "traits": { - "smithy.api#documentation": "

Specifies the type of KDB database that is being created. The following types are available:

\n " - } - }, - "tickerplantLogConfiguration": { - "target": "com.amazonaws.finspace#TickerplantLogConfiguration" - }, - "volumes": { - "target": "com.amazonaws.finspace#Volumes", - "traits": { - "smithy.api#documentation": "

\nA list of volumes mounted on the cluster.\n

" - } - }, - "databases": { - "target": "com.amazonaws.finspace#KxDatabaseConfigurations", - "traits": { - "smithy.api#documentation": "

A list of databases that will be available for querying.

" - } - }, - "cacheStorageConfigurations": { - "target": "com.amazonaws.finspace#KxCacheStorageConfigurations", - "traits": { - "smithy.api#documentation": "

The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

" - } - }, - "autoScalingConfiguration": { - "target": "com.amazonaws.finspace#AutoScalingConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

" - } - }, - "clusterDescription": { - "target": "com.amazonaws.finspace#KxClusterDescription", - "traits": { - "smithy.api#documentation": "

A description of the cluster.

" - } - }, - "capacityConfiguration": { - "target": "com.amazonaws.finspace#CapacityConfiguration", - "traits": { - "smithy.api#documentation": "

A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

" - } - }, - "releaseLabel": { - "target": "com.amazonaws.finspace#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

A version of the FinSpace managed kdb to run.

" - } - }, - "vpcConfiguration": { - "target": "com.amazonaws.finspace#VpcConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration details about the network where the Privatelink endpoint of the cluster resides.

" - } - }, - "initializationScript": { - "target": "com.amazonaws.finspace#InitializationScriptFilePath", - "traits": { - "smithy.api#documentation": "

Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.

" - } - }, - "commandLineArguments": { - "target": "com.amazonaws.finspace#KxCommandLineArguments", - "traits": { - "smithy.api#documentation": "

Defines the key-value pairs to make them available inside the cluster.

" - } - }, - "code": { - "target": "com.amazonaws.finspace#CodeConfiguration", - "traits": { - "smithy.api#documentation": "

The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

" - } - }, - "executionRole": { - "target": "com.amazonaws.finspace#ExecutionRoleArn", - "traits": { - "smithy.api#documentation": "

\n An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.\n

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that the cluster 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.

" - } - }, - "savedownStorageConfiguration": { - "target": "com.amazonaws.finspace#KxSavedownStorageConfiguration", - "traits": { - "smithy.api#documentation": "

The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "

The number of availability zones you want to assign per cluster. This can be one of the following

\n " - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "

\n The availability zone identifiers for the requested regions.\n

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the cluster 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.

" - } - }, - "scalingGroupConfiguration": { - "target": "com.amazonaws.finspace#KxScalingGroupConfiguration", - "traits": { - "smithy.api#documentation": "

The structure that stores the configuration details of a scaling group.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CreateKxDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateKxDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateKxDatabaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new kdb database in the environment.

", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments/{environmentId}/databases", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxDatabaseRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the kdb database.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

A description of the database.

" - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "

A list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database

" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxDatabaseResponse": { - "type": "structure", - "members": { - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the kdb database.

" - } - }, - "databaseArn": { - "target": "com.amazonaws.finspace#DatabaseArn", - "traits": { - "smithy.api#documentation": "

The ARN identifier of the database.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

A description of the database.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the database is 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.

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that the database was updated 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.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CreateKxDataview": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateKxDataviewRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateKxDataviewResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\nCreates 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.

", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/dataviews", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxDataviewRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, where you want to create the dataview.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

\nThe name of the database where you want to create a dataview.\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the dataview.

", - "smithy.api#required": {} - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

", - "smithy.api#required": {} - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "

\n The identifier of the availability zones.\n

" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "

\nA unique identifier of the changeset that you want to use to ingest data.

" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "

\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

" - } - }, - "autoUpdate": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false.

" - } - }, - "readWrite": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.\u2028\u2028

\n " - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

A description of the dataview.

" - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "

\nA list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.\n

" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxDataviewResponse": { - "type": "structure", - "members": { - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the dataview.

" - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the database where you want to create a dataview.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, where you want to create the dataview.

" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

" - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "

\n The identifier of the availability zones.\n

" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the changeset.

" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "

\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

A description of the dataview.

" - } - }, - "autoUpdate": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The option to select whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false.

" - } - }, - "readWrite": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Returns True if the dataview is created as writeable and False otherwise.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\nThe 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.

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\nThe last time that the dataview was updated 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.

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

\nThe status of dataview creation.

\n " - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CreateKxEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateKxEnvironmentRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateKxEnvironmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ServiceQuotaExceededException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a managed kdb environment for the account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxEnvironmentRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#KxEnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the kdb environment that you want to create.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

A description for the kdb environment.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyARN", - "traits": { - "smithy.api#documentation": "

The KMS key ID to encrypt your data in the FinSpace environment.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "

A list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.

" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxEnvironmentResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#KxEnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the kdb environment.

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

The status of the kdb environment.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

A description for the kdb environment.

" - } - }, - "environmentArn": { - "target": "com.amazonaws.finspace#EnvironmentArn", - "traits": { - "smithy.api#documentation": "

The ARN identifier of the environment.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The KMS key ID to encrypt your data in the FinSpace environment.

" - } - }, - "creationTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the kdb environment was created in FinSpace.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CreateKxScalingGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateKxScalingGroupRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateKxScalingGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new scaling group.

", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments/{environmentId}/scalingGroups", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxScalingGroupRequest": { - "type": "structure", - "members": { - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, where you want to create the scaling group.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "scalingGroupName": { - "target": "com.amazonaws.finspace#KxScalingGroupName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb scaling group.

", - "smithy.api#required": {} - } - }, - "hostType": { - "target": "com.amazonaws.finspace#KxHostType", - "traits": { - "smithy.api#documentation": "

\n The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.

\n

You can add one of the following values:

\n ", - "smithy.api#required": {} - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "

The identifier of the availability zones.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "

\nA list of key-value pairs to label the scaling group. You can add up to 50 tags to a scaling group.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxScalingGroupResponse": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, where you create the scaling group.

" - } - }, - "scalingGroupName": { - "target": "com.amazonaws.finspace#KxScalingGroupName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb scaling group.

" - } - }, - "hostType": { - "target": "com.amazonaws.finspace#KxHostType", - "traits": { - "smithy.api#documentation": "

\n The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.\n \n

" - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "

The identifier of the availability zones.

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

The status of scaling group.

\n " - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\nThe last time that the scaling group was updated 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.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\n The timestamp at which the scaling group 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.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CreateKxUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateKxUserRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateKxUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a user in FinSpace kdb environment with an associated IAM role.

", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments/{environmentId}/users", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxUserRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment where you want to create a user.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "userName": { - "target": "com.amazonaws.finspace#KxUserNameString", - "traits": { - "smithy.api#documentation": "

A unique identifier for the user.

", - "smithy.api#required": {} - } - }, - "iamRole": { - "target": "com.amazonaws.finspace#RoleArn", - "traits": { - "smithy.api#documentation": "

The IAM role ARN that will be associated with the user.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "

A list of key-value pairs to label the user. You can add up to 50 tags to a user.

" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxUserResponse": { - "type": "structure", - "members": { - "userName": { - "target": "com.amazonaws.finspace#KxUserNameString", - "traits": { - "smithy.api#documentation": "

A unique identifier for the user.

" - } - }, - "userArn": { - "target": "com.amazonaws.finspace#KxUserArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and\n how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

" - } - }, - "iamRole": { - "target": "com.amazonaws.finspace#RoleArn", - "traits": { - "smithy.api#documentation": "

The IAM role ARN that will be associated with the user.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CreateKxVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#CreateKxVolumeRequest" - }, - "output": { - "target": "com.amazonaws.finspace#CreateKxVolumeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\nCreates a new volume with a specific amount of throughput and storage capacity.

", - "smithy.api#http": { - "method": "POST", - "uri": "/kx/environments/{environmentId}/kxvolumes", - "code": 200 - } - } - }, - "com.amazonaws.finspace#CreateKxVolumeRequest": { - "type": "structure", - "members": { - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, whose clusters can attach to the volume.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "volumeType": { - "target": "com.amazonaws.finspace#KxVolumeType", - "traits": { - "smithy.api#documentation": "

\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type. When you select NAS_1 volume type, you must also provide nas1Configuration.\n

", - "smithy.api#required": {} - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the volume.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

\nA description of the volume.\n

" - } - }, - "nas1Configuration": { - "target": "com.amazonaws.finspace#KxNAS1Configuration", - "traits": { - "smithy.api#documentation": "

Specifies the configuration for the Network attached storage (NAS_1) file system volume. This\n parameter is required when you choose volumeType as\n NAS_1.

" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

", - "smithy.api#required": {} - } - }, - "availabilityZoneIds": { - "target": "com.amazonaws.finspace#AvailabilityZoneIds", - "traits": { - "smithy.api#documentation": "

The identifier of the availability zones.

", - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "

\nA list of key-value pairs to label the volume. You can add up to 50 tags to a volume.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#CreateKxVolumeResponse": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, whose clusters can attach to the volume.

" - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the volume.

" - } - }, - "volumeType": { - "target": "com.amazonaws.finspace#KxVolumeType", - "traits": { - "smithy.api#documentation": "

\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n

" - } - }, - "volumeArn": { - "target": "com.amazonaws.finspace#KxVolumeArn", - "traits": { - "smithy.api#documentation": "

\nThe ARN identifier of the volume.\n

" - } - }, - "nas1Configuration": { - "target": "com.amazonaws.finspace#KxNAS1Configuration", - "traits": { - "smithy.api#documentation": "

Specifies the configuration for the Network attached storage (NAS_1) file system volume.

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

The status of volume creation.

\n " - } - }, - "statusReason": { - "target": "com.amazonaws.finspace#KxVolumeStatusReason", - "traits": { - "smithy.api#documentation": "

The error message when a failed state occurs.

" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

\nA description of the volume.\n

" - } - }, - "availabilityZoneIds": { - "target": "com.amazonaws.finspace#AvailabilityZoneIds", - "traits": { - "smithy.api#documentation": "

The identifier of the availability zones.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the volume 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.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#CustomDNSConfiguration": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#CustomDNSServer" - } - }, - "com.amazonaws.finspace#CustomDNSServer": { - "type": "structure", - "members": { - "customDNSServerName": { - "target": "com.amazonaws.finspace#ValidHostname", - "traits": { - "smithy.api#documentation": "

The name of the DNS server.

", - "smithy.api#required": {} - } - }, - "customDNSServerIP": { - "target": "com.amazonaws.finspace#ValidIPAddress", - "traits": { - "smithy.api#documentation": "

The IP address of the DNS server.

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

A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

" - } - }, - "com.amazonaws.finspace#DataBundleArn": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data bundle.

", - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d*:data-bundle/[0-9A-Za-z_-]{1,128}$" - } - }, - "com.amazonaws.finspace#DataBundleArns": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#DataBundleArn" - } - }, - "com.amazonaws.finspace#DatabaseArn": { - "type": "string" - }, - "com.amazonaws.finspace#DatabaseName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#DbPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1025 - }, - "smithy.api#pattern": "^(\\*)*[\\/\\?\\*]([^\\/]+\\/){0,2}[^\\/]*$" - } - }, - "com.amazonaws.finspace#DbPaths": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#DbPath" - } - }, - "com.amazonaws.finspace#DeleteEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteEnvironmentRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteEnvironmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Delete an FinSpace environment.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/environment/{environmentId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteEnvironmentRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

The identifier for the FinSpace environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteEnvironmentResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxClusterRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a kdb cluster.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}/clusters/{clusterName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxClusterNode": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxClusterNodeRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxClusterNodeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the specified nodes from a cluster.\n

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}/clusters/{clusterName}/nodes/{nodeId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxClusterNodeRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "

The name of the cluster, for which you want to delete the nodes.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nodeId": { - "target": "com.amazonaws.finspace#KxClusterNodeIdString", - "traits": { - "smithy.api#documentation": "

A unique identifier for the node that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxClusterNodeResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxClusterRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "

The name of the cluster that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxClusterResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxDatabaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxDatabaseRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the kdb database that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxDatabaseResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxDataview": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxDataviewRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxDataviewResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\nDeletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/dataviews/{dataviewName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxDataviewRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, from where you want to delete the dataview.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the database whose dataview you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "

The name of the dataview that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxDataviewResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxEnvironmentRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxEnvironmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxEnvironmentRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxEnvironmentResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxScalingGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxScalingGroupRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxScalingGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\nDeletes the specified scaling group. This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}/scalingGroups/{scalingGroupName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxScalingGroupRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, from where you want to delete the dataview.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "scalingGroupName": { - "target": "com.amazonaws.finspace#KxScalingGroupName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb scaling group.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxScalingGroupResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxUserRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a user in the specified kdb environment.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}/users/{userName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxUserRequest": { - "type": "structure", - "members": { - "userName": { - "target": "com.amazonaws.finspace#KxUserNameString", - "traits": { - "smithy.api#documentation": "

A unique identifier for the user that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxUserResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#DeleteKxVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#DeleteKxVolumeRequest" - }, - "output": { - "target": "com.amazonaws.finspace#DeleteKxVolumeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n 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\n

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/kx/environments/{environmentId}/kxvolumes/{volumeName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#DeleteKxVolumeRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, whose clusters can attach to the volume.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "

\nThe name of the volume that you want to delete.\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#DeleteKxVolumeResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#Description": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^[a-zA-Z0-9. ]{1,1000}$" - } - }, - "com.amazonaws.finspace#EmailId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+[.]+[A-Za-z]+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.finspace#Environment": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#EnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the FinSpace environment.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

The identifier of the FinSpace environment.

" - } - }, - "awsAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

The ID of the AWS account in which the FinSpace environment is created.

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

The current status of creation of the FinSpace environment.

" - } - }, - "environmentUrl": { - "target": "com.amazonaws.finspace#url", - "traits": { - "smithy.api#documentation": "

The sign-in URL for the web application of your FinSpace environment.

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

The description of the FinSpace environment.

" - } - }, - "environmentArn": { - "target": "com.amazonaws.finspace#EnvironmentArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of your FinSpace environment.

" - } - }, - "sageMakerStudioDomainUrl": { - "target": "com.amazonaws.finspace#SmsDomainUrl", - "traits": { - "smithy.api#documentation": "

The URL of the integrated FinSpace notebook environment in your web application.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The KMS key id used to encrypt in the FinSpace environment.

" - } - }, - "dedicatedServiceAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

The AWS account ID of the dedicated service account associated with your FinSpace\n environment.

" - } - }, - "federationMode": { - "target": "com.amazonaws.finspace#FederationMode", - "traits": { - "smithy.api#documentation": "

The authentication mode for the environment.

" - } - }, - "federationParameters": { - "target": "com.amazonaws.finspace#FederationParameters", - "traits": { - "smithy.api#documentation": "

Configuration information when authentication mode is FEDERATED.

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

Represents an FinSpace environment.

" - } - }, - "com.amazonaws.finspace#EnvironmentArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:environment/[0-9A-Za-z_-]{1,128}$" - } - }, - "com.amazonaws.finspace#EnvironmentErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - }, - "smithy.api#pattern": "^[a-zA-Z0-9. ]{1,1000}$" - } - }, - "com.amazonaws.finspace#EnvironmentId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.finspace#EnvironmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#Environment" - } - }, - "com.amazonaws.finspace#EnvironmentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#EnvironmentStatus": { - "type": "enum", - "members": { - "CREATE_REQUESTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_REQUESTED" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "CREATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATED" - } - }, - "DELETE_REQUESTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_REQUESTED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "FAILED_CREATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_CREATION" - } - }, - "RETRY_DELETION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RETRY_DELETION" - } - }, - "FAILED_DELETION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_DELETION" - } - }, - "UPDATE_NETWORK_REQUESTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_NETWORK_REQUESTED" - } - }, - "UPDATING_NETWORK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING_NETWORK" - } - }, - "FAILED_UPDATING_NETWORK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_UPDATING_NETWORK" - } - }, - "SUSPENDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUSPENDED" - } - } - } - }, - "com.amazonaws.finspace#ErrorDetails": { - "type": "enum", - "members": { - "VALIDATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "The inputs to this request are invalid." - } - }, - "SERVICE_QUOTA_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Service limits have been exceeded." - } - }, - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Missing required permission to perform this request." - } - }, - "RESOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "One or more inputs to this request were not found." - } - }, - "THROTTLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "The system temporarily lacks sufficient resources to process the request." - } - }, - "INTERNAL_SERVICE_EXCEPTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "An internal error has occurred." - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Cancelled" - } - }, - "USER_RECOVERABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A user recoverable error has occurred" - } - } - } - }, - "com.amazonaws.finspace#ErrorInfo": { - "type": "structure", - "members": { - "errorMessage": { - "target": "com.amazonaws.finspace#ErrorMessage", - "traits": { - "smithy.api#documentation": "

Specifies the error message that appears if a flow fails.

" - } - }, - "errorType": { - "target": "com.amazonaws.finspace#ErrorDetails", - "traits": { - "smithy.api#documentation": "

Specifies the type of error.

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

Provides details in the event of a failed flow, including the error type and the related error message.

" - } - }, - "com.amazonaws.finspace#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.finspace#ErrorMessage2": { - "type": "string" - }, - "com.amazonaws.finspace#ExecutionRoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^arn:aws[a-z0-9-]*:iam::\\d{12}:role\\/[\\w-\\/.@+=,]{1,1017}$" - } - }, - "com.amazonaws.finspace#FederationAttributeKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.finspace#FederationAttributeValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.finspace#FederationMode": { - "type": "enum", - "members": { - "FEDERATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FEDERATED" - } - }, - "LOCAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOCAL" - } - } - } - }, - "com.amazonaws.finspace#FederationParameters": { - "type": "structure", - "members": { - "samlMetadataDocument": { - "target": "com.amazonaws.finspace#SamlMetadataDocument", - "traits": { - "smithy.api#documentation": "

SAML 2.0 Metadata document from identity provider (IdP).

" - } - }, - "samlMetadataURL": { - "target": "com.amazonaws.finspace#url", - "traits": { - "smithy.api#documentation": "

Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

" - } - }, - "applicationCallBackURL": { - "target": "com.amazonaws.finspace#url", - "traits": { - "smithy.api#documentation": "

The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration\n (IdP).

" - } - }, - "federationURN": { - "target": "com.amazonaws.finspace#urn", - "traits": { - "smithy.api#documentation": "

The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

" - } - }, - "federationProviderName": { - "target": "com.amazonaws.finspace#FederationProviderName", - "traits": { - "smithy.api#documentation": "

Name of the identity provider (IdP).

" - } - }, - "attributeMap": { - "target": "com.amazonaws.finspace#AttributeMap", - "traits": { - "smithy.api#documentation": "

SAML attribute name and value. The name must always be Email and the value should be set to\n the attribute definition in which user email is set. For example, name would be Email and\n value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress.\n Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

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

Configuration information when authentication mode is FEDERATED.

" - } - }, - "com.amazonaws.finspace#FederationProviderName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+$" - } - }, - "com.amazonaws.finspace#FinSpaceTaggableArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:(environment|kxEnvironment)/[0-9A-Za-z_-]{1,128}(/(kxCluster|kxUser|kxVolume|kxScalingGroup)/[a-zA-Z0-9_-]{1,255}|/(kxDatabase/[a-zA-Z0-9_-]{1,255}(/kxDataview/[a-zA-Z0-9_-]{1,255})?))?$" - } - }, - "com.amazonaws.finspace#GetEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetEnvironmentRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetEnvironmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Returns the FinSpace environment object.

", - "smithy.api#http": { - "method": "GET", - "uri": "/environment/{environmentId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetEnvironmentRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

The identifier of the FinSpace environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetEnvironmentResponse": { - "type": "structure", - "members": { - "environment": { - "target": "com.amazonaws.finspace#Environment", - "traits": { - "smithy.api#documentation": "

The name of the FinSpace environment.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxChangeset": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxChangesetRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxChangesetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a kdb changeset.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/changesets/{changesetId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxChangesetRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the kdb database.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "

A unique identifier of the changeset for which you want to retrieve data.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxChangesetResponse": { - "type": "structure", - "members": { - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the changeset.

" - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the kdb database.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

" - } - }, - "changeRequests": { - "target": "com.amazonaws.finspace#ChangeRequests", - "traits": { - "smithy.api#documentation": "

A list of change request objects that are run in order.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "activeFromTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

Beginning time from which the changeset is active. The value is determined as epoch time in\n milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as\n 1635768000000.

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the changeset was updated 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.

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

Status of the changeset creation process.

\n " - } - }, - "errorInfo": { - "target": "com.amazonaws.finspace#ErrorInfo", - "traits": { - "smithy.api#documentation": "

Provides details in the event of a failed flow, including the error type and the related error message.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxCluster": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxClusterRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxClusterResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves information about a kdb cluster.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/clusters/{clusterName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxClusterRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "

The name of the cluster that you want to retrieve.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxClusterResponse": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.finspace#KxClusterStatus", - "traits": { - "smithy.api#documentation": "

The status of cluster creation.

\n " - } - }, - "statusReason": { - "target": "com.amazonaws.finspace#KxClusterStatusReason", - "traits": { - "smithy.api#documentation": "

The error message when a failed state occurs.

" - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "

A unique name for the cluster.

" - } - }, - "clusterType": { - "target": "com.amazonaws.finspace#KxClusterType", - "traits": { - "smithy.api#documentation": "

Specifies the type of KDB database that is being created. The following types are available:

\n " - } - }, - "tickerplantLogConfiguration": { - "target": "com.amazonaws.finspace#TickerplantLogConfiguration" - }, - "volumes": { - "target": "com.amazonaws.finspace#Volumes", - "traits": { - "smithy.api#documentation": "

\nA list of volumes attached to the cluster.\n

" - } - }, - "databases": { - "target": "com.amazonaws.finspace#KxDatabaseConfigurations", - "traits": { - "smithy.api#documentation": "

A list of databases mounted on the cluster.

" - } - }, - "cacheStorageConfigurations": { - "target": "com.amazonaws.finspace#KxCacheStorageConfigurations", - "traits": { - "smithy.api#documentation": "

The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.

" - } - }, - "autoScalingConfiguration": { - "target": "com.amazonaws.finspace#AutoScalingConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration based on which FinSpace will scale in or scale out nodes in your cluster.

" - } - }, - "clusterDescription": { - "target": "com.amazonaws.finspace#KxClusterDescription", - "traits": { - "smithy.api#documentation": "

A description of the cluster.

" - } - }, - "capacityConfiguration": { - "target": "com.amazonaws.finspace#CapacityConfiguration", - "traits": { - "smithy.api#documentation": "

A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.

" - } - }, - "releaseLabel": { - "target": "com.amazonaws.finspace#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

The version of FinSpace managed kdb to run.

" - } - }, - "vpcConfiguration": { - "target": "com.amazonaws.finspace#VpcConfiguration", - "traits": { - "smithy.api#documentation": "

Configuration details about the network where the Privatelink endpoint of the cluster resides.

" - } - }, - "initializationScript": { - "target": "com.amazonaws.finspace#InitializationScriptFilePath", - "traits": { - "smithy.api#documentation": "

Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.

" - } - }, - "commandLineArguments": { - "target": "com.amazonaws.finspace#KxCommandLineArguments", - "traits": { - "smithy.api#documentation": "

Defines key-value pairs to make them available inside the cluster.

" - } - }, - "code": { - "target": "com.amazonaws.finspace#CodeConfiguration", - "traits": { - "smithy.api#documentation": "

The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.

" - } - }, - "executionRole": { - "target": "com.amazonaws.finspace#ExecutionRoleArn", - "traits": { - "smithy.api#documentation": "

\n An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.\n

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that the cluster 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.

" - } - }, - "savedownStorageConfiguration": { - "target": "com.amazonaws.finspace#KxSavedownStorageConfiguration", - "traits": { - "smithy.api#documentation": "

The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose clusterType as RDB. All the data written to this storage space is lost when the cluster node is restarted.

" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "

The number of availability zones you want to assign per cluster. This can be one of the following

\n " - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "

\n The availability zone identifiers for the requested regions.\n

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the cluster 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.

" - } - }, - "scalingGroupConfiguration": { - "target": "com.amazonaws.finspace#KxScalingGroupConfiguration" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxConnectionString": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxConnectionStringRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxConnectionStringResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/connectionString", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxConnectionStringRequest": { - "type": "structure", - "members": { - "userArn": { - "target": "com.amazonaws.finspace#KxUserArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and\n how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.

", - "smithy.api#httpQuery": "userArn", - "smithy.api#required": {} - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "

A name of the kdb cluster.

", - "smithy.api#httpQuery": "clusterName", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxConnectionStringResponse": { - "type": "structure", - "members": { - "signedConnectionString": { - "target": "com.amazonaws.finspace#SignedKxConnectionString", - "traits": { - "smithy.api#documentation": "

The signed connection string that you can use to connect to clusters.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxDatabaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns database information for the specified environment ID.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxDatabaseRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the kdb database.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxDatabaseResponse": { - "type": "structure", - "members": { - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the kdb database for which the information is retrieved.

" - } - }, - "databaseArn": { - "target": "com.amazonaws.finspace#DatabaseArn", - "traits": { - "smithy.api#documentation": "

The ARN identifier of the database.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

A description of the database.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the database is 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.

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that the database 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.

" - } - }, - "lastCompletedChangesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the changeset.

" - } - }, - "numBytes": { - "target": "com.amazonaws.finspace#numBytes", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of bytes in the database.

" - } - }, - "numChangesets": { - "target": "com.amazonaws.finspace#numChangesets", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of changesets in the database.

" - } - }, - "numFiles": { - "target": "com.amazonaws.finspace#numFiles", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The total number of files in the database.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxDataview": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxDataviewRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxDataviewResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\nRetrieves details of the dataview.\n

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/dataviews/{dataviewName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxDataviewRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, from where you want to retrieve the dataview details.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

\nThe name of the database where you created the dataview.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the dataview.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxDataviewResponse": { - "type": "structure", - "members": { - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

\nThe name of the database where you created the dataview.

" - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the dataview.

" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

" - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "

\n The identifier of the availability zones.\n

" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "

\nA unique identifier of the changeset that you want to use to ingest data.

" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "

\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

" - } - }, - "activeVersions": { - "target": "com.amazonaws.finspace#KxDataviewActiveVersionList", - "traits": { - "smithy.api#documentation": "

\n The current active changeset versions of the database on the given dataview. \n \n

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

A description of the dataview.

" - } - }, - "autoUpdate": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.

" - } - }, - "readWrite": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Returns True if the dataview is created as writeable and False otherwise.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, from where you want to retrieve the dataview details.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\n The last time that the dataview was updated 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.\n

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

\n The status of dataview creation.

\n " - } - }, - "statusReason": { - "target": "com.amazonaws.finspace#KxDataviewStatusReason", - "traits": { - "smithy.api#documentation": "

\nThe error message when a failed state occurs. \n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxEnvironmentRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxEnvironmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves all the information for the specified kdb environment.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxEnvironmentRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxEnvironmentResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#KxEnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the kdb environment.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

" - } - }, - "awsAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

The unique identifier of the AWS account that is used to create the kdb environment.

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

The status of the kdb environment.

" - } - }, - "tgwStatus": { - "target": "com.amazonaws.finspace#tgwStatus", - "traits": { - "smithy.api#documentation": "

The status of the network configuration.

" - } - }, - "dnsStatus": { - "target": "com.amazonaws.finspace#dnsStatus", - "traits": { - "smithy.api#documentation": "

The status of DNS configuration.

" - } - }, - "errorMessage": { - "target": "com.amazonaws.finspace#EnvironmentErrorMessage", - "traits": { - "smithy.api#documentation": "

Specifies the error message that appears if a flow fails.

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

A description for the kdb environment.

" - } - }, - "environmentArn": { - "target": "com.amazonaws.finspace#EnvironmentArn", - "traits": { - "smithy.api#documentation": "

The ARN identifier of the environment.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The KMS key ID to encrypt your data in the FinSpace environment.

" - } - }, - "dedicatedServiceAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the AWS environment infrastructure account.

" - } - }, - "transitGatewayConfiguration": { - "target": "com.amazonaws.finspace#TransitGatewayConfiguration" - }, - "customDNSConfiguration": { - "target": "com.amazonaws.finspace#CustomDNSConfiguration", - "traits": { - "smithy.api#documentation": "

A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

" - } - }, - "creationTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the kdb environment was created in FinSpace.

" - } - }, - "updateTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the kdb environment was updated.

" - } - }, - "availabilityZoneIds": { - "target": "com.amazonaws.finspace#AvailabilityZoneIds", - "traits": { - "smithy.api#documentation": "

The identifier of the availability zones where subnets for the environment are created.

" - } - }, - "certificateAuthorityArn": { - "target": "com.amazonaws.finspace#stringValueLength1to255", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate authority of the \n kdb environment.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxScalingGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxScalingGroupRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxScalingGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\nRetrieves details of a scaling group.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/scalingGroups/{scalingGroupName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxScalingGroupRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "scalingGroupName": { - "target": "com.amazonaws.finspace#KxScalingGroupName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb scaling group.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxScalingGroupResponse": { - "type": "structure", - "members": { - "scalingGroupName": { - "target": "com.amazonaws.finspace#KxScalingGroupName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb scaling group.

" - } - }, - "scalingGroupArn": { - "target": "com.amazonaws.finspace#arn", - "traits": { - "smithy.api#documentation": "

\n The ARN identifier for the scaling group.\n

" - } - }, - "hostType": { - "target": "com.amazonaws.finspace#KxHostType", - "traits": { - "smithy.api#documentation": "

\n The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.

\n

It can have one of the following values:

\n " - } - }, - "clusters": { - "target": "com.amazonaws.finspace#KxClusterNameList", - "traits": { - "smithy.api#documentation": "

\n The list of Managed kdb clusters that are currently active in the given scaling group.\n \n

" - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "

The identifier of the availability zones.

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

The status of scaling group.

\n " - } - }, - "statusReason": { - "target": "com.amazonaws.finspace#KxClusterStatusReason", - "traits": { - "smithy.api#documentation": "

\nThe error message when a failed state occurs. \n

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\n The last time that the scaling group was updated 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.\n

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\n The timestamp at which the scaling group 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.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxUserRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Retrieves information about the specified kdb user.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/users/{userName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxUserRequest": { - "type": "structure", - "members": { - "userName": { - "target": "com.amazonaws.finspace#KxUserNameString", - "traits": { - "smithy.api#documentation": "

A unique identifier for the user.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxUserResponse": { - "type": "structure", - "members": { - "userName": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the user.

" - } - }, - "userArn": { - "target": "com.amazonaws.finspace#KxUserArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and\n how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

" - } - }, - "iamRole": { - "target": "com.amazonaws.finspace#RoleArn", - "traits": { - "smithy.api#documentation": "

The IAM role ARN that is associated with the user.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#GetKxVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#GetKxVolumeRequest" - }, - "output": { - "target": "com.amazonaws.finspace#GetKxVolumeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\nRetrieves the information about the volume.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/kxvolumes/{volumeName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#GetKxVolumeRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, whose clusters can attach to the volume.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the volume.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#GetKxVolumeResponse": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, whose clusters can attach to the volume.

" - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "

\nA unique identifier for the volume.

" - } - }, - "volumeType": { - "target": "com.amazonaws.finspace#KxVolumeType", - "traits": { - "smithy.api#documentation": "

\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n

" - } - }, - "volumeArn": { - "target": "com.amazonaws.finspace#KxVolumeArn", - "traits": { - "smithy.api#documentation": "

\nThe ARN identifier of the volume.\n

" - } - }, - "nas1Configuration": { - "target": "com.amazonaws.finspace#KxNAS1Configuration", - "traits": { - "smithy.api#documentation": "

Specifies the configuration for the Network attached storage (NAS_1) file system volume.

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

The status of volume creation.

\n " - } - }, - "statusReason": { - "target": "com.amazonaws.finspace#KxVolumeStatusReason", - "traits": { - "smithy.api#documentation": "

The error message when a failed state occurs.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\nThe timestamp at which the volume 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.\n

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

\nA description of the volume.\n

" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

" - } - }, - "availabilityZoneIds": { - "target": "com.amazonaws.finspace#AvailabilityZoneIds", - "traits": { - "smithy.api#documentation": "

The identifier of the availability zones.

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that the volume was updated 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.

" - } - }, - "attachedClusters": { - "target": "com.amazonaws.finspace#KxAttachedClusters", - "traits": { - "smithy.api#documentation": "

\nA list of cluster identifiers that a volume is attached to. \n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#IPAddressType": { - "type": "enum", - "members": { - "IP_V4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IP_V4" - } - } - } - }, - "com.amazonaws.finspace#IcmpTypeCode": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.finspace#IcmpTypeOrCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The ICMP type. A value of -1 means all types.\n

", - "smithy.api#required": {} - } - }, - "code": { - "target": "com.amazonaws.finspace#IcmpTypeOrCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The ICMP code. A value of -1 means all codes for the specified ICMP type.\n

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

\n Defines the ICMP protocol that consists of the ICMP type and code.\n

" - } - }, - "com.amazonaws.finspace#IcmpTypeOrCode": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.finspace#IdType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 26 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]{1,26}$" - } - }, - "com.amazonaws.finspace#InitializationScriptFilePath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-\\.\\/\\\\]+$" - } - }, - "com.amazonaws.finspace#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception or\n failure.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.finspace#InvalidRequestException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "

The request is invalid. Something is wrong with the input to the request.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.finspace#KmsKeyARN": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^arn:aws:kms:.*:\\d+:.*$" - } - }, - "com.amazonaws.finspace#KmsKeyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^[a-zA-Z-0-9-:\\/]*$" - } - }, - "com.amazonaws.finspace#KxAttachedCluster": { - "type": "structure", - "members": { - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "

A unique name for the attached cluster.

" - } - }, - "clusterType": { - "target": "com.amazonaws.finspace#KxClusterType", - "traits": { - "smithy.api#documentation": "

Specifies the type of cluster. The volume for TP and RDB cluster types will be used for TP logs.

" - } - }, - "clusterStatus": { - "target": "com.amazonaws.finspace#KxClusterStatus", - "traits": { - "smithy.api#documentation": "

The status of the attached cluster.

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

The structure containing the metadata of the attached clusters.

" - } - }, - "com.amazonaws.finspace#KxAttachedClusters": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxAttachedCluster" - } - }, - "com.amazonaws.finspace#KxAzMode": { - "type": "enum", - "members": { - "SINGLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE" - } - }, - "MULTI": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MULTI" - } - } - } - }, - "com.amazonaws.finspace#KxCacheStorageConfiguration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.finspace#KxCacheStorageType", - "traits": { - "smithy.api#documentation": "

The type of cache storage. The valid values are:

\n \n

For cache type CACHE_1000 and CACHE_250 you can select cache size as 1200 GB or increments of 2400 GB. For cache type CACHE_12 you can select the cache size in increments of 6000 GB.

", - "smithy.api#required": {} - } - }, - "size": { - "target": "com.amazonaws.finspace#KxCacheStorageSize", - "traits": { - "smithy.api#documentation": "

The size of cache in Gigabytes.

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

The configuration for read only disk cache associated with a cluster.

" - } - }, - "com.amazonaws.finspace#KxCacheStorageConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxCacheStorageConfiguration" - } - }, - "com.amazonaws.finspace#KxCacheStorageSize": { - "type": "integer" - }, - "com.amazonaws.finspace#KxCacheStorageType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 8, - "max": 10 - } - } - }, - "com.amazonaws.finspace#KxChangesetListEntry": { - "type": "structure", - "members": { - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the changeset.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "activeFromTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

Beginning time from which the changeset is active. The value is determined as epoch time in\n milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as\n 1635768000000.

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the changeset 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\n 1635768000000.

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

Status of the changeset.

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

Details of changeset.

" - } - }, - "com.amazonaws.finspace#KxChangesets": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxChangesetListEntry" - } - }, - "com.amazonaws.finspace#KxCluster": { - "type": "structure", - "members": { - "status": { - "target": "com.amazonaws.finspace#KxClusterStatus", - "traits": { - "smithy.api#documentation": "

The status of a cluster.

\n " - } - }, - "statusReason": { - "target": "com.amazonaws.finspace#KxClusterStatusReason", - "traits": { - "smithy.api#documentation": "

The error message when a failed state occurs.

" - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "

A unique name for the cluster.

" - } - }, - "clusterType": { - "target": "com.amazonaws.finspace#KxClusterType", - "traits": { - "smithy.api#documentation": "

Specifies the type of KDB database that is being created. The following types are available:

\n " - } - }, - "clusterDescription": { - "target": "com.amazonaws.finspace#KxClusterDescription", - "traits": { - "smithy.api#documentation": "

A description of the cluster.

" - } - }, - "releaseLabel": { - "target": "com.amazonaws.finspace#ReleaseLabel", - "traits": { - "smithy.api#documentation": "

A version of the FinSpace managed kdb to run.

" - } - }, - "volumes": { - "target": "com.amazonaws.finspace#Volumes", - "traits": { - "smithy.api#documentation": "

\nA list of volumes attached to the cluster.\n

" - } - }, - "initializationScript": { - "target": "com.amazonaws.finspace#InitializationScriptFilePath", - "traits": { - "smithy.api#documentation": "

Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.

" - } - }, - "executionRole": { - "target": "com.amazonaws.finspace#ExecutionRoleArn", - "traits": { - "smithy.api#documentation": "

\n An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.\n

" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "

The number of availability zones assigned per cluster. This can be one of the following:

\n " - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "

\n The availability zone identifiers for the requested regions.\n

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that the cluster 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.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the cluster 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.

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

The details of a kdb cluster.

" - } - }, - "com.amazonaws.finspace#KxClusterCodeDeploymentConfiguration": { - "type": "structure", - "members": { - "deploymentStrategy": { - "target": "com.amazonaws.finspace#KxClusterCodeDeploymentStrategy", - "traits": { - "smithy.api#documentation": "

\n The type of deployment that you want on a cluster.\n \n

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

\n The configuration that allows you to choose how you want to update code on a cluster. Depending on the option you choose, you can reduce the time it takes to update the cluster.\n

" - } - }, - "com.amazonaws.finspace#KxClusterCodeDeploymentStrategy": { - "type": "enum", - "members": { - "NO_RESTART": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_RESTART" - } - }, - "ROLLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLING" - } - }, - "FORCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FORCE" - } - } - } - }, - "com.amazonaws.finspace#KxClusterDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-\\.\\s]+$" - } - }, - "com.amazonaws.finspace#KxClusterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#KxClusterNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxClusterName" - } - }, - "com.amazonaws.finspace#KxClusterNodeIdString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 40 - } - } - }, - "com.amazonaws.finspace#KxClusterStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - } - } - }, - "com.amazonaws.finspace#KxClusterStatusReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 250 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-\\.\\s]+$" - } - }, - "com.amazonaws.finspace#KxClusterType": { - "type": "enum", - "members": { - "HDB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HDB" - } - }, - "RDB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RDB" - } - }, - "GATEWAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GATEWAY" - } - }, - "GP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GP" - } - }, - "TICKERPLANT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TICKERPLANT" - } - } - } - }, - "com.amazonaws.finspace#KxClusters": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxCluster" - } - }, - "com.amazonaws.finspace#KxCommandLineArgument": { - "type": "structure", - "members": { - "key": { - "target": "com.amazonaws.finspace#KxCommandLineArgumentKey", - "traits": { - "smithy.api#documentation": "

The name of the key.

" - } - }, - "value": { - "target": "com.amazonaws.finspace#KxCommandLineArgumentValue", - "traits": { - "smithy.api#documentation": "

The value of the key.

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

Defines the key-value pairs to make them available inside the cluster.

" - } - }, - "com.amazonaws.finspace#KxCommandLineArgumentKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^(?![Aa][Ww][Ss])(s|([a-zA-Z][a-zA-Z0-9_]+))|(AWS_ZIP_DEFAULT)$" - } - }, - "com.amazonaws.finspace#KxCommandLineArgumentValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[a-zA-Z0-9_:./,; ]+$" - } - }, - "com.amazonaws.finspace#KxCommandLineArguments": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxCommandLineArgument" - } - }, - "com.amazonaws.finspace#KxDatabaseCacheConfiguration": { - "type": "structure", - "members": { - "cacheType": { - "target": "com.amazonaws.finspace#KxCacheStorageType", - "traits": { - "smithy.api#documentation": "

The type of disk cache. This parameter is used to map the database path to cache storage. The valid values are:

\n ", - "smithy.api#required": {} - } - }, - "dbPaths": { - "target": "com.amazonaws.finspace#DbPaths", - "traits": { - "smithy.api#documentation": "

Specifies the portions of database that will be loaded into the cache for access.

", - "smithy.api#required": {} - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "

\n The name of the dataview to be used for caching historical data on disk.\n \n

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

The structure of database cache configuration that is used for mapping database paths to cache types in clusters.

" - } - }, - "com.amazonaws.finspace#KxDatabaseCacheConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxDatabaseCacheConfiguration" - } - }, - "com.amazonaws.finspace#KxDatabaseConfiguration": { - "type": "structure", - "members": { - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the kdb database. When this parameter is specified in the structure, S3 with the whole database is included by default.

", - "smithy.api#required": {} - } - }, - "cacheConfigurations": { - "target": "com.amazonaws.finspace#KxDatabaseCacheConfigurations", - "traits": { - "smithy.api#documentation": "

Configuration details for the disk cache used to increase performance reading from a kdb database mounted to the cluster.

" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "

A unique identifier of the changeset that is associated with the cluster.

" - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "

\n The name of the dataview to be used for caching historical data on disk.\n \n

" - } - }, - "dataviewConfiguration": { - "target": "com.amazonaws.finspace#KxDataviewConfiguration", - "traits": { - "smithy.api#documentation": "

\n The configuration of the dataview to be used with specified cluster.\n \n

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

The configuration of data that is available for querying from this database.

" - } - }, - "com.amazonaws.finspace#KxDatabaseConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxDatabaseConfiguration" - } - }, - "com.amazonaws.finspace#KxDatabaseListEntry": { - "type": "structure", - "members": { - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the kdb database.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the database 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.

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that the database 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.

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

Details about a FinSpace managed kdb database

" - } - }, - "com.amazonaws.finspace#KxDatabases": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxDatabaseListEntry" - } - }, - "com.amazonaws.finspace#KxDataviewActiveVersion": { - "type": "structure", - "members": { - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the changeset.

" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "

\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

" - } - }, - "attachedClusters": { - "target": "com.amazonaws.finspace#AttachedClusterList", - "traits": { - "smithy.api#documentation": "

\n The list of clusters that are currently using this dataview.\n \n

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\nThe timestamp at which the dataview version was 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.

" - } - }, - "versionId": { - "target": "com.amazonaws.finspace#VersionId", - "traits": { - "smithy.api#documentation": "

\nA unique identifier of the active version.

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

\n The active version of the dataview that is currently in use by this cluster.\n \n

" - } - }, - "com.amazonaws.finspace#KxDataviewActiveVersionList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxDataviewActiveVersion" - } - }, - "com.amazonaws.finspace#KxDataviewConfiguration": { - "type": "structure", - "members": { - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "

\nThe unique identifier of the dataview.

" - } - }, - "dataviewVersionId": { - "target": "com.amazonaws.finspace#VersionId", - "traits": { - "smithy.api#documentation": "

\n The version of the dataview corresponding to a given changeset.\n \n

" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the changeset.

" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "

\nThe db path and volume configuration for the segmented database.

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

\nThe structure that stores the configuration details of a dataview.

" - } - }, - "com.amazonaws.finspace#KxDataviewListEntry": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

" - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

\nA unique identifier of the database.

" - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "

\nA unique identifier of the dataview.

" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

" - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "

\n The identifier of the availability zones.\n

" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the changeset.

" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "

\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

" - } - }, - "activeVersions": { - "target": "com.amazonaws.finspace#KxDataviewActiveVersionList", - "traits": { - "smithy.api#documentation": "

\n The active changeset versions for the given dataview entry.\n \n

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

\n The status of a given dataview entry.\n \n

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

\nA description for the dataview list entry.

" - } - }, - "autoUpdate": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

\n The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. The default value is false.\n

" - } - }, - "readWrite": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Returns True if the dataview is created as writeable and False otherwise.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\nThe timestamp at which the dataview list entry 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.

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that the dataview list was updated 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.

" - } - }, - "statusReason": { - "target": "com.amazonaws.finspace#KxDataviewStatusReason", - "traits": { - "smithy.api#documentation": "

\nThe error message when a failed state occurs. \n

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

\n A collection of kdb dataview entries.\n \n

" - } - }, - "com.amazonaws.finspace#KxDataviewName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#KxDataviewSegmentConfiguration": { - "type": "structure", - "members": { - "dbPaths": { - "target": "com.amazonaws.finspace#SegmentConfigurationDbPathList", - "traits": { - "smithy.api#documentation": "

\nThe database path of the data that you want to place on each selected volume for the segment. Each segment must have a unique database path for each volume.

", - "smithy.api#required": {} - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "

\nThe name of the volume where you want to add data.

", - "smithy.api#required": {} - } - }, - "onDemand": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Enables on-demand caching on the selected database path when a particular file or a\n column of the database is accessed. When on demand caching is True, dataviews perform minimal loading of files on the filesystem as\n needed. When it is set to False, everything is cached. The\n default value is False.

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

\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

" - } - }, - "com.amazonaws.finspace#KxDataviewSegmentConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.finspace#KxDataviewStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - } - } - }, - "com.amazonaws.finspace#KxDataviewStatusReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 250 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-\\.\\s]+$" - } - }, - "com.amazonaws.finspace#KxDataviews": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxDataviewListEntry" - } - }, - "com.amazonaws.finspace#KxDeploymentConfiguration": { - "type": "structure", - "members": { - "deploymentStrategy": { - "target": "com.amazonaws.finspace#KxDeploymentStrategy", - "traits": { - "smithy.api#documentation": "

\n The type of deployment that you want on a cluster.\n \n

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

\n The configuration that allows you to choose how you want to update the databases on a cluster. Depending on the option you choose, you can reduce the time it takes to update the cluster.\n

" - } - }, - "com.amazonaws.finspace#KxDeploymentStrategy": { - "type": "enum", - "members": { - "NO_RESTART": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_RESTART" - } - }, - "ROLLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLING" - } - } - } - }, - "com.amazonaws.finspace#KxEnvironment": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#KxEnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the kdb environment.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

" - } - }, - "awsAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

The unique identifier of the AWS account in which you create the kdb environment.

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

The status of the environment creation.

\n " - } - }, - "tgwStatus": { - "target": "com.amazonaws.finspace#tgwStatus", - "traits": { - "smithy.api#documentation": "

The status of the network configuration.

" - } - }, - "dnsStatus": { - "target": "com.amazonaws.finspace#dnsStatus", - "traits": { - "smithy.api#documentation": "

The status of DNS configuration.

" - } - }, - "errorMessage": { - "target": "com.amazonaws.finspace#EnvironmentErrorMessage", - "traits": { - "smithy.api#documentation": "

Specifies the error message that appears if a flow fails.

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

A description of the kdb environment.

" - } - }, - "environmentArn": { - "target": "com.amazonaws.finspace#EnvironmentArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of your kdb environment.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the KMS key.

" - } - }, - "dedicatedServiceAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the AWS environment infrastructure account.

" - } - }, - "transitGatewayConfiguration": { - "target": "com.amazonaws.finspace#TransitGatewayConfiguration", - "traits": { - "smithy.api#documentation": "

Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.

" - } - }, - "customDNSConfiguration": { - "target": "com.amazonaws.finspace#CustomDNSConfiguration", - "traits": { - "smithy.api#documentation": "

A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

" - } - }, - "creationTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the kdb environment 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.

" - } - }, - "updateTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the kdb environment was modified 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.

" - } - }, - "availabilityZoneIds": { - "target": "com.amazonaws.finspace#AvailabilityZoneIds", - "traits": { - "smithy.api#documentation": "

The identifier of the availability zones where subnets for the environment are created.

" - } - }, - "certificateAuthorityArn": { - "target": "com.amazonaws.finspace#stringValueLength1to255", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the certificate authority:

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

The details of a kdb environment.

" - } - }, - "com.amazonaws.finspace#KxEnvironmentId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[a-z0-9]+$" - } - }, - "com.amazonaws.finspace#KxEnvironmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxEnvironment" - } - }, - "com.amazonaws.finspace#KxEnvironmentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#KxHostType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._]+$" - } - }, - "com.amazonaws.finspace#KxNAS1Configuration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.finspace#KxNAS1Type", - "traits": { - "smithy.api#documentation": "

\nThe type of the network attached storage.\n

" - } - }, - "size": { - "target": "com.amazonaws.finspace#KxNAS1Size", - "traits": { - "smithy.api#documentation": "

\n The size of the network attached storage. For storage type\n SSD_1000 and SSD_250 you can select the\n minimum size as 1200 GB or increments of 2400 GB. For storage type\n HDD_12 you can select the minimum size as 6000 GB or increments\n of 6000 GB.

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

\n The structure containing the size and type of the network attached storage (NAS_1) file system volume.\n

" - } - }, - "com.amazonaws.finspace#KxNAS1Size": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1200 - } - } - }, - "com.amazonaws.finspace#KxNAS1Type": { - "type": "enum", - "members": { - "SSD_1000": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SSD_1000" - } - }, - "SSD_250": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SSD_250" - } - }, - "HDD_12": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HDD_12" - } - } - } - }, - "com.amazonaws.finspace#KxNode": { - "type": "structure", - "members": { - "nodeId": { - "target": "com.amazonaws.finspace#KxClusterNodeIdString", - "traits": { - "smithy.api#documentation": "

A unique identifier for the node.

" - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "

The identifier of the availability zones where subnets for the environment are created.

" - } - }, - "launchTime": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The time when a particular node is started. 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.

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

\n Specifies the status of the cluster nodes.

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

A structure that stores metadata for a kdb node.

" - } - }, - "com.amazonaws.finspace#KxNodeStatus": { - "type": "enum", - "members": { - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "PROVISIONING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PROVISIONING" - } - } - } - }, - "com.amazonaws.finspace#KxNodeSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxNode" - } - }, - "com.amazonaws.finspace#KxSavedownStorageConfiguration": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.finspace#KxSavedownStorageType", - "traits": { - "smithy.api#documentation": "

The type of writeable storage space for temporarily storing your savedown data. The valid values are:

\n " - } - }, - "size": { - "target": "com.amazonaws.finspace#KxSavedownStorageSize", - "traits": { - "smithy.api#documentation": "

The size of temporary storage in gibibytes.

" - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "

\n The name of the kdb volume that you want to use as writeable save-down storage for clusters.\n \n

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

The size and type of temporary storage that is used to hold data during the savedown process. All the data written to this storage space is lost when the cluster node is restarted.

" - } - }, - "com.amazonaws.finspace#KxSavedownStorageSize": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 10, - "max": 16000 - } - } - }, - "com.amazonaws.finspace#KxSavedownStorageType": { - "type": "enum", - "members": { - "SDS01": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SDS01" - } - } - } - }, - "com.amazonaws.finspace#KxScalingGroup": { - "type": "structure", - "members": { - "scalingGroupName": { - "target": "com.amazonaws.finspace#KxScalingGroupName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb scaling group.

" - } - }, - "hostType": { - "target": "com.amazonaws.finspace#KxHostType", - "traits": { - "smithy.api#documentation": "

\n The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.

\n

You can add one of the following values:

\n " - } - }, - "clusters": { - "target": "com.amazonaws.finspace#KxClusterNameList", - "traits": { - "smithy.api#documentation": "

\n The list of clusters currently active in a given scaling group.\n \n

" - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "

The identifier of the availability zones.

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

\nThe status of scaling groups.\n

" - } - }, - "statusReason": { - "target": "com.amazonaws.finspace#KxClusterStatusReason", - "traits": { - "smithy.api#documentation": "

\nThe error message when a failed state occurs. \n

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\n The last time that the scaling group was updated 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.\n

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\n The timestamp at which the scaling group 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.\n

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

\nA structure for storing metadata of scaling group.

" - } - }, - "com.amazonaws.finspace#KxScalingGroupConfiguration": { - "type": "structure", - "members": { - "scalingGroupName": { - "target": "com.amazonaws.finspace#KxScalingGroupName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb scaling group.

", - "smithy.api#required": {} - } - }, - "memoryLimit": { - "target": "com.amazonaws.finspace#MemoryMib", - "traits": { - "smithy.api#documentation": "

\n An optional hard limit on the amount of memory a kdb cluster can use.\n \n

" - } - }, - "memoryReservation": { - "target": "com.amazonaws.finspace#MemoryMib", - "traits": { - "smithy.api#documentation": "

\n A reservation of the minimum amount of memory that should be available on the scaling group for a kdb cluster to be successfully placed in a scaling group. \n \n

", - "smithy.api#required": {} - } - }, - "nodeCount": { - "target": "com.amazonaws.finspace#ClusterNodeCount", - "traits": { - "smithy.api#documentation": "

\n The number of kdb cluster nodes.\n \n

", - "smithy.api#required": {} - } - }, - "cpu": { - "target": "com.amazonaws.finspace#CpuCount", - "traits": { - "smithy.api#documentation": "

\n The number of vCPUs that you want to reserve for each node of this kdb cluster on the scaling group host.\n \n

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

The structure that stores the capacity configuration details of a scaling group.

" - } - }, - "com.amazonaws.finspace#KxScalingGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxScalingGroup" - } - }, - "com.amazonaws.finspace#KxScalingGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#KxScalingGroupStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - } - } - }, - "com.amazonaws.finspace#KxUser": { - "type": "structure", - "members": { - "userArn": { - "target": "com.amazonaws.finspace#KxUserArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and\n how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.

" - } - }, - "userName": { - "target": "com.amazonaws.finspace#KxUserNameString", - "traits": { - "smithy.api#documentation": "

A unique identifier for the user.

" - } - }, - "iamRole": { - "target": "com.amazonaws.finspace#RoleArn", - "traits": { - "smithy.api#documentation": "

The IAM role ARN that is associated with the user.

" - } - }, - "createTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the kdb user was created.

" - } - }, - "updateTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the kdb user was updated.

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

A structure that stores metadata for a kdb user.

" - } - }, - "com.amazonaws.finspace#KxUserArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:kxEnvironment/[0-9A-Za-z_-]{1,128}/kxUser/[0-9A-Za-z_-]{1,128}$" - } - }, - "com.amazonaws.finspace#KxUserList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxUser" - } - }, - "com.amazonaws.finspace#KxUserNameString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#pattern": "^[0-9A-Za-z_-]{1,50}$" - } - }, - "com.amazonaws.finspace#KxVolume": { - "type": "structure", - "members": { - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the volume.

" - } - }, - "volumeType": { - "target": "com.amazonaws.finspace#KxVolumeType", - "traits": { - "smithy.api#documentation": "

\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n

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

The status of volume.

\n " - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

\nA description of the volume.\n

" - } - }, - "statusReason": { - "target": "com.amazonaws.finspace#KxVolumeStatusReason", - "traits": { - "smithy.api#documentation": "

The error message when a failed state occurs.

" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

" - } - }, - "availabilityZoneIds": { - "target": "com.amazonaws.finspace#AvailabilityZoneIds", - "traits": { - "smithy.api#documentation": "

The identifier of the availability zones.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\nThe timestamp at which the volume 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.

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that the volume was updated 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.

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

\nThe structure that contains the metadata of the volume.\n

" - } - }, - "com.amazonaws.finspace#KxVolumeArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:kxEnvironment/[0-9A-Za-z_-]{1,128}(/kxSharedVolume/[a-zA-Z0-9_-]{1,255})?$" - } - }, - "com.amazonaws.finspace#KxVolumeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#KxVolumeStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "CREATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATE_FAILED" - } - }, - "ACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "UPDATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATED" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FAILED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "DELETE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETE_FAILED" - } - } - } - }, - "com.amazonaws.finspace#KxVolumeStatusReason": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 250 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\_\\-\\.\\s]+$" - } - }, - "com.amazonaws.finspace#KxVolumeType": { - "type": "enum", - "members": { - "NAS_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAS_1" - } - } - } - }, - "com.amazonaws.finspace#KxVolumes": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#KxVolume" - } - }, - "com.amazonaws.finspace#LimitExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "

A service limit or quota is exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.finspace#ListEnvironments": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListEnvironmentsRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListEnvironmentsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

A list of all of your FinSpace environments.

", - "smithy.api#http": { - "method": "GET", - "uri": "/environment", - "code": 200 - } - } - }, - "com.amazonaws.finspace#ListEnvironmentsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token generated by FinSpace that specifies where to continue pagination if a previous\n request was truncated. To get the next set of pages, pass in the nextTokennextToken value from the\n response object of the previous page call.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#ResultLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListEnvironmentsResponse": { - "type": "structure", - "members": { - "environments": { - "target": "com.amazonaws.finspace#EnvironmentList", - "traits": { - "smithy.api#documentation": "

A list of all of your FinSpace environments.

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that you can use in a subsequent call to retrieve the next set of\n results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxChangesets": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxChangesetsRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxChangesetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of all the changesets for a database.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/changesets", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspace#ListKxChangesetsRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the kdb database.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxChangesetsResponse": { - "type": "structure", - "members": { - "kxChangesets": { - "target": "com.amazonaws.finspace#KxChangesets", - "traits": { - "smithy.api#documentation": "

A list of changesets for a database.

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxClusterNodes": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxClusterNodesRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxClusterNodesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the nodes in a kdb cluster.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/clusters/{clusterName}/nodes", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspace#ListKxClusterNodesRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "

A unique name for the cluster.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#ResultLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxClusterNodesResponse": { - "type": "structure", - "members": { - "nodes": { - "target": "com.amazonaws.finspace#KxNodeSummaries", - "traits": { - "smithy.api#documentation": "

A list of nodes associated with the cluster.

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxClusters": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxClustersRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxClustersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of clusters.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/clusters", - "code": 200 - } - } - }, - "com.amazonaws.finspace#ListKxClustersRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterType": { - "target": "com.amazonaws.finspace#KxClusterType", - "traits": { - "smithy.api#documentation": "

Specifies the type of KDB database that is being created. The following types are available:

\n ", - "smithy.api#httpQuery": "clusterType" - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxClustersResponse": { - "type": "structure", - "members": { - "kxClusterSummaries": { - "target": "com.amazonaws.finspace#KxClusters", - "traits": { - "smithy.api#documentation": "

Lists the cluster details.

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxDatabases": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxDatabasesRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxDatabasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of all the databases in the kdb environment.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/databases", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspace#ListKxDatabasesRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxDatabasesResponse": { - "type": "structure", - "members": { - "kxDatabases": { - "target": "com.amazonaws.finspace#KxDatabases", - "traits": { - "smithy.api#documentation": "

A list of databases in the kdb environment.

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxDataviews": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxDataviewsRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxDataviewsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\nReturns a list of all the dataviews in the database.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/dataviews", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspace#ListKxDataviewsRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, for which you want to retrieve a list of dataviews.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

\nThe name of the database where the dataviews were created.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

\nA token that indicates where a results page should begin.\n

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxDataviewsResponse": { - "type": "structure", - "members": { - "kxDataviews": { - "target": "com.amazonaws.finspace#KxDataviews", - "traits": { - "smithy.api#documentation": "

\n The list of kdb dataviews that are currently active for the given database.\n

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

\nA token that indicates where a results page should begin.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxEnvironments": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxEnvironmentsRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxEnvironmentsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of kdb environments created in an account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "environments", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspace#ListKxEnvironmentsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#BoxedInteger", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxEnvironmentsResponse": { - "type": "structure", - "members": { - "environments": { - "target": "com.amazonaws.finspace#KxEnvironmentList", - "traits": { - "smithy.api#documentation": "

A list of environments in an account.

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxScalingGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxScalingGroupsRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxScalingGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\nReturns a list of scaling groups in a kdb environment.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/scalingGroups", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspace#ListKxScalingGroupsRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, for which you want to retrieve a list of scaling groups.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

\nA token that indicates where a results page should begin.

", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxScalingGroupsResponse": { - "type": "structure", - "members": { - "scalingGroups": { - "target": "com.amazonaws.finspace#KxScalingGroupList", - "traits": { - "smithy.api#documentation": "

\nA list of scaling groups available in a kdb environment.

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

\nA token that indicates where a results page should begin.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxUsers": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxUsersRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxUsersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the users in a kdb environment.

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/users", - "code": 200 - } - } - }, - "com.amazonaws.finspace#ListKxUsersRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#ResultLimit", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxUsersResponse": { - "type": "structure", - "members": { - "users": { - "target": "com.amazonaws.finspace#KxUserList", - "traits": { - "smithy.api#documentation": "

A list of users in a kdb environment.

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListKxVolumes": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListKxVolumesRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListKxVolumesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\nLists all the volumes in a kdb environment.\n

", - "smithy.api#http": { - "method": "GET", - "uri": "/kx/environments/{environmentId}/kxvolumes", - "code": 200 - } - } - }, - "com.amazonaws.finspace#ListKxVolumesRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, whose clusters can attach to the volume.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.finspace#MaxResults", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of results to return in this request.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "volumeType": { - "target": "com.amazonaws.finspace#KxVolumeType", - "traits": { - "smithy.api#documentation": "

\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n

", - "smithy.api#httpQuery": "volumeType" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListKxVolumesResponse": { - "type": "structure", - "members": { - "kxVolumeSummaries": { - "target": "com.amazonaws.finspace#KxVolumes", - "traits": { - "smithy.api#documentation": "

\nA summary of volumes.\n

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspace#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.finspace#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#InvalidRequestException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

A list of all tags for a resource.

", - "smithy.api#http": { - "method": "GET", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.finspace#FinSpaceTaggableArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name of the resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "

A list of all tags for a resource.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.finspace#MemoryMib": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 6 - } - } - }, - "com.amazonaws.finspace#NameString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]{1,50}$" - } - }, - "com.amazonaws.finspace#NetworkACLConfiguration": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#NetworkACLEntry" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.finspace#NetworkACLEntry": { - "type": "structure", - "members": { - "ruleNumber": { - "target": "com.amazonaws.finspace#RuleNumber", - "traits": { - "smithy.api#documentation": "

\n The rule number for the entry. For example 100. All the network ACL entries are processed in ascending order by rule number.\n \n

", - "smithy.api#required": {} - } - }, - "protocol": { - "target": "com.amazonaws.finspace#Protocol", - "traits": { - "smithy.api#documentation": "

\n The protocol number. A value of -1 means all the protocols.\n

", - "smithy.api#required": {} - } - }, - "ruleAction": { - "target": "com.amazonaws.finspace#RuleAction", - "traits": { - "smithy.api#documentation": "

\n Indicates whether to allow or deny the traffic that matches the rule.\n

", - "smithy.api#required": {} - } - }, - "portRange": { - "target": "com.amazonaws.finspace#PortRange", - "traits": { - "smithy.api#documentation": "

\n The range of ports the rule applies to.\n

" - } - }, - "icmpTypeCode": { - "target": "com.amazonaws.finspace#IcmpTypeCode", - "traits": { - "smithy.api#documentation": "

\n Defines the ICMP protocol that consists of the ICMP type and code.\n

" - } - }, - "cidrBlock": { - "target": "com.amazonaws.finspace#ValidCIDRBlock", - "traits": { - "smithy.api#documentation": "

\n The IPv4 network range to allow or deny, in CIDR notation. For example, 172.16.0.0/24. We modify the specified CIDR block to its canonical form. For example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.\n

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

\n The network access control list (ACL) is an optional layer of security for your VPC that acts as a firewall for controlling traffic in and out of one or more subnets. The entry is a set of numbered ingress and egress rules that determine whether a packet should be allowed in or out of a subnet associated with the ACL. We process the entries in the ACL according to the rule numbers, in ascending order.\n

" - } - }, - "com.amazonaws.finspace#NodeCount": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.finspace#NodeType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._]+$" - } - }, - "com.amazonaws.finspace#PaginationToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.finspace#Port": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 65535 - } - } - }, - "com.amazonaws.finspace#PortRange": { - "type": "structure", - "members": { - "from": { - "target": "com.amazonaws.finspace#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The first port in the range.\n

", - "smithy.api#required": {} - } - }, - "to": { - "target": "com.amazonaws.finspace#Port", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

\n The last port in the range.\n

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

\n The range of ports the rule applies to.\n

" - } - }, - "com.amazonaws.finspace#Protocol": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - }, - "smithy.api#pattern": "^-1|[0-9]+$" - } - }, - "com.amazonaws.finspace#ReleaseLabel": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._-]+$" - } - }, - "com.amazonaws.finspace#ResourceAlreadyExistsException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "

The specified resource group already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.finspace#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "

One or more resources can't be found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.finspace#ResultLimit": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.finspace#RoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" - } - }, - "com.amazonaws.finspace#RuleAction": { - "type": "enum", - "members": { - "ALLOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "allow" - } - }, - "DENY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "deny" - } - } - } - }, - "com.amazonaws.finspace#RuleNumber": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 32766 - } - } - }, - "com.amazonaws.finspace#S3Bucket": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 255 - }, - "smithy.api#pattern": "^[a-z0-9][a-z0-9\\.\\-]*[a-z0-9]$" - } - }, - "com.amazonaws.finspace#S3Key": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^[a-zA-Z0-9\\/\\!\\-_\\.\\*'\\(\\)]+$" - } - }, - "com.amazonaws.finspace#S3ObjectVersion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.finspace#S3Path": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 9, - "max": 1093 - }, - "smithy.api#pattern": "^s3:\\/\\/[a-z0-9][a-z0-9-.]{1,61}[a-z0-9]\\/([^\\/]+\\/)*[^\\/]*$" - } - }, - "com.amazonaws.finspace#SamlMetadataDocument": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1000, - "max": 10000000 - }, - "smithy.api#pattern": ".*" - } - }, - "com.amazonaws.finspace#SecurityGroupIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#SecurityGroupIdString" - } - }, - "com.amazonaws.finspace#SecurityGroupIdString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^sg-([a-z0-9]{8}$|[a-z0-9]{17}$)$" - } - }, - "com.amazonaws.finspace#SegmentConfigurationDbPathList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#DbPath" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 30 - } - } - }, - "com.amazonaws.finspace#ServiceQuotaExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "

You have exceeded your service quota. To perform the requested action, \n remove some of the relevant resources, or use Service Quotas to request a service quota increase.

", - "smithy.api#error": "client", - "smithy.api#httpError": 402 - } - }, - "com.amazonaws.finspace#SignedKxConnectionString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^(:|:tcps:\\/\\/)[a-zA-Z0-9-\\.\\_]+:\\d+:[a-zA-Z0-9-\\.\\_]+:\\S+$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.finspace#SmsDomainUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^[a-zA-Z-0-9-:\\/.]*$" - } - }, - "com.amazonaws.finspace#SubnetIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#SubnetIdString" - } - }, - "com.amazonaws.finspace#SubnetIdString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^subnet-([a-z0-9]{8}$|[a-z0-9]{17}$)$" - } - }, - "com.amazonaws.finspace#SuperuserParameters": { - "type": "structure", - "members": { - "emailAddress": { - "target": "com.amazonaws.finspace#EmailId", - "traits": { - "smithy.api#documentation": "

The email address of the superuser.

", - "smithy.api#required": {} - } - }, - "firstName": { - "target": "com.amazonaws.finspace#NameString", - "traits": { - "smithy.api#documentation": "

The first name of the superuser.

", - "smithy.api#required": {} - } - }, - "lastName": { - "target": "com.amazonaws.finspace#NameString", - "traits": { - "smithy.api#documentation": "

The last name of the superuser.

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

Configuration information for the superuser.

" - } - }, - "com.amazonaws.finspace#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" - } - }, - "com.amazonaws.finspace#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.finspace#TagMap": { - "type": "map", - "key": { - "target": "com.amazonaws.finspace#TagKey" - }, - "value": { - "target": "com.amazonaws.finspace#TagValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.finspace#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.finspace#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#InvalidRequestException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds metadata tags to a FinSpace resource.

", - "smithy.api#http": { - "method": "POST", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#TagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.finspace#FinSpaceTaggableArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the resource.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tags": { - "target": "com.amazonaws.finspace#TagMap", - "traits": { - "smithy.api#documentation": "

One or more tags to be assigned to the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#TagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[a-zA-Z0-9+-=._:@ ]+$" - } - }, - "com.amazonaws.finspace#ThrottlingException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "

The request was denied due to request throttling.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.finspace#TickerplantLogConfiguration": { - "type": "structure", - "members": { - "tickerplantLogVolumes": { - "target": "com.amazonaws.finspace#TickerplantLogVolumes", - "traits": { - "smithy.api#documentation": "

\nThe name of the volumes for tickerplant logs.\n

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

\nA configuration to store the Tickerplant logs. It consists of\na list of volumes that will be mounted to your cluster. For the cluster type Tickerplant, the location of the TP volume on the cluster will be available by using the global variable .aws.tp_log_path. \n

" - } - }, - "com.amazonaws.finspace#TickerplantLogVolumes": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#VolumeName" - } - }, - "com.amazonaws.finspace#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.finspace#TransitGatewayConfiguration": { - "type": "structure", - "members": { - "transitGatewayID": { - "target": "com.amazonaws.finspace#TransitGatewayID", - "traits": { - "smithy.api#documentation": "

The identifier of the transit gateway created by the customer to connect outbound traffics from kdb network to your internal network.

", - "smithy.api#required": {} - } - }, - "routableCIDRSpace": { - "target": "com.amazonaws.finspace#ValidCIDRSpace", - "traits": { - "smithy.api#documentation": "

The routing CIDR on behalf of kdb environment. It could be any \"/26 range in the 100.64.0.0 CIDR space. After providing, it will be added to the customer's transit gateway routing table so that the traffics could be routed to kdb network.

", - "smithy.api#required": {} - } - }, - "attachmentNetworkAclConfiguration": { - "target": "com.amazonaws.finspace#NetworkACLConfiguration", - "traits": { - "smithy.api#documentation": "

\n The rules that define how you manage the outbound traffic from kdb network to your internal network.\n \n

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

The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.

" - } - }, - "com.amazonaws.finspace#TransitGatewayID": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.finspace#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#InvalidRequestException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes metadata tags from a FinSpace resource.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/tags/{resourceArn}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UntagResourceRequest": { - "type": "structure", - "members": { - "resourceArn": { - "target": "com.amazonaws.finspace#FinSpaceTaggableArn", - "traits": { - "smithy.api#documentation": "

A FinSpace resource from which you want to remove a tag or tags. The value for this\n parameter is an Amazon Resource Name (ARN).

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "tagKeys": { - "target": "com.amazonaws.finspace#TagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys (names) of one or more tags to be removed.

", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UntagResourceResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateEnvironmentRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateEnvironmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Update your FinSpace environment.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/environment/{environmentId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateEnvironmentRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

The identifier of the FinSpace environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.finspace#EnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the environment.

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

The description of the environment.

" - } - }, - "federationMode": { - "target": "com.amazonaws.finspace#FederationMode", - "traits": { - "smithy.api#documentation": "

Authentication mode for the environment.

\n " - } - }, - "federationParameters": { - "target": "com.amazonaws.finspace#FederationParameters" - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateEnvironmentResponse": { - "type": "structure", - "members": { - "environment": { - "target": "com.amazonaws.finspace#Environment", - "traits": { - "smithy.api#documentation": "

Returns the FinSpace environment object.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxClusterCodeConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\n 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. \n The configuration that you want to update will override any existing configurations on the cluster. \n

", - "smithy.api#http": { - "method": "PUT", - "uri": "/kx/environments/{environmentId}/clusters/{clusterName}/configuration/code", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

\n A unique identifier of the kdb environment.\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "

The name of the cluster.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - }, - "code": { - "target": "com.amazonaws.finspace#CodeConfiguration", - "traits": { - "smithy.api#required": {} - } - }, - "initializationScript": { - "target": "com.amazonaws.finspace#InitializationScriptFilePath", - "traits": { - "smithy.api#documentation": "

Specifies a Q program that will be run at launch of a cluster. It is a relative path within\n .zip file that contains the custom code, which will be loaded on\n the cluster. It must include the file name itself. For example,\n somedir/init.q.

\n

You cannot update this parameter for a NO_RESTART deployment.

" - } - }, - "commandLineArguments": { - "target": "com.amazonaws.finspace#KxCommandLineArguments", - "traits": { - "smithy.api#documentation": "

Specifies the key-value pairs to make them available inside the cluster.

\n

You cannot update this parameter for a NO_RESTART deployment.

" - } - }, - "deploymentConfiguration": { - "target": "com.amazonaws.finspace#KxClusterCodeDeploymentConfiguration", - "traits": { - "smithy.api#documentation": "

\n The configuration that allows you to choose how you want to update the code on a cluster.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxClusterCodeConfigurationResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxClusterDatabases": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxClusterDatabasesRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxClusterDatabasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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.

\n

Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/kx/environments/{environmentId}/clusters/{clusterName}/configuration/databases", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxClusterDatabasesRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clusterName": { - "target": "com.amazonaws.finspace#KxClusterName", - "traits": { - "smithy.api#documentation": "

A unique name for the cluster that you want to modify.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - }, - "databases": { - "target": "com.amazonaws.finspace#KxDatabaseConfigurations", - "traits": { - "smithy.api#documentation": "

The structure of databases mounted on the cluster.

", - "smithy.api#required": {} - } - }, - "deploymentConfiguration": { - "target": "com.amazonaws.finspace#KxDeploymentConfiguration", - "traits": { - "smithy.api#documentation": "

\n The configuration that allows you to choose how you want to update the databases on a cluster.\n

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxClusterDatabasesResponse": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxDatabase": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxDatabaseRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxDatabaseResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates information for the given kdb database.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxDatabaseRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the kdb database.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

A description of the database.

" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxDatabaseResponse": { - "type": "structure", - "members": { - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

The name of the kdb database.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

A description of the database.

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that the database 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.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxDataview": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxDataviewRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxDataviewResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceAlreadyExistsException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\nUpdates 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

", - "smithy.api#http": { - "method": "PUT", - "uri": "/kx/environments/{environmentId}/databases/{databaseName}/dataviews/{dataviewName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxDataviewRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, where you want to update the dataview.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

\nThe name of the database.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "

The name of the dataview that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

\n The description for a dataview.\n

" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the changeset.

" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "

\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxDataviewResponse": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#EnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment, where you want to update the dataview.

" - } - }, - "databaseName": { - "target": "com.amazonaws.finspace#DatabaseName", - "traits": { - "smithy.api#documentation": "

\nThe name of the database.\n

" - } - }, - "dataviewName": { - "target": "com.amazonaws.finspace#KxDataviewName", - "traits": { - "smithy.api#documentation": "

\n The name of the database under which the dataview was created.\n \n

" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

" - } - }, - "availabilityZoneId": { - "target": "com.amazonaws.finspace#AvailabilityZoneId", - "traits": { - "smithy.api#documentation": "

\n The identifier of the availability zones.\n

" - } - }, - "changesetId": { - "target": "com.amazonaws.finspace#ChangesetId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the changeset.

" - } - }, - "segmentConfigurations": { - "target": "com.amazonaws.finspace#KxDataviewSegmentConfigurationList", - "traits": { - "smithy.api#documentation": "

\n The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.

" - } - }, - "activeVersions": { - "target": "com.amazonaws.finspace#KxDataviewActiveVersionList", - "traits": { - "smithy.api#documentation": "

\n The current active changeset versions of the database on the given dataview. \n \n

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

\n The status of dataview creation.

\n " - } - }, - "autoUpdate": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.

" - } - }, - "readWrite": { - "target": "com.amazonaws.finspace#booleanValue", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Returns True if the dataview is created as writeable and False otherwise.

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

A description of the dataview.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\n 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.\n

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\n The last time that the dataview was updated 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.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxEnvironment": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxEnvironmentRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxEnvironmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates information for the given kdb environment.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/kx/environments/{environmentId}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxEnvironmentNetwork": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxEnvironmentNetworkRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxEnvironmentNetworkResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

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.

\n

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.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/kx/environments/{environmentId}/network", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxEnvironmentNetworkRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "transitGatewayConfiguration": { - "target": "com.amazonaws.finspace#TransitGatewayConfiguration", - "traits": { - "smithy.api#documentation": "

Specifies the transit gateway and network configuration to connect the kdb environment to an internal network.

" - } - }, - "customDNSConfiguration": { - "target": "com.amazonaws.finspace#CustomDNSConfiguration", - "traits": { - "smithy.api#documentation": "

A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxEnvironmentNetworkResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#KxEnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the kdb environment.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

" - } - }, - "awsAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

The unique identifier of the AWS account that is used to create the kdb environment.

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

The status of the kdb environment.

" - } - }, - "tgwStatus": { - "target": "com.amazonaws.finspace#tgwStatus", - "traits": { - "smithy.api#documentation": "

The status of the network configuration.

" - } - }, - "dnsStatus": { - "target": "com.amazonaws.finspace#dnsStatus", - "traits": { - "smithy.api#documentation": "

The status of DNS configuration.

" - } - }, - "errorMessage": { - "target": "com.amazonaws.finspace#EnvironmentErrorMessage", - "traits": { - "smithy.api#documentation": "

Specifies the error message that appears if a flow fails.

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

The description of the environment.

" - } - }, - "environmentArn": { - "target": "com.amazonaws.finspace#EnvironmentArn", - "traits": { - "smithy.api#documentation": "

The ARN identifier of the environment.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The KMS key ID to encrypt your data in the FinSpace environment.

" - } - }, - "dedicatedServiceAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the AWS environment infrastructure account.

" - } - }, - "transitGatewayConfiguration": { - "target": "com.amazonaws.finspace#TransitGatewayConfiguration" - }, - "customDNSConfiguration": { - "target": "com.amazonaws.finspace#CustomDNSConfiguration", - "traits": { - "smithy.api#documentation": "

A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

" - } - }, - "creationTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the kdb environment was created in FinSpace.

" - } - }, - "updateTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the kdb environment was updated.

" - } - }, - "availabilityZoneIds": { - "target": "com.amazonaws.finspace#AvailabilityZoneIds", - "traits": { - "smithy.api#documentation": "

The identifier of the availability zones where subnets for the environment are created.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxEnvironmentRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.finspace#KxEnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the kdb environment.

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

A description of the kdb environment.

" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxEnvironmentResponse": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspace#KxEnvironmentName", - "traits": { - "smithy.api#documentation": "

The name of the kdb environment.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

" - } - }, - "awsAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

The unique identifier of the AWS account that is used to create the kdb environment.

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

The status of the kdb environment.

" - } - }, - "tgwStatus": { - "target": "com.amazonaws.finspace#tgwStatus", - "traits": { - "smithy.api#documentation": "

The status of the network configuration.

" - } - }, - "dnsStatus": { - "target": "com.amazonaws.finspace#dnsStatus", - "traits": { - "smithy.api#documentation": "

The status of DNS configuration.

" - } - }, - "errorMessage": { - "target": "com.amazonaws.finspace#EnvironmentErrorMessage", - "traits": { - "smithy.api#documentation": "

Specifies the error message that appears if a flow fails.

" - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

The description of the environment.

" - } - }, - "environmentArn": { - "target": "com.amazonaws.finspace#EnvironmentArn", - "traits": { - "smithy.api#documentation": "

The ARN identifier of the environment.

" - } - }, - "kmsKeyId": { - "target": "com.amazonaws.finspace#KmsKeyId", - "traits": { - "smithy.api#documentation": "

The KMS key ID to encrypt your data in the FinSpace environment.

" - } - }, - "dedicatedServiceAccountId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the AWS environment infrastructure account.

" - } - }, - "transitGatewayConfiguration": { - "target": "com.amazonaws.finspace#TransitGatewayConfiguration" - }, - "customDNSConfiguration": { - "target": "com.amazonaws.finspace#CustomDNSConfiguration", - "traits": { - "smithy.api#documentation": "

A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.

" - } - }, - "creationTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the kdb environment was created in FinSpace.

" - } - }, - "updateTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The timestamp at which the kdb environment was updated.

" - } - }, - "availabilityZoneIds": { - "target": "com.amazonaws.finspace#AvailabilityZoneIds", - "traits": { - "smithy.api#documentation": "

The identifier of the availability zones where subnets for the environment are created.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxUserRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the user details. You can only update the IAM role associated with a user.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/kx/environments/{environmentId}/users/{userName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxUserRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "userName": { - "target": "com.amazonaws.finspace#KxUserNameString", - "traits": { - "smithy.api#documentation": "

A unique identifier for the user.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "iamRole": { - "target": "com.amazonaws.finspace#RoleArn", - "traits": { - "smithy.api#documentation": "

The IAM role ARN that is associated with the user.

", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxUserResponse": { - "type": "structure", - "members": { - "userName": { - "target": "com.amazonaws.finspace#KxUserNameString", - "traits": { - "smithy.api#documentation": "

A unique identifier for the user.

" - } - }, - "userArn": { - "target": "com.amazonaws.finspace#KxUserArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and\n how to use ARNs in policies, see IAM Identifiers in the\n IAM User Guide.

" - } - }, - "environmentId": { - "target": "com.amazonaws.finspace#IdType", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment.

" - } - }, - "iamRole": { - "target": "com.amazonaws.finspace#RoleArn", - "traits": { - "smithy.api#documentation": "

The IAM role ARN that is associated with the user.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#UpdateKxVolume": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspace#UpdateKxVolumeRequest" - }, - "output": { - "target": "com.amazonaws.finspace#UpdateKxVolumeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspace#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspace#ConflictException" - }, - { - "target": "com.amazonaws.finspace#InternalServerException" - }, - { - "target": "com.amazonaws.finspace#LimitExceededException" - }, - { - "target": "com.amazonaws.finspace#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspace#ThrottlingException" - }, - { - "target": "com.amazonaws.finspace#ValidationException" - } - ], - "traits": { - "smithy.api#documentation": "

\nUpdates the throughput or capacity of a volume. During the update process, the filesystem \nmight be unavailable for a few minutes. You can retry any operations after the update is complete.\n

", - "smithy.api#http": { - "method": "PATCH", - "uri": "/kx/environments/{environmentId}/kxvolumes/{volumeName}", - "code": 200 - } - } - }, - "com.amazonaws.finspace#UpdateKxVolumeRequest": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment where you created the storage volume.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "

\nA unique identifier for the volume.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

\nA description of the volume.\n

" - } - }, - "clientToken": { - "target": "com.amazonaws.finspace#ClientTokenString", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - }, - "nas1Configuration": { - "target": "com.amazonaws.finspace#KxNAS1Configuration", - "traits": { - "smithy.api#documentation": "

Specifies the configuration for the Network attached storage (NAS_1) file system volume.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspace#UpdateKxVolumeResponse": { - "type": "structure", - "members": { - "environmentId": { - "target": "com.amazonaws.finspace#KxEnvironmentId", - "traits": { - "smithy.api#documentation": "

A unique identifier for the kdb environment where you want to update the volume.

" - } - }, - "volumeName": { - "target": "com.amazonaws.finspace#KxVolumeName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the volume that you want to update.

" - } - }, - "volumeType": { - "target": "com.amazonaws.finspace#KxVolumeType", - "traits": { - "smithy.api#documentation": "

\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n

" - } - }, - "volumeArn": { - "target": "com.amazonaws.finspace#KxVolumeArn", - "traits": { - "smithy.api#documentation": "

\nThe ARN identifier of the volume.\n

" - } - }, - "nas1Configuration": { - "target": "com.amazonaws.finspace#KxNAS1Configuration", - "traits": { - "smithy.api#documentation": "

Specifies the configuration for the Network attached storage (NAS_1) file system volume.

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

The status of the volume.

\n " - } - }, - "description": { - "target": "com.amazonaws.finspace#Description", - "traits": { - "smithy.api#documentation": "

\nThe description for the volume.\n

" - } - }, - "statusReason": { - "target": "com.amazonaws.finspace#KxVolumeStatusReason", - "traits": { - "smithy.api#documentation": "

The error message when a failed state occurs.

" - } - }, - "createdTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

\nThe timestamp at which the volume 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.

" - } - }, - "azMode": { - "target": "com.amazonaws.finspace#KxAzMode", - "traits": { - "smithy.api#documentation": "

The number of availability zones you want to assign per volume. Currently, FinSpace only supports SINGLE for volumes. This places dataview in a single AZ.

" - } - }, - "availabilityZoneIds": { - "target": "com.amazonaws.finspace#AvailabilityZoneIds", - "traits": { - "smithy.api#documentation": "

The identifier of the availability zones.

" - } - }, - "lastModifiedTimestamp": { - "target": "com.amazonaws.finspace#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that the volume was updated 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.

" - } - }, - "attachedClusters": { - "target": "com.amazonaws.finspace#KxAttachedClusters", - "traits": { - "smithy.api#documentation": "

\nSpecifies the clusters that a volume is attached to.\n

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspace#ValidCIDRBlock": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 18 - }, - "smithy.api#pattern": "^(?:\\d{1,3}\\.){3}\\d{1,3}(?:\\/(?:3[0-2]|[12]\\d|\\d))$" - } - }, - "com.amazonaws.finspace#ValidCIDRSpace": { - "type": "string" - }, - "com.amazonaws.finspace#ValidHostname": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 255 - }, - "smithy.api#pattern": "^([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])(\\.([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9]))*$" - } - }, - "com.amazonaws.finspace#ValidIPAddress": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$" - } - }, - "com.amazonaws.finspace#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspace#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an AWS service.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.finspace#VersionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 26 - } - } - }, - "com.amazonaws.finspace#Volume": { - "type": "structure", - "members": { - "volumeName": { - "target": "com.amazonaws.finspace#VolumeName", - "traits": { - "smithy.api#documentation": "

A unique identifier for the volume.

" - } - }, - "volumeType": { - "target": "com.amazonaws.finspace#VolumeType", - "traits": { - "smithy.api#documentation": "

\n The type of file system volume. Currently, FinSpace only supports NAS_1 volume type.\n

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

\nThe structure that consists of name and type of volume.

" - } - }, - "com.amazonaws.finspace#VolumeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 3, - "max": 63 - }, - "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*[a-zA-Z0-9]$" - } - }, - "com.amazonaws.finspace#VolumeType": { - "type": "enum", - "members": { - "NAS_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAS_1" - } - } - } - }, - "com.amazonaws.finspace#Volumes": { - "type": "list", - "member": { - "target": "com.amazonaws.finspace#Volume" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.finspace#VpcConfiguration": { - "type": "structure", - "members": { - "vpcId": { - "target": "com.amazonaws.finspace#VpcIdString", - "traits": { - "smithy.api#documentation": "

The identifier of the VPC endpoint.

" - } - }, - "securityGroupIds": { - "target": "com.amazonaws.finspace#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

The unique identifier of the VPC security group applied to the VPC endpoint ENI for the cluster.

" - } - }, - "subnetIds": { - "target": "com.amazonaws.finspace#SubnetIdList", - "traits": { - "smithy.api#documentation": "

The identifier of the subnet that the Privatelink VPC endpoint uses to connect to the cluster.

" - } - }, - "ipAddressType": { - "target": "com.amazonaws.finspace#IPAddressType", - "traits": { - "smithy.api#documentation": "

The IP address type for cluster network configuration parameters. The following type is available:

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

Configuration details about the network where the Privatelink endpoint of the cluster resides.

" - } - }, - "com.amazonaws.finspace#VpcIdString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^vpc-([a-z0-9]{8}$|[a-z0-9]{17}$)$" - } - }, - "com.amazonaws.finspace#arn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:*:*:*:*:*$" - } - }, - "com.amazonaws.finspace#booleanValue": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.finspace#dnsStatus": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "UPDATE_REQUESTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_REQUESTED" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "FAILED_UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_UPDATE" - } - }, - "SUCCESSFULLY_UPDATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESSFULLY_UPDATED" - } - } - } - }, - "com.amazonaws.finspace#numBytes": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.finspace#numChangesets": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.finspace#numFiles": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.finspace#stringValueLength1to255": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.finspace#tgwStatus": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "UPDATE_REQUESTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_REQUESTED" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "FAILED_UPDATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_UPDATE" - } - }, - "SUCCESSFULLY_UPDATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESSFULLY_UPDATED" - } - } - } - }, - "com.amazonaws.finspace#url": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]$" - } - }, - "com.amazonaws.finspace#urn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[A-Za-z0-9._\\-:\\/#\\+]+$" - } - } - } -} \ No newline at end of file From a744314e8ab338b6744e2a5cbe205301a8569121 Mon Sep 17 00:00:00 2001 From: rchache <105247787+rchache@users.noreply.github.com> Date: Tue, 20 Oct 2026 15:15:57 -0400 Subject: [PATCH 3/5] Delete models/finspace-data directory --- .../2020-07-13/finspace-data-2020-07-13.json | 5885 ----------------- 1 file changed, 5885 deletions(-) delete mode 100644 models/finspace-data/service/2020-07-13/finspace-data-2020-07-13.json diff --git a/models/finspace-data/service/2020-07-13/finspace-data-2020-07-13.json b/models/finspace-data/service/2020-07-13/finspace-data-2020-07-13.json deleted file mode 100644 index 3ee1c50c4..000000000 --- a/models/finspace-data/service/2020-07-13/finspace-data-2020-07-13.json +++ /dev/null @@ -1,5885 +0,0 @@ -{ - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.finspacedata#AWSHabaneroPublicAPI": { - "type": "service", - "version": "2020-07-13", - "operations": [ - { - "target": "com.amazonaws.finspacedata#AssociateUserToPermissionGroup" - }, - { - "target": "com.amazonaws.finspacedata#CreateChangeset" - }, - { - "target": "com.amazonaws.finspacedata#CreateDataset" - }, - { - "target": "com.amazonaws.finspacedata#CreateDataView" - }, - { - "target": "com.amazonaws.finspacedata#CreatePermissionGroup" - }, - { - "target": "com.amazonaws.finspacedata#CreateUser" - }, - { - "target": "com.amazonaws.finspacedata#DeleteDataset" - }, - { - "target": "com.amazonaws.finspacedata#DeletePermissionGroup" - }, - { - "target": "com.amazonaws.finspacedata#DisableUser" - }, - { - "target": "com.amazonaws.finspacedata#DisassociateUserFromPermissionGroup" - }, - { - "target": "com.amazonaws.finspacedata#EnableUser" - }, - { - "target": "com.amazonaws.finspacedata#GetChangeset" - }, - { - "target": "com.amazonaws.finspacedata#GetDataset" - }, - { - "target": "com.amazonaws.finspacedata#GetDataView" - }, - { - "target": "com.amazonaws.finspacedata#GetExternalDataViewAccessDetails" - }, - { - "target": "com.amazonaws.finspacedata#GetPermissionGroup" - }, - { - "target": "com.amazonaws.finspacedata#GetProgrammaticAccessCredentials" - }, - { - "target": "com.amazonaws.finspacedata#GetUser" - }, - { - "target": "com.amazonaws.finspacedata#GetWorkingLocation" - }, - { - "target": "com.amazonaws.finspacedata#ListChangesets" - }, - { - "target": "com.amazonaws.finspacedata#ListDatasets" - }, - { - "target": "com.amazonaws.finspacedata#ListDataViews" - }, - { - "target": "com.amazonaws.finspacedata#ListPermissionGroups" - }, - { - "target": "com.amazonaws.finspacedata#ListPermissionGroupsByUser" - }, - { - "target": "com.amazonaws.finspacedata#ListUsers" - }, - { - "target": "com.amazonaws.finspacedata#ListUsersByPermissionGroup" - }, - { - "target": "com.amazonaws.finspacedata#ResetUserPassword" - }, - { - "target": "com.amazonaws.finspacedata#UpdateChangeset" - }, - { - "target": "com.amazonaws.finspacedata#UpdateDataset" - }, - { - "target": "com.amazonaws.finspacedata#UpdatePermissionGroup" - }, - { - "target": "com.amazonaws.finspacedata#UpdateUser" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "finspace data", - "arnNamespace": "finspace-api", - "cloudFormationName": "Finspacedata", - "cloudTrailEventSource": "finspacedata.amazonaws.com", - "docId": "finspace-2020-07-13", - "endpointPrefix": "finspace-api" - }, - "aws.auth#sigv4": { - "name": "finspace-api" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

The FinSpace APIs let you take actions inside the FinSpace.

", - "smithy.api#title": "FinSpace Public API", - "smithy.rules#endpointBdd": { - "version": "1.1", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - }, - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - }, - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "results": [ - { - "conditions": [], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "endpoint": { - "url": "https://finspace-api-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://finspace-api-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://finspace-api.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": "https://finspace-api.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ], - "root": 2, - "nodeCount": 13, - "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" - }, - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "string" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "string" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://finspace-api-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://finspace-api-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://finspace-api.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://finspace-api.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-api.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-api.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-api.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-api.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-api.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace-api-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-api-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace-api.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace-api-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-api-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace-api.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-api.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace-api-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-api-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://finspace-api.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-api.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-api-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-api.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-api-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://finspace-api.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.finspacedata#AccessDeniedException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspacedata#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "

You do not have sufficient access to perform this action.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.finspacedata#AccessKeyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" - } - }, - "com.amazonaws.finspacedata#AliasString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^alias\\/\\S+$" - } - }, - "com.amazonaws.finspacedata#ApiAccess": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.finspacedata#ApplicationPermission": { - "type": "enum", - "members": { - "CreateDataset": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CreateDataset" - } - }, - "ManageClusters": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ManageClusters" - } - }, - "ManageUsersAndGroups": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ManageUsersAndGroups" - } - }, - "ManageAttributeSets": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ManageAttributeSets" - } - }, - "ViewAuditData": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ViewAuditData" - } - }, - "AccessNotebooks": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AccessNotebooks" - } - }, - "GetTemporaryCredentials": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GetTemporaryCredentials" - } - } - } - }, - "com.amazonaws.finspacedata#ApplicationPermissionList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspacedata#ApplicationPermission" - } - }, - "com.amazonaws.finspacedata#AssociateUserToPermissionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#AssociateUserToPermissionGroupRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#AssociateUserToPermissionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.

", - "smithy.api#http": { - "method": "POST", - "uri": "/permission-group/{permissionGroupId}/users/{userId}", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#AssociateUserToPermissionGroupRequest": { - "type": "structure", - "members": { - "permissionGroupId": { - "target": "com.amazonaws.finspacedata#PermissionGroupId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the permission group.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the user.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#AssociateUserToPermissionGroupResponse": { - "type": "structure", - "members": { - "statusCode": { - "target": "com.amazonaws.finspacedata#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The returned status code of the response.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#AwsCredentials": { - "type": "structure", - "members": { - "accessKeyId": { - "target": "com.amazonaws.finspacedata#AccessKeyId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the security credentials.

" - } - }, - "secretAccessKey": { - "target": "com.amazonaws.finspacedata#SecretAccessKey", - "traits": { - "smithy.api#documentation": "

The secret access key that can be used to sign requests.

" - } - }, - "sessionToken": { - "target": "com.amazonaws.finspacedata#SessionToken", - "traits": { - "smithy.api#documentation": "

The token that users must pass to use the credentials.

" - } - }, - "expiration": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The Epoch time when the current credentials expire.

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

The credentials required to access the external Dataview from the S3 location.

", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.finspacedata#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "Common Boolean data type" - } - }, - "com.amazonaws.finspacedata#ChangeType": { - "type": "enum", - "members": { - "REPLACE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REPLACE" - } - }, - "APPEND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "APPEND" - } - }, - "MODIFY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MODIFY" - } - } - }, - "traits": { - "smithy.api#documentation": "Indicates how the given change will be applied to the dataset." - } - }, - "com.amazonaws.finspacedata#ChangesetArn": { - "type": "string", - "traits": { - "smithy.api#documentation": "Arn for a given Changeset" - } - }, - "com.amazonaws.finspacedata#ChangesetErrorInfo": { - "type": "structure", - "members": { - "errorMessage": { - "target": "com.amazonaws.finspacedata#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The text of the error message.

" - } - }, - "errorCategory": { - "target": "com.amazonaws.finspacedata#ErrorCategory", - "traits": { - "smithy.api#documentation": "

The category of the error.

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

The structure with error messages.

" - } - }, - "com.amazonaws.finspacedata#ChangesetId": { - "type": "string", - "traits": { - "smithy.api#documentation": "ID used to identify a Changeset", - "smithy.api#length": { - "min": 1, - "max": 26 - } - } - }, - "com.amazonaws.finspacedata#ChangesetList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspacedata#ChangesetSummary" - }, - "traits": { - "smithy.api#documentation": "List of Changeset Summaries" - } - }, - "com.amazonaws.finspacedata#ChangesetSummary": { - "type": "structure", - "members": { - "changesetId": { - "target": "com.amazonaws.finspacedata#ChangesetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for a Changeset.

" - } - }, - "changesetArn": { - "target": "com.amazonaws.finspacedata#ChangesetArn", - "traits": { - "smithy.api#documentation": "

The ARN identifier of the Changeset.

" - } - }, - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the FinSpace Dataset in which the Changeset is created.

" - } - }, - "changeType": { - "target": "com.amazonaws.finspacedata#ChangeType", - "traits": { - "smithy.api#documentation": "

Type that indicates how a Changeset is applied to a Dataset.

\n " - } - }, - "sourceParams": { - "target": "com.amazonaws.finspacedata#SourceParams", - "traits": { - "smithy.api#documentation": "

Options that define the location of the data being ingested.

" - } - }, - "formatParams": { - "target": "com.amazonaws.finspacedata#FormatParams", - "traits": { - "smithy.api#documentation": "

Options that define the structure of the source file(s).

" - } - }, - "createTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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.

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

Status of the Changeset ingestion.

\n " - } - }, - "errorInfo": { - "target": "com.amazonaws.finspacedata#ChangesetErrorInfo", - "traits": { - "smithy.api#documentation": "

The structure with error messages.

" - } - }, - "activeUntilTimestamp": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

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.

" - } - }, - "activeFromTimestamp": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

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.

" - } - }, - "updatesChangesetId": { - "target": "com.amazonaws.finspacedata#ChangesetId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the Changeset that is updated.

" - } - }, - "updatedByChangesetId": { - "target": "com.amazonaws.finspacedata#ChangesetId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the updated Changeset.

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

A Changeset is unit of data in a Dataset.

" - } - }, - "com.amazonaws.finspacedata#ClientToken": { - "type": "string", - "traits": { - "smithy.api#documentation": "Idempotence Token for API operations", - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.finspacedata#ColumnDataType": { - "type": "enum", - "members": { - "STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRING" - } - }, - "CHAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CHAR" - } - }, - "INTEGER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTEGER" - } - }, - "TINYINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TINYINT" - } - }, - "SMALLINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMALLINT" - } - }, - "BIGINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BIGINT" - } - }, - "FLOAT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FLOAT" - } - }, - "DOUBLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOUBLE" - } - }, - "DATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATE" - } - }, - "DATETIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATETIME" - } - }, - "BOOLEAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOOLEAN" - } - }, - "BINARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BINARY" - } - } - }, - "traits": { - "smithy.api#documentation": "Data type of a column." - } - }, - "com.amazonaws.finspacedata#ColumnDefinition": { - "type": "structure", - "members": { - "dataType": { - "target": "com.amazonaws.finspacedata#ColumnDataType", - "traits": { - "smithy.api#documentation": "

Data type of a column.

\n " - } - }, - "columnName": { - "target": "com.amazonaws.finspacedata#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of a column.

" - } - }, - "columnDescription": { - "target": "com.amazonaws.finspacedata#ColumnDescription", - "traits": { - "smithy.api#documentation": "

Description for a column.

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

The definition of a column in a tabular Dataset.

" - } - }, - "com.amazonaws.finspacedata#ColumnDescription": { - "type": "string", - "traits": { - "smithy.api#documentation": "Column Description", - "smithy.api#length": { - "min": 0, - "max": 512 - }, - "smithy.api#pattern": "^[\\s\\S]*$" - } - }, - "com.amazonaws.finspacedata#ColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspacedata#ColumnDefinition" - }, - "traits": { - "smithy.api#documentation": "List of Column Definitions" - } - }, - "com.amazonaws.finspacedata#ColumnName": { - "type": "string", - "traits": { - "smithy.api#documentation": "Column Name", - "smithy.api#length": { - "min": 0, - "max": 126 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.finspacedata#ColumnNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspacedata#ColumnName" - }, - "traits": { - "smithy.api#documentation": "List of Column Names" - } - }, - "com.amazonaws.finspacedata#ConflictException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspacedata#ErrorMessage2" - }, - "reason": { - "target": "com.amazonaws.finspacedata#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "

The request conflicts with an existing resource.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.finspacedata#CreateChangeset": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#CreateChangesetRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#CreateChangesetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#LimitExceededException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Creates a new Changeset in a FinSpace Dataset.

", - "smithy.api#http": { - "method": "POST", - "uri": "/datasets/{datasetId}/changesetsv2", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#CreateChangesetRequest": { - "type": "structure", - "members": { - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - }, - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the FinSpace Dataset where the Changeset will be created.\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "changeType": { - "target": "com.amazonaws.finspacedata#ChangeType", - "traits": { - "smithy.api#documentation": "

The option to indicate how a Changeset will be applied to a Dataset.

\n ", - "smithy.api#required": {} - } - }, - "sourceParams": { - "target": "com.amazonaws.finspacedata#SourceParams", - "traits": { - "smithy.api#documentation": "

Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).

\n

Both s3SourcePath and sourceType are required attributes.

\n

Here is an example of how you could specify the sourceParams:

\n

\n \n \"sourceParams\": \n {\n \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\",\n \"sourceType\": \"S3\"\n }\n \n

\n

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.

", - "smithy.api#required": {} - } - }, - "formatParams": { - "target": "com.amazonaws.finspacedata#FormatParams", - "traits": { - "smithy.api#documentation": "

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).\n

\n

\n formatType is a required attribute and can have the following values:\n

\n \n

Here is an example of how you could specify the formatParams:

\n

\n \n \"formatParams\": \n {\n \"formatType\": \"CSV\",\n \"withHeader\": \"true\",\n \"separator\": \",\",\n \"compression\":\"None\"\n } \n \n

\n

Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:

\n

\n \n {\n \"withHeader\": \"true\",\n \"separator\": \",\"\n }\n \n

\n

For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The request for a CreateChangeset operation.", - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#CreateChangesetResponse": { - "type": "structure", - "members": { - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the FinSpace Dataset where the Changeset is created.

" - } - }, - "changesetId": { - "target": "com.amazonaws.finspacedata#ChangesetId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the Changeset that is created.

" - } - } - }, - "traits": { - "smithy.api#documentation": "The response from a CreateChangeset operation.", - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#CreateDataView": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#CreateDataViewRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#CreateDataViewResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#LimitExceededException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Creates a Dataview for a Dataset.

", - "smithy.api#http": { - "method": "POST", - "uri": "/datasets/{datasetId}/dataviewsv2", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#CreateDataViewRequest": { - "type": "structure", - "members": { - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - }, - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique Dataset identifier that is used to create a Dataview.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "autoUpdate": { - "target": "com.amazonaws.finspacedata#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Flag to indicate Dataview should be updated automatically.

" - } - }, - "sortColumns": { - "target": "com.amazonaws.finspacedata#SortColumnList", - "traits": { - "smithy.api#documentation": "

Columns to be used for sorting the data.

" - } - }, - "partitionColumns": { - "target": "com.amazonaws.finspacedata#PartitionColumnList", - "traits": { - "smithy.api#documentation": "

Ordered set of column names used to partition data.

" - } - }, - "asOfTimestamp": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

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.

" - } - }, - "destinationTypeParams": { - "target": "com.amazonaws.finspacedata#DataViewDestinationTypeParams", - "traits": { - "smithy.api#documentation": "

Options that define the destination type for the Dataview.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Request for creating a data view.", - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#CreateDataViewResponse": { - "type": "structure", - "members": { - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the Dataset used for the Dataview.

" - } - }, - "dataViewId": { - "target": "com.amazonaws.finspacedata#DataViewId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the created Dataview.

" - } - } - }, - "traits": { - "smithy.api#documentation": "Response for creating a data view.", - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#CreateDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#CreateDatasetRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#CreateDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#LimitExceededException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Creates a new FinSpace Dataset.

", - "smithy.api#http": { - "method": "POST", - "uri": "/datasetsv2", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#CreateDatasetRequest": { - "type": "structure", - "members": { - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - }, - "datasetTitle": { - "target": "com.amazonaws.finspacedata#DatasetTitle", - "traits": { - "smithy.api#documentation": "

Display title for a FinSpace Dataset.

", - "smithy.api#required": {} - } - }, - "kind": { - "target": "com.amazonaws.finspacedata#DatasetKind", - "traits": { - "smithy.api#documentation": "

The format in which Dataset data is structured.

\n ", - "smithy.api#required": {} - } - }, - "datasetDescription": { - "target": "com.amazonaws.finspacedata#DatasetDescription", - "traits": { - "smithy.api#documentation": "

Description of a Dataset.

" - } - }, - "ownerInfo": { - "target": "com.amazonaws.finspacedata#DatasetOwnerInfo", - "traits": { - "smithy.api#documentation": "

Contact information for a Dataset owner.

" - } - }, - "permissionGroupParams": { - "target": "com.amazonaws.finspacedata#PermissionGroupParams", - "traits": { - "smithy.api#documentation": "

Permission group parameters for Dataset permissions.

", - "smithy.api#required": {} - } - }, - "alias": { - "target": "com.amazonaws.finspacedata#AliasString", - "traits": { - "smithy.api#documentation": "

The unique resource identifier for a Dataset.

" - } - }, - "schemaDefinition": { - "target": "com.amazonaws.finspacedata#SchemaUnion", - "traits": { - "smithy.api#documentation": "

Definition for a schema on a tabular Dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "The request for a CreateDataset operation", - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#CreateDatasetResponse": { - "type": "structure", - "members": { - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the created Dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "The response from a CreateDataset operation", - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#CreatePermissionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#CreatePermissionGroupRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#CreatePermissionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#LimitExceededException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Creates a group of permissions for various actions that a user can perform in FinSpace.

", - "smithy.api#http": { - "method": "POST", - "uri": "/permission-group", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#CreatePermissionGroupRequest": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspacedata#PermissionGroupName", - "traits": { - "smithy.api#documentation": "

The name of the permission group.

", - "smithy.api#required": {} - } - }, - "description": { - "target": "com.amazonaws.finspacedata#PermissionGroupDescription", - "traits": { - "smithy.api#documentation": "

A brief description for the permission group.

" - } - }, - "applicationPermissions": { - "target": "com.amazonaws.finspacedata#ApplicationPermissionList", - "traits": { - "smithy.api#documentation": "

The option to indicate FinSpace application permissions that are granted to a specific group.

\n \n

When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

\n \n ", - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#CreatePermissionGroupResponse": { - "type": "structure", - "members": { - "permissionGroupId": { - "target": "com.amazonaws.finspacedata#PermissionGroupId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the permission group.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#CreateUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#CreateUserRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#CreateUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#LimitExceededException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Creates a new user in FinSpace.

", - "smithy.api#http": { - "method": "POST", - "uri": "/user", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#CreateUserRequest": { - "type": "structure", - "members": { - "emailAddress": { - "target": "com.amazonaws.finspacedata#Email", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.finspacedata#UserType", - "traits": { - "smithy.api#documentation": "

The option to indicate the type of user. Use one of the following options to specify this parameter:

\n ", - "smithy.api#required": {} - } - }, - "firstName": { - "target": "com.amazonaws.finspacedata#FirstName", - "traits": { - "smithy.api#documentation": "

The first name of the user that you want to register.

" - } - }, - "lastName": { - "target": "com.amazonaws.finspacedata#LastName", - "traits": { - "smithy.api#documentation": "

The last name of the user that you want to register.

" - } - }, - "apiAccess": { - "target": "com.amazonaws.finspacedata#ApiAccess", - "traits": { - "smithy.api#documentation": "

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.

\n " - } - }, - "apiAccessPrincipalArn": { - "target": "com.amazonaws.finspacedata#RoleArn", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#CreateUserResponse": { - "type": "structure", - "members": { - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the user.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#Credentials": { - "type": "structure", - "members": { - "accessKeyId": { - "target": "com.amazonaws.finspacedata#StringValueLength1to2552", - "traits": { - "smithy.api#documentation": "

The access key identifier.

" - } - }, - "secretAccessKey": { - "target": "com.amazonaws.finspacedata#stringValueMaxLength1000", - "traits": { - "smithy.api#documentation": "

The access key.

" - } - }, - "sessionToken": { - "target": "com.amazonaws.finspacedata#stringValueMaxLength1000", - "traits": { - "smithy.api#documentation": "

The session token.

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

Short term API credentials.

", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.finspacedata#DataViewArn": { - "type": "string", - "traits": { - "smithy.api#documentation": "Arn of a DataView" - } - }, - "com.amazonaws.finspacedata#DataViewDestinationType": { - "type": "string", - "traits": { - "smithy.api#documentation": "DataView Destination Type" - } - }, - "com.amazonaws.finspacedata#DataViewDestinationTypeParams": { - "type": "structure", - "members": { - "destinationType": { - "target": "com.amazonaws.finspacedata#DataViewDestinationType", - "traits": { - "smithy.api#documentation": "

Destination type for a Dataview.

\n ", - "smithy.api#required": {} - } - }, - "s3DestinationExportFileFormat": { - "target": "com.amazonaws.finspacedata#ExportFileFormat", - "traits": { - "smithy.api#documentation": "

Dataview export file format.

\n " - } - }, - "s3DestinationExportFileFormatOptions": { - "target": "com.amazonaws.finspacedata#S3DestinationFormatOptions", - "traits": { - "smithy.api#documentation": "

Format Options for S3 Destination type.

\n

Here is an example of how you could specify the s3DestinationExportFileFormatOptions\n

\n

\n \n {\n \"header\": \"true\",\n \"delimiter\": \",\",\n \"compression\": \"gzip\"\n }\n

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

Structure for the Dataview destination type parameters.

" - } - }, - "com.amazonaws.finspacedata#DataViewErrorInfo": { - "type": "structure", - "members": { - "errorMessage": { - "target": "com.amazonaws.finspacedata#ErrorMessage", - "traits": { - "smithy.api#documentation": "

The text of the error message.

" - } - }, - "errorCategory": { - "target": "com.amazonaws.finspacedata#ErrorCategory", - "traits": { - "smithy.api#documentation": "

The category of the error.

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

The structure with error messages.

" - } - }, - "com.amazonaws.finspacedata#DataViewId": { - "type": "string", - "traits": { - "smithy.api#documentation": "DataView ID", - "smithy.api#length": { - "min": 1, - "max": 26 - } - } - }, - "com.amazonaws.finspacedata#DataViewList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspacedata#DataViewSummary" - }, - "traits": { - "smithy.api#documentation": "List of Data Views" - } - }, - "com.amazonaws.finspacedata#DataViewStatus": { - "type": "enum", - "members": { - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "STARTING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - }, - "TIMEOUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TIMEOUT" - } - }, - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "FAILED_CLEANUP_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_CLEANUP_FAILED" - } - } - }, - "traits": { - "smithy.api#documentation": "Status of a DataView" - } - }, - "com.amazonaws.finspacedata#DataViewSummary": { - "type": "structure", - "members": { - "dataViewId": { - "target": "com.amazonaws.finspacedata#DataViewId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the Dataview.

" - } - }, - "dataViewArn": { - "target": "com.amazonaws.finspacedata#DataViewArn", - "traits": { - "smithy.api#documentation": "

The ARN identifier of the Dataview.

" - } - }, - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

Th unique identifier for the Dataview Dataset.

" - } - }, - "asOfTimestamp": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

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.

" - } - }, - "partitionColumns": { - "target": "com.amazonaws.finspacedata#PartitionColumnList", - "traits": { - "smithy.api#documentation": "

Ordered set of column names used to partition data.

" - } - }, - "sortColumns": { - "target": "com.amazonaws.finspacedata#SortColumnList", - "traits": { - "smithy.api#documentation": "

Columns to be used for sorting the data.

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

The status of a Dataview creation.

\n " - } - }, - "errorInfo": { - "target": "com.amazonaws.finspacedata#DataViewErrorInfo", - "traits": { - "smithy.api#documentation": "

The structure with error messages.

" - } - }, - "destinationTypeProperties": { - "target": "com.amazonaws.finspacedata#DataViewDestinationTypeParams", - "traits": { - "smithy.api#documentation": "

Information about the Dataview destination.

" - } - }, - "autoUpdate": { - "target": "com.amazonaws.finspacedata#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The flag to indicate Dataview should be updated automatically.

" - } - }, - "createTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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.

" - } - }, - "lastModifiedTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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.

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

Structure for the summary of a Dataview.

" - } - }, - "com.amazonaws.finspacedata#Dataset": { - "type": "structure", - "members": { - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

An identifier for a Dataset.

" - } - }, - "datasetArn": { - "target": "com.amazonaws.finspacedata#DatasetArn", - "traits": { - "smithy.api#documentation": "

The ARN identifier of the Dataset.

" - } - }, - "datasetTitle": { - "target": "com.amazonaws.finspacedata#DatasetTitle", - "traits": { - "smithy.api#documentation": "

Display title for a Dataset.

" - } - }, - "kind": { - "target": "com.amazonaws.finspacedata#DatasetKind", - "traits": { - "smithy.api#documentation": "

The format in which Dataset data is structured.

\n " - } - }, - "datasetDescription": { - "target": "com.amazonaws.finspacedata#DatasetDescription", - "traits": { - "smithy.api#documentation": "

Description for a Dataset.

" - } - }, - "ownerInfo": { - "target": "com.amazonaws.finspacedata#DatasetOwnerInfo", - "traits": { - "smithy.api#documentation": "

Contact information for a Dataset owner.

" - } - }, - "createTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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.

" - } - }, - "lastModifiedTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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.

" - } - }, - "schemaDefinition": { - "target": "com.amazonaws.finspacedata#SchemaUnion", - "traits": { - "smithy.api#documentation": "

Definition for a schema on a tabular Dataset.

" - } - }, - "alias": { - "target": "com.amazonaws.finspacedata#AliasString", - "traits": { - "smithy.api#documentation": "

The unique resource identifier for a Dataset.

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

The structure for a Dataset.

" - } - }, - "com.amazonaws.finspacedata#DatasetArn": { - "type": "string", - "traits": { - "smithy.api#documentation": "Arn of a Dataset" - } - }, - "com.amazonaws.finspacedata#DatasetDescription": { - "type": "string", - "traits": { - "smithy.api#documentation": "Description of a dataset", - "smithy.api#length": { - "min": 0, - "max": 1000 - }, - "smithy.api#pattern": "^[\\s\\S]*$" - } - }, - "com.amazonaws.finspacedata#DatasetId": { - "type": "string", - "traits": { - "smithy.api#documentation": "ID for a given Dataset", - "smithy.api#length": { - "min": 1, - "max": 26 - } - } - }, - "com.amazonaws.finspacedata#DatasetKind": { - "type": "enum", - "members": { - "TABULAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TABULAR" - } - }, - "NON_TABULAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NON_TABULAR" - } - } - }, - "traits": { - "smithy.api#documentation": "Dataset Kind" - } - }, - "com.amazonaws.finspacedata#DatasetList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspacedata#Dataset" - }, - "traits": { - "smithy.api#documentation": "List of Dataset structures" - } - }, - "com.amazonaws.finspacedata#DatasetOwnerInfo": { - "type": "structure", - "members": { - "name": { - "target": "com.amazonaws.finspacedata#OwnerName", - "traits": { - "smithy.api#documentation": "

The name of the Dataset owner.

" - } - }, - "phoneNumber": { - "target": "com.amazonaws.finspacedata#PhoneNumber", - "traits": { - "smithy.api#documentation": "

Phone number for the Dataset owner.

" - } - }, - "email": { - "target": "com.amazonaws.finspacedata#Email", - "traits": { - "smithy.api#documentation": "

Email address for the Dataset owner.

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

A structure for Dataset owner info.

" - } - }, - "com.amazonaws.finspacedata#DatasetStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - } - }, - "traits": { - "smithy.api#documentation": "Status of the dataset process returned from scheduler service." - } - }, - "com.amazonaws.finspacedata#DatasetTitle": { - "type": "string", - "traits": { - "smithy.api#documentation": "Title for a given Dataset", - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.finspacedata#DeleteDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#DeleteDatasetRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#DeleteDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#LimitExceededException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Deletes a FinSpace Dataset.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/datasetsv2/{datasetId}", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#DeleteDatasetRequest": { - "type": "structure", - "members": { - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - }, - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the Dataset to be deleted.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "The request for a DeleteDataset operation.", - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#DeleteDatasetResponse": { - "type": "structure", - "members": { - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the deleted Dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "The response from an DeleteDataset operation", - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#DeletePermissionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#DeletePermissionGroupRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#DeletePermissionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#LimitExceededException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Deletes a permission group. This action is irreversible.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/permission-group/{permissionGroupId}", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#DeletePermissionGroupRequest": { - "type": "structure", - "members": { - "permissionGroupId": { - "target": "com.amazonaws.finspacedata#PermissionGroupId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the permission group that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#DeletePermissionGroupResponse": { - "type": "structure", - "members": { - "permissionGroupId": { - "target": "com.amazonaws.finspacedata#PermissionGroupId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the deleted permission group.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#DisableUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#DisableUserRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#DisableUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Denies access to the FinSpace web application and API for the specified user.

", - "smithy.api#http": { - "method": "POST", - "uri": "/user/{userId}/disable", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#DisableUserRequest": { - "type": "structure", - "members": { - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the user that you want to deactivate.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#DisableUserResponse": { - "type": "structure", - "members": { - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the deactivated user.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#DisassociateUserFromPermissionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#DisassociateUserFromPermissionGroupRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#DisassociateUserFromPermissionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Removes a user from a permission group.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/permission-group/{permissionGroupId}/users/{userId}", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#DisassociateUserFromPermissionGroupRequest": { - "type": "structure", - "members": { - "permissionGroupId": { - "target": "com.amazonaws.finspacedata#PermissionGroupId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the permission group.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the user.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#httpQuery": "clientToken", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#DisassociateUserFromPermissionGroupResponse": { - "type": "structure", - "members": { - "statusCode": { - "target": "com.amazonaws.finspacedata#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The returned status code of the response.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#Email": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 4, - "max": 320 - }, - "smithy.api#pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.finspacedata#EnableUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#EnableUserRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#EnableUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#LimitExceededException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Allows the specified user to access the FinSpace web application and API.

", - "smithy.api#http": { - "method": "POST", - "uri": "/user/{userId}/enable", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#EnableUserRequest": { - "type": "structure", - "members": { - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the user that you want to activate.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#EnableUserResponse": { - "type": "structure", - "members": { - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the active user.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#ErrorCategory": { - "type": "enum", - "members": { - "VALIDATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALIDATION" - } - }, - "SERVICE_QUOTA_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SERVICE_QUOTA_EXCEEDED" - } - }, - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_DENIED" - } - }, - "RESOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESOURCE_NOT_FOUND" - } - }, - "THROTTLING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THROTTLING" - } - }, - "INTERNAL_SERVICE_EXCEPTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_SERVICE_EXCEPTION" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - }, - "USER_RECOVERABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USER_RECOVERABLE" - } - } - }, - "traits": { - "smithy.api#documentation": "Changeset Error Category" - } - }, - "com.amazonaws.finspacedata#ErrorMessage": { - "type": "string", - "traits": { - "smithy.api#documentation": "Changeset Error Message", - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.finspacedata#ErrorMessage2": { - "type": "string" - }, - "com.amazonaws.finspacedata#ExportFileFormat": { - "type": "enum", - "members": { - "PARQUET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARQUET" - } - }, - "DELIMITED_TEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELIMITED_TEXT" - } - } - }, - "traits": { - "smithy.api#documentation": "Data View Export File Format" - } - }, - "com.amazonaws.finspacedata#FirstName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#pattern": "\\S", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.finspacedata#FormatParams": { - "type": "map", - "key": { - "target": "com.amazonaws.finspacedata#StringMapKey" - }, - "value": { - "target": "com.amazonaws.finspacedata#StringMapValue" - }, - "traits": { - "smithy.api#documentation": "Format Parameters of a Changeset" - } - }, - "com.amazonaws.finspacedata#GetChangeset": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#GetChangesetRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#GetChangesetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Get information about a Changeset.

", - "smithy.api#http": { - "method": "GET", - "uri": "/datasets/{datasetId}/changesetsv2/{changesetId}", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#GetChangesetRequest": { - "type": "structure", - "members": { - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the FinSpace Dataset where the Changeset is created.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "changesetId": { - "target": "com.amazonaws.finspacedata#ChangesetId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the Changeset for which to get data.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Request to describe a changeset.", - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#GetChangesetResponse": { - "type": "structure", - "members": { - "changesetId": { - "target": "com.amazonaws.finspacedata#ChangesetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for a Changeset.

" - } - }, - "changesetArn": { - "target": "com.amazonaws.finspacedata#ChangesetArn", - "traits": { - "smithy.api#documentation": "

The ARN identifier of the Changeset.

" - } - }, - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the FinSpace Dataset where the Changeset is created.

" - } - }, - "changeType": { - "target": "com.amazonaws.finspacedata#ChangeType", - "traits": { - "smithy.api#documentation": "

Type that indicates how a Changeset is applied to a Dataset.

\n " - } - }, - "sourceParams": { - "target": "com.amazonaws.finspacedata#SourceParams", - "traits": { - "smithy.api#documentation": "

Options that define the location of the data being ingested.

" - } - }, - "formatParams": { - "target": "com.amazonaws.finspacedata#FormatParams", - "traits": { - "smithy.api#documentation": "

Structure of the source file(s).

" - } - }, - "createTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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.

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

The status of Changeset creation operation.

" - } - }, - "errorInfo": { - "target": "com.amazonaws.finspacedata#ChangesetErrorInfo", - "traits": { - "smithy.api#documentation": "

The structure with error messages.

" - } - }, - "activeUntilTimestamp": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

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.

" - } - }, - "activeFromTimestamp": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

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.

" - } - }, - "updatesChangesetId": { - "target": "com.amazonaws.finspacedata#ChangesetId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the Changeset that is being updated.

" - } - }, - "updatedByChangesetId": { - "target": "com.amazonaws.finspacedata#ChangesetId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the updated Changeset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "The response from a describe changeset operation", - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#GetDataView": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#GetDataViewRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#GetDataViewResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Gets information about a Dataview.

", - "smithy.api#http": { - "method": "GET", - "uri": "/datasets/{datasetId}/dataviewsv2/{dataViewId}", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#GetDataViewRequest": { - "type": "structure", - "members": { - "dataViewId": { - "target": "com.amazonaws.finspacedata#DataViewId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the Dataview.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the Dataset used in the Dataview.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.", - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#GetDataViewResponse": { - "type": "structure", - "members": { - "autoUpdate": { - "target": "com.amazonaws.finspacedata#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Flag to indicate Dataview should be updated automatically.

" - } - }, - "partitionColumns": { - "target": "com.amazonaws.finspacedata#PartitionColumnList", - "traits": { - "smithy.api#documentation": "

Ordered set of column names used to partition data.

" - } - }, - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the Dataset used in the Dataview.

" - } - }, - "asOfTimestamp": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

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.

" - } - }, - "errorInfo": { - "target": "com.amazonaws.finspacedata#DataViewErrorInfo", - "traits": { - "smithy.api#documentation": "

Information about an error that occurred for the Dataview.

" - } - }, - "lastModifiedTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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.

" - } - }, - "createTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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.

" - } - }, - "sortColumns": { - "target": "com.amazonaws.finspacedata#SortColumnList", - "traits": { - "smithy.api#documentation": "

Columns to be used for sorting the data.

" - } - }, - "dataViewId": { - "target": "com.amazonaws.finspacedata#DataViewId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the Dataview.

" - } - }, - "dataViewArn": { - "target": "com.amazonaws.finspacedata#DataViewArn", - "traits": { - "smithy.api#documentation": "

The ARN identifier of the Dataview.

" - } - }, - "destinationTypeParams": { - "target": "com.amazonaws.finspacedata#DataViewDestinationTypeParams", - "traits": { - "smithy.api#documentation": "

Options that define the destination type for the Dataview.

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

The status of a Dataview creation.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "Response from retrieving a dataview, which includes details on the target database and table name", - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#GetDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#GetDatasetRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#GetDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Returns information about a Dataset.

", - "smithy.api#http": { - "method": "GET", - "uri": "/datasetsv2/{datasetId}", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#GetDatasetRequest": { - "type": "structure", - "members": { - "datasetId": { - "target": "com.amazonaws.finspacedata#StringValueLength1to255", - "traits": { - "smithy.api#documentation": "

The unique identifier for a Dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Request for the GetDataset operation.", - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#GetDatasetResponse": { - "type": "structure", - "members": { - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for a Dataset.

" - } - }, - "datasetArn": { - "target": "com.amazonaws.finspacedata#DatasetArn", - "traits": { - "smithy.api#documentation": "

The ARN identifier of the Dataset.

" - } - }, - "datasetTitle": { - "target": "com.amazonaws.finspacedata#DatasetTitle", - "traits": { - "smithy.api#documentation": "

Display title for a Dataset.

" - } - }, - "kind": { - "target": "com.amazonaws.finspacedata#DatasetKind", - "traits": { - "smithy.api#documentation": "

The format in which Dataset data is structured.

\n " - } - }, - "datasetDescription": { - "target": "com.amazonaws.finspacedata#DatasetDescription", - "traits": { - "smithy.api#documentation": "

A description of the Dataset.

" - } - }, - "createTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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.

" - } - }, - "lastModifiedTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

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.

" - } - }, - "schemaDefinition": { - "target": "com.amazonaws.finspacedata#SchemaUnion", - "traits": { - "smithy.api#documentation": "

Definition for a schema on a tabular Dataset.

" - } - }, - "alias": { - "target": "com.amazonaws.finspacedata#AliasString", - "traits": { - "smithy.api#documentation": "

The unique resource identifier for a Dataset.

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

Status of the Dataset creation.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "Response for the GetDataset operation", - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#GetExternalDataViewAccessDetails": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#GetExternalDataViewAccessDetailsRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#GetExternalDataViewAccessDetailsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Returns the credentials to access the external Dataview from an S3 location. To call this API:

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/datasets/{datasetId}/dataviewsv2/{dataViewId}/external-access-details", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#GetExternalDataViewAccessDetailsRequest": { - "type": "structure", - "members": { - "dataViewId": { - "target": "com.amazonaws.finspacedata#DataViewId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the Dataview that you want to access.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the Dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#GetExternalDataViewAccessDetailsResponse": { - "type": "structure", - "members": { - "credentials": { - "target": "com.amazonaws.finspacedata#AwsCredentials", - "traits": { - "smithy.api#documentation": "

The credentials required to access the external Dataview from the S3 location.

" - } - }, - "s3Location": { - "target": "com.amazonaws.finspacedata#S3Location", - "traits": { - "smithy.api#documentation": "

The location where the external Dataview is stored.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#GetPermissionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#GetPermissionGroupRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#GetPermissionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Retrieves the details of a specific permission group.

", - "smithy.api#http": { - "method": "GET", - "uri": "/permission-group/{permissionGroupId}", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#GetPermissionGroupRequest": { - "type": "structure", - "members": { - "permissionGroupId": { - "target": "com.amazonaws.finspacedata#PermissionGroupId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the permission group.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#GetPermissionGroupResponse": { - "type": "structure", - "members": { - "permissionGroup": { - "target": "com.amazonaws.finspacedata#PermissionGroup" - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#GetProgrammaticAccessCredentials": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#GetProgrammaticAccessCredentialsRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#GetProgrammaticAccessCredentialsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Request programmatic credentials to use with FinSpace SDK. For more information, see Step 2. Access credentials programmatically using IAM access key id and secret access key.

", - "smithy.api#http": { - "method": "GET", - "uri": "/credentials/programmatic", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#GetProgrammaticAccessCredentialsRequest": { - "type": "structure", - "members": { - "durationInMinutes": { - "target": "com.amazonaws.finspacedata#SessionDuration", - "traits": { - "smithy.api#documentation": "

The time duration in which the credentials remain valid.

", - "smithy.api#httpQuery": "durationInMinutes" - } - }, - "environmentId": { - "target": "com.amazonaws.finspacedata#IdType", - "traits": { - "smithy.api#documentation": "

The FinSpace environment identifier.

", - "smithy.api#httpQuery": "environmentId", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Request for GetProgrammaticAccessCredentials operation", - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#GetProgrammaticAccessCredentialsResponse": { - "type": "structure", - "members": { - "credentials": { - "target": "com.amazonaws.finspacedata#Credentials", - "traits": { - "smithy.api#documentation": "

Returns the programmatic credentials.

" - } - }, - "durationInMinutes": { - "target": "com.amazonaws.finspacedata#SessionDuration", - "traits": { - "smithy.api#documentation": "

Returns the duration in which the credentials will remain valid.

" - } - } - }, - "traits": { - "smithy.api#documentation": "Response for GetProgrammaticAccessCredentials operation", - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#GetUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#GetUserRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#GetUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Retrieves details for a specific user.

", - "smithy.api#http": { - "method": "GET", - "uri": "/user/{userId}", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#GetUserRequest": { - "type": "structure", - "members": { - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the user to get data for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#GetUserResponse": { - "type": "structure", - "members": { - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the user that is retrieved.

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

The current status of the user.

\n " - } - }, - "firstName": { - "target": "com.amazonaws.finspacedata#FirstName", - "traits": { - "smithy.api#documentation": "

The first name of the user.

" - } - }, - "lastName": { - "target": "com.amazonaws.finspacedata#LastName", - "traits": { - "smithy.api#documentation": "

The last name of the user.

" - } - }, - "emailAddress": { - "target": "com.amazonaws.finspacedata#Email", - "traits": { - "smithy.api#documentation": "

The email address that is associated with the user.

" - } - }, - "type": { - "target": "com.amazonaws.finspacedata#UserType", - "traits": { - "smithy.api#documentation": "

Indicates the type of user.

\n \n " - } - }, - "apiAccess": { - "target": "com.amazonaws.finspacedata#ApiAccess", - "traits": { - "smithy.api#documentation": "

Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

\n " - } - }, - "apiAccessPrincipalArn": { - "target": "com.amazonaws.finspacedata#RoleArn", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "createTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.

" - } - }, - "lastEnabledTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Describes the last time the user was activated. The value is determined as epoch time in milliseconds.

" - } - }, - "lastDisabledTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.

" - } - }, - "lastModifiedTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.

" - } - }, - "lastLoginTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#GetWorkingLocation": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#GetWorkingLocationRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#GetWorkingLocationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

A temporary Amazon S3 location, where you can copy your files from a source location to stage or use\n as a scratch space in FinSpace notebook.

", - "smithy.api#http": { - "method": "POST", - "uri": "/workingLocationV1", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#GetWorkingLocationRequest": { - "type": "structure", - "members": { - "locationType": { - "target": "com.amazonaws.finspacedata#locationType", - "traits": { - "smithy.api#documentation": "

Specify the type of the working location.

\n " - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#GetWorkingLocationResponse": { - "type": "structure", - "members": { - "s3Uri": { - "target": "com.amazonaws.finspacedata#stringValueLength1to1024", - "traits": { - "smithy.api#documentation": "

Returns the Amazon S3 URI for the working location.

" - } - }, - "s3Path": { - "target": "com.amazonaws.finspacedata#stringValueLength1to1024", - "traits": { - "smithy.api#documentation": "

Returns the Amazon S3 Path for the working location.

" - } - }, - "s3Bucket": { - "target": "com.amazonaws.finspacedata#stringValueLength1to63", - "traits": { - "smithy.api#documentation": "

Returns the Amazon S3 bucket name for the working location.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#IdType": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 26 - } - } - }, - "com.amazonaws.finspacedata#IngestionStatus": { - "type": "enum", - "members": { - "PENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PENDING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESS" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "STOP_REQUESTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STOP_REQUESTED" - } - } - }, - "traits": { - "smithy.api#documentation": "Status of the ingestion process returned from scheduler service." - } - }, - "com.amazonaws.finspacedata#InternalServerException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspacedata#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "

The request processing has failed because of an unknown error, exception or\n failure.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.finspacedata#LastName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - }, - "smithy.api#pattern": "\\S", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.finspacedata#LimitExceededException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspacedata#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "

A limit has exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.finspacedata#ListChangesets": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#ListChangesetsRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#ListChangesetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Lists the FinSpace Changesets for a Dataset.

", - "smithy.api#http": { - "method": "GET", - "uri": "/datasets/{datasetId}/changesetsv2", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "changesets", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspacedata#ListChangesetsRequest": { - "type": "structure", - "members": { - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the FinSpace Dataset to which the Changeset belongs.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "maxResults": { - "target": "com.amazonaws.finspacedata#ResultLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of results per page.

", - "smithy.api#httpQuery": "maxResults" - } - }, - "nextToken": { - "target": "com.amazonaws.finspacedata#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

", - "smithy.api#httpQuery": "nextToken" - } - } - }, - "traits": { - "smithy.api#documentation": "Request to ListChangesetsRequest. It exposes minimal query filters.", - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#ListChangesetsResponse": { - "type": "structure", - "members": { - "changesets": { - "target": "com.amazonaws.finspacedata#ChangesetList", - "traits": { - "smithy.api#documentation": "

List of Changesets found.

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspacedata#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

" - } - } - }, - "traits": { - "smithy.api#documentation": "Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.", - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#ListDataViews": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#ListDataViewsRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#ListDataViewsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Lists all available Dataviews for a Dataset.

", - "smithy.api#http": { - "method": "GET", - "uri": "/datasets/{datasetId}/dataviewsv2", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "dataViews", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspacedata#ListDataViewsRequest": { - "type": "structure", - "members": { - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the Dataset for which to retrieve Dataviews.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.finspacedata#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspacedata#ResultLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of results per page.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#documentation": "Request for a list data views.", - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#ListDataViewsResponse": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.finspacedata#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

" - } - }, - "dataViews": { - "target": "com.amazonaws.finspacedata#DataViewList", - "traits": { - "smithy.api#documentation": "

A list of Dataviews.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#ListDatasets": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#ListDatasetsRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#ListDatasetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Lists all of the active Datasets that a user has access to.

", - "smithy.api#http": { - "method": "GET", - "uri": "/datasetsv2", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "datasets", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspacedata#ListDatasetsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.finspacedata#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspacedata#ResultLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of results per page.

", - "smithy.api#httpQuery": "maxResults" - } - } - }, - "traits": { - "smithy.api#documentation": "Request for the ListDatasets operation.", - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#ListDatasetsResponse": { - "type": "structure", - "members": { - "datasets": { - "target": "com.amazonaws.finspacedata#DatasetList", - "traits": { - "smithy.api#documentation": "

List of Datasets.

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspacedata#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

" - } - } - }, - "traits": { - "smithy.api#documentation": "Response for the ListDatasets operation", - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#ListPermissionGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#ListPermissionGroupsRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#ListPermissionGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Lists all available permission groups in FinSpace.

", - "smithy.api#http": { - "method": "GET", - "uri": "/permission-group", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "permissionGroups", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspacedata#ListPermissionGroupsByUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#ListPermissionGroupsByUserRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#ListPermissionGroupsByUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Lists all the permission groups that are associated with a specific user.

", - "smithy.api#http": { - "method": "GET", - "uri": "/user/{userId}/permission-groups", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#ListPermissionGroupsByUserRequest": { - "type": "structure", - "members": { - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the user.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.finspacedata#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspacedata#ResultLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of results per page.

", - "smithy.api#httpQuery": "maxResults", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#ListPermissionGroupsByUserResponse": { - "type": "structure", - "members": { - "permissionGroups": { - "target": "com.amazonaws.finspacedata#PermissionGroupByUserList", - "traits": { - "smithy.api#documentation": "

A list of returned permission groups.

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspacedata#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#ListPermissionGroupsRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.finspacedata#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspacedata#ResultLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of results per page.

", - "smithy.api#httpQuery": "maxResults", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#ListPermissionGroupsResponse": { - "type": "structure", - "members": { - "permissionGroups": { - "target": "com.amazonaws.finspacedata#PermissionGroupList", - "traits": { - "smithy.api#documentation": "

A list of all the permission groups.

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspacedata#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#ListUsers": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#ListUsersRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#ListUsersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Lists all available users in FinSpace.

", - "smithy.api#http": { - "method": "GET", - "uri": "/user", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "nextToken", - "outputToken": "nextToken", - "items": "users", - "pageSize": "maxResults" - } - } - }, - "com.amazonaws.finspacedata#ListUsersByPermissionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#ListUsersByPermissionGroupRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#ListUsersByPermissionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Lists details of all the users in a specific permission group.

", - "smithy.api#http": { - "method": "GET", - "uri": "/permission-group/{permissionGroupId}/users", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#ListUsersByPermissionGroupRequest": { - "type": "structure", - "members": { - "permissionGroupId": { - "target": "com.amazonaws.finspacedata#PermissionGroupId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the permission group.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "nextToken": { - "target": "com.amazonaws.finspacedata#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspacedata#ResultLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of results per page.

", - "smithy.api#httpQuery": "maxResults", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#ListUsersByPermissionGroupResponse": { - "type": "structure", - "members": { - "users": { - "target": "com.amazonaws.finspacedata#UserByPermissionGroupList", - "traits": { - "smithy.api#documentation": "

Lists details of all users in a specific permission group.

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspacedata#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#ListUsersRequest": { - "type": "structure", - "members": { - "nextToken": { - "target": "com.amazonaws.finspacedata#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

", - "smithy.api#httpQuery": "nextToken" - } - }, - "maxResults": { - "target": "com.amazonaws.finspacedata#ResultLimit", - "traits": { - "smithy.api#documentation": "

The maximum number of results per page.

", - "smithy.api#httpQuery": "maxResults", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#ListUsersResponse": { - "type": "structure", - "members": { - "users": { - "target": "com.amazonaws.finspacedata#UserList", - "traits": { - "smithy.api#documentation": "

A list of all the users.

" - } - }, - "nextToken": { - "target": "com.amazonaws.finspacedata#PaginationToken", - "traits": { - "smithy.api#documentation": "

A token that indicates where a results page should begin.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#OwnerName": { - "type": "string", - "traits": { - "smithy.api#documentation": "1 - 250 character String", - "smithy.api#length": { - "min": 1, - "max": 250 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.finspacedata#PaginationToken": { - "type": "string" - }, - "com.amazonaws.finspacedata#PartitionColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspacedata#StringValueLength1to255" - }, - "traits": { - "smithy.api#documentation": "DataView Partition Column List" - } - }, - "com.amazonaws.finspacedata#Password": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 8, - "max": 20 - }, - "smithy.api#pattern": "\\S", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.finspacedata#PermissionGroup": { - "type": "structure", - "members": { - "permissionGroupId": { - "target": "com.amazonaws.finspacedata#PermissionGroupId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the permission group.

" - } - }, - "name": { - "target": "com.amazonaws.finspacedata#PermissionGroupName", - "traits": { - "smithy.api#documentation": "

The name of the permission group.

" - } - }, - "description": { - "target": "com.amazonaws.finspacedata#PermissionGroupDescription", - "traits": { - "smithy.api#documentation": "

A brief description for the permission group.

" - } - }, - "applicationPermissions": { - "target": "com.amazonaws.finspacedata#ApplicationPermissionList", - "traits": { - "smithy.api#documentation": "

Indicates the permissions that are granted to a specific group for accessing the FinSpace application.

\n \n

When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

\n \n " - } - }, - "createTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.\n

" - } - }, - "lastModifiedTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.\n

" - } - }, - "membershipStatus": { - "target": "com.amazonaws.finspacedata#PermissionGroupMembershipStatus", - "traits": { - "smithy.api#documentation": "

Indicates the status of the user within a permission group.

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

The structure for a permission group.

" - } - }, - "com.amazonaws.finspacedata#PermissionGroupByUser": { - "type": "structure", - "members": { - "permissionGroupId": { - "target": "com.amazonaws.finspacedata#PermissionGroupId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the permission group.

" - } - }, - "name": { - "target": "com.amazonaws.finspacedata#PermissionGroupName", - "traits": { - "smithy.api#documentation": "

The name of the permission group.

" - } - }, - "membershipStatus": { - "target": "com.amazonaws.finspacedata#PermissionGroupMembershipStatus", - "traits": { - "smithy.api#documentation": "

Indicates the status of the user within a permission group.

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

The structure of a permission group associated with a user.

" - } - }, - "com.amazonaws.finspacedata#PermissionGroupByUserList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspacedata#PermissionGroupByUser" - } - }, - "com.amazonaws.finspacedata#PermissionGroupDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4000 - }, - "smithy.api#pattern": "^[\\s\\S]*$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.finspacedata#PermissionGroupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 26 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.finspacedata#PermissionGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspacedata#PermissionGroup" - } - }, - "com.amazonaws.finspacedata#PermissionGroupMembershipStatus": { - "type": "enum", - "members": { - "ADDITION_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADDITION_IN_PROGRESS" - } - }, - "ADDITION_SUCCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADDITION_SUCCESS" - } - }, - "REMOVAL_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REMOVAL_IN_PROGRESS" - } - } - } - }, - "com.amazonaws.finspacedata#PermissionGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "\\S", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.finspacedata#PermissionGroupParams": { - "type": "structure", - "members": { - "permissionGroupId": { - "target": "com.amazonaws.finspacedata#PermissionGroupId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the PermissionGroup.

" - } - }, - "datasetPermissions": { - "target": "com.amazonaws.finspacedata#ResourcePermissionsList", - "traits": { - "smithy.api#documentation": "

List of resource permissions.

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

Permission group parameters for Dataset permissions.

\n

Here is an example of how you could specify the PermissionGroupParams:

\n

\n \n {\n \"permissionGroupId\": \"0r6fCRtSTUk4XPfXQe3M0g\",\n \"datasetPermissions\": [\n {\"permission\": \"ViewDatasetDetails\"},\n {\"permission\": \"AddDatasetData\"},\n {\"permission\": \"EditDatasetMetadata\"},\n {\"permission\": \"DeleteDataset\"}\n ]\n }\n \n

" - } - }, - "com.amazonaws.finspacedata#PhoneNumber": { - "type": "string", - "traits": { - "smithy.api#documentation": "PhoneNumber of Dataset Owner", - "smithy.api#length": { - "min": 10, - "max": 20 - }, - "smithy.api#pattern": "^[\\+0-9\\#\\,\\(][\\+0-9\\-\\.\\/\\(\\)\\,\\#\\s]+$" - } - }, - "com.amazonaws.finspacedata#ResetUserPassword": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#ResetUserPasswordRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#ResetUserPasswordResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

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.

", - "smithy.api#http": { - "method": "POST", - "uri": "/user/{userId}/password", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#ResetUserPasswordRequest": { - "type": "structure", - "members": { - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the user that a temporary password is requested for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#ResetUserPasswordResponse": { - "type": "structure", - "members": { - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the user that a new password is generated for.

" - } - }, - "temporaryPassword": { - "target": "com.amazonaws.finspacedata#Password", - "traits": { - "smithy.api#documentation": "

A randomly generated temporary password for the requested user. This password expires in 7 days.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#ResourceNotFoundException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspacedata#ErrorMessage2" - }, - "reason": { - "target": "com.amazonaws.finspacedata#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "

One or more resources can't be found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.finspacedata#ResourcePermission": { - "type": "structure", - "members": { - "permission": { - "target": "com.amazonaws.finspacedata#StringValueLength1to250", - "traits": { - "smithy.api#documentation": "

Permission for a resource.

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

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.

\n

The following is a list of valid dataset permissions that you can apply:\n \n

\n \n

For more information on the dataset permissions, see Supported Dataset Permissions in the FinSpace User Guide.

" - } - }, - "com.amazonaws.finspacedata#ResourcePermissionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspacedata#ResourcePermission" - }, - "traits": { - "smithy.api#documentation": "List of Resource Permissions" - } - }, - "com.amazonaws.finspacedata#ResultLimit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.finspacedata#RoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - }, - "smithy.api#pattern": "^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" - } - }, - "com.amazonaws.finspacedata#S3BucketName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "^.*\\S.*$" - } - }, - "com.amazonaws.finspacedata#S3DestinationFormatOptions": { - "type": "map", - "key": { - "target": "com.amazonaws.finspacedata#StringMapKey" - }, - "value": { - "target": "com.amazonaws.finspacedata#StringMapValue" - } - }, - "com.amazonaws.finspacedata#S3Key": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^.*\\S.*$" - } - }, - "com.amazonaws.finspacedata#S3Location": { - "type": "structure", - "members": { - "bucket": { - "target": "com.amazonaws.finspacedata#S3BucketName", - "traits": { - "smithy.api#documentation": "

The name of the S3 bucket.

", - "smithy.api#required": {} - } - }, - "key": { - "target": "com.amazonaws.finspacedata#S3Key", - "traits": { - "smithy.api#documentation": "

The path of the folder, within the S3 bucket that contains the Dataset.

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

The location of an external Dataview in an S3 bucket.

" - } - }, - "com.amazonaws.finspacedata#SchemaDefinition": { - "type": "structure", - "members": { - "columns": { - "target": "com.amazonaws.finspacedata#ColumnList", - "traits": { - "smithy.api#documentation": "

List of column definitions.

" - } - }, - "primaryKeyColumns": { - "target": "com.amazonaws.finspacedata#ColumnNameList", - "traits": { - "smithy.api#documentation": "

List of column names used for primary key.

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

Definition for a schema on a tabular Dataset.

" - } - }, - "com.amazonaws.finspacedata#SchemaUnion": { - "type": "structure", - "members": { - "tabularSchemaConfig": { - "target": "com.amazonaws.finspacedata#SchemaDefinition", - "traits": { - "smithy.api#documentation": "

The configuration for a schema on a tabular Dataset.

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

A union of schema types.

" - } - }, - "com.amazonaws.finspacedata#SecretAccessKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.finspacedata#SessionDuration": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 60 - } - } - }, - "com.amazonaws.finspacedata#SessionToken": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.finspacedata#SortColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspacedata#StringValueLength1to255" - }, - "traits": { - "smithy.api#documentation": "DataView Sort Column List" - } - }, - "com.amazonaws.finspacedata#SourceParams": { - "type": "map", - "key": { - "target": "com.amazonaws.finspacedata#StringMapKey" - }, - "value": { - "target": "com.amazonaws.finspacedata#StringMapValue" - }, - "traits": { - "smithy.api#documentation": "Source Parameters of a Changeset" - } - }, - "com.amazonaws.finspacedata#StatusCode": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.finspacedata#StringMapKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - }, - "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" - } - }, - "com.amazonaws.finspacedata#StringMapValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - }, - "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" - } - }, - "com.amazonaws.finspacedata#StringValueLength1to250": { - "type": "string", - "traits": { - "smithy.api#documentation": "1 - 250 character String", - "smithy.api#length": { - "min": 1, - "max": 250 - }, - "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" - } - }, - "com.amazonaws.finspacedata#StringValueLength1to255": { - "type": "string", - "traits": { - "smithy.api#documentation": "1 - 255 character String", - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^[\\s\\S]*\\S[\\s\\S]*$" - } - }, - "com.amazonaws.finspacedata#StringValueLength1to2552": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - } - } - }, - "com.amazonaws.finspacedata#ThrottlingException": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

The request was denied due to request throttling.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.finspacedata#TimestampEpoch": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "Milliseconds since UTC epoch" - } - }, - "com.amazonaws.finspacedata#UpdateChangeset": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#UpdateChangesetRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#UpdateChangesetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Updates a FinSpace Changeset.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/datasets/{datasetId}/changesetsv2/{changesetId}", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#UpdateChangesetRequest": { - "type": "structure", - "members": { - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - }, - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the FinSpace Dataset in which the Changeset is created.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "changesetId": { - "target": "com.amazonaws.finspacedata#ChangesetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the Changeset to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "sourceParams": { - "target": "com.amazonaws.finspacedata#SourceParams", - "traits": { - "smithy.api#documentation": "

Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).

\n

Both s3SourcePath and sourceType are required attributes.

\n

Here is an example of how you could specify the sourceParams:

\n

\n \n \"sourceParams\": \n {\n \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\",\n \"sourceType\": \"S3\"\n }\n \n

\n

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.

", - "smithy.api#required": {} - } - }, - "formatParams": { - "target": "com.amazonaws.finspacedata#FormatParams", - "traits": { - "smithy.api#documentation": "

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).\n

\n

\n formatType is a required attribute and can have the following values:\n

\n \n

Here is an example of how you could specify the formatParams:

\n

\n \n \"formatParams\": \n {\n \"formatType\": \"CSV\",\n \"withHeader\": \"true\",\n \"separator\": \",\",\n \"compression\":\"None\"\n } \n \n

\n

Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:

\n

\n \n {\n \"withHeader\": \"true\",\n \"separator\": \",\"\n }\n \n

\n

For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "Request to update an existing changeset.", - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#UpdateChangesetResponse": { - "type": "structure", - "members": { - "changesetId": { - "target": "com.amazonaws.finspacedata#ChangesetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the Changeset to update.

" - } - }, - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the FinSpace Dataset in which the Changeset is created.

" - } - } - }, - "traits": { - "smithy.api#documentation": "The response from a update changeset operation.", - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#UpdateDataset": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#UpdateDatasetRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#UpdateDatasetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Updates a FinSpace Dataset.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/datasetsv2/{datasetId}", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#UpdateDatasetRequest": { - "type": "structure", - "members": { - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - }, - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the Dataset to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "datasetTitle": { - "target": "com.amazonaws.finspacedata#DatasetTitle", - "traits": { - "smithy.api#documentation": "

A display title for the Dataset.

", - "smithy.api#required": {} - } - }, - "kind": { - "target": "com.amazonaws.finspacedata#DatasetKind", - "traits": { - "smithy.api#documentation": "

The format in which the Dataset data is structured.

\n ", - "smithy.api#required": {} - } - }, - "datasetDescription": { - "target": "com.amazonaws.finspacedata#DatasetDescription", - "traits": { - "smithy.api#documentation": "

A description for the Dataset.

" - } - }, - "alias": { - "target": "com.amazonaws.finspacedata#AliasString", - "traits": { - "smithy.api#documentation": "

The unique resource identifier for a Dataset.

" - } - }, - "schemaDefinition": { - "target": "com.amazonaws.finspacedata#SchemaUnion", - "traits": { - "smithy.api#documentation": "

Definition for a schema on a tabular Dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "The request for an UpdateDataset operation", - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#UpdateDatasetResponse": { - "type": "structure", - "members": { - "datasetId": { - "target": "com.amazonaws.finspacedata#DatasetId", - "traits": { - "smithy.api#documentation": "

The unique identifier for updated Dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "The response from an UpdateDataset operation", - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#UpdatePermissionGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#UpdatePermissionGroupRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#UpdatePermissionGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Modifies the details of a permission group. You cannot modify a permissionGroupID.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/permission-group/{permissionGroupId}", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#UpdatePermissionGroupRequest": { - "type": "structure", - "members": { - "permissionGroupId": { - "target": "com.amazonaws.finspacedata#PermissionGroupId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the permission group to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "name": { - "target": "com.amazonaws.finspacedata#PermissionGroupName", - "traits": { - "smithy.api#documentation": "

The name of the permission group.

" - } - }, - "description": { - "target": "com.amazonaws.finspacedata#PermissionGroupDescription", - "traits": { - "smithy.api#documentation": "

A brief description for the permission group.

" - } - }, - "applicationPermissions": { - "target": "com.amazonaws.finspacedata#ApplicationPermissionList", - "traits": { - "smithy.api#documentation": "

The permissions that are granted to a specific group for accessing the FinSpace application.

\n \n

When assigning application permissions, be aware that the permission ManageUsersAndGroups allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

\n \n " - } - }, - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#UpdatePermissionGroupResponse": { - "type": "structure", - "members": { - "permissionGroupId": { - "target": "com.amazonaws.finspacedata#PermissionGroupId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the updated permission group.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#UpdateUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.finspacedata#UpdateUserRequest" - }, - "output": { - "target": "com.amazonaws.finspacedata#UpdateUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.finspacedata#AccessDeniedException" - }, - { - "target": "com.amazonaws.finspacedata#ConflictException" - }, - { - "target": "com.amazonaws.finspacedata#InternalServerException" - }, - { - "target": "com.amazonaws.finspacedata#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.finspacedata#ThrottlingException" - }, - { - "target": "com.amazonaws.finspacedata#ValidationException" - } - ], - "traits": { - "smithy.api#deprecated": { - "message": "This method will be discontinued." - }, - "smithy.api#documentation": "

Modifies the details of the specified user. You cannot update the userId for a user.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/user/{userId}", - "code": 200 - } - } - }, - "com.amazonaws.finspacedata#UpdateUserRequest": { - "type": "structure", - "members": { - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the user that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "type": { - "target": "com.amazonaws.finspacedata#UserType", - "traits": { - "smithy.api#documentation": "

The option to indicate the type of user.

\n " - } - }, - "firstName": { - "target": "com.amazonaws.finspacedata#FirstName", - "traits": { - "smithy.api#documentation": "

The first name of the user.

" - } - }, - "lastName": { - "target": "com.amazonaws.finspacedata#LastName", - "traits": { - "smithy.api#documentation": "

The last name of the user.

" - } - }, - "apiAccess": { - "target": "com.amazonaws.finspacedata#ApiAccess", - "traits": { - "smithy.api#documentation": "

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.

\n " - } - }, - "apiAccessPrincipalArn": { - "target": "com.amazonaws.finspacedata#RoleArn", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "clientToken": { - "target": "com.amazonaws.finspacedata#ClientToken", - "traits": { - "smithy.api#documentation": "

A token that ensures idempotency. This token expires in 10 minutes.

", - "smithy.api#idempotencyToken": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.finspacedata#UpdateUserResponse": { - "type": "structure", - "members": { - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the updated user.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.finspacedata#User": { - "type": "structure", - "members": { - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the user.

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

The current status of the user.

\n " - } - }, - "firstName": { - "target": "com.amazonaws.finspacedata#FirstName", - "traits": { - "smithy.api#documentation": "

The first name of the user.

" - } - }, - "lastName": { - "target": "com.amazonaws.finspacedata#LastName", - "traits": { - "smithy.api#documentation": "

The last name of the user.

" - } - }, - "emailAddress": { - "target": "com.amazonaws.finspacedata#Email", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "type": { - "target": "com.amazonaws.finspacedata#UserType", - "traits": { - "smithy.api#documentation": "

Indicates the type of user.

\n " - } - }, - "apiAccess": { - "target": "com.amazonaws.finspacedata#ApiAccess", - "traits": { - "smithy.api#documentation": "

Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

\n " - } - }, - "apiAccessPrincipalArn": { - "target": "com.amazonaws.finspacedata#RoleArn", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "createTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.

" - } - }, - "lastEnabledTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Describes the last time the user was activated. The value is determined as epoch time in milliseconds.\n

" - } - }, - "lastDisabledTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.

" - } - }, - "lastModifiedTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Describes the last time the user was updated. The value is determined as epoch time in milliseconds.\n

" - } - }, - "lastLoginTime": { - "target": "com.amazonaws.finspacedata#TimestampEpoch", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.\n

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

The details of the user.

" - } - }, - "com.amazonaws.finspacedata#UserByPermissionGroup": { - "type": "structure", - "members": { - "userId": { - "target": "com.amazonaws.finspacedata#UserId", - "traits": { - "smithy.api#documentation": "

The unique identifier for the user.

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

The current status of the user.

\n " - } - }, - "firstName": { - "target": "com.amazonaws.finspacedata#FirstName", - "traits": { - "smithy.api#documentation": "

The first name of the user.

" - } - }, - "lastName": { - "target": "com.amazonaws.finspacedata#LastName", - "traits": { - "smithy.api#documentation": "

The last name of the user.

" - } - }, - "emailAddress": { - "target": "com.amazonaws.finspacedata#Email", - "traits": { - "smithy.api#documentation": "

The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.

" - } - }, - "type": { - "target": "com.amazonaws.finspacedata#UserType", - "traits": { - "smithy.api#documentation": "

Indicates the type of user.

\n " - } - }, - "apiAccess": { - "target": "com.amazonaws.finspacedata#ApiAccess", - "traits": { - "smithy.api#documentation": "

Indicates whether the user can access FinSpace API operations.

\n " - } - }, - "apiAccessPrincipalArn": { - "target": "com.amazonaws.finspacedata#RoleArn", - "traits": { - "smithy.api#documentation": "

The IAM ARN identifier that is attached to FinSpace API calls.

" - } - }, - "membershipStatus": { - "target": "com.amazonaws.finspacedata#PermissionGroupMembershipStatus", - "traits": { - "smithy.api#documentation": "

Indicates the status of the user within a permission group.

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

The structure of a user associated with a permission group.

" - } - }, - "com.amazonaws.finspacedata#UserByPermissionGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspacedata#UserByPermissionGroup" - } - }, - "com.amazonaws.finspacedata#UserId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 26 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.finspacedata#UserList": { - "type": "list", - "member": { - "target": "com.amazonaws.finspacedata#User" - } - }, - "com.amazonaws.finspacedata#UserStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.finspacedata#UserType": { - "type": "enum", - "members": { - "SUPER_USER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUPER_USER" - } - }, - "APP_USER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "APP_USER" - } - } - } - }, - "com.amazonaws.finspacedata#ValidationException": { - "type": "structure", - "members": { - "message": { - "target": "com.amazonaws.finspacedata#ErrorMessage2" - }, - "reason": { - "target": "com.amazonaws.finspacedata#ErrorMessage2" - } - }, - "traits": { - "smithy.api#documentation": "

The input fails to satisfy the constraints specified by an AWS service.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.finspacedata#locationType": { - "type": "enum", - "members": { - "INGESTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INGESTION" - } - }, - "SAGEMAKER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SAGEMAKER" - } - } - } - }, - "com.amazonaws.finspacedata#stringValueLength1to1024": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.finspacedata#stringValueLength1to63": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 - }, - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.finspacedata#stringValueMaxLength1000": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1000 - } - } - } - } -} \ No newline at end of file From 77eddb743d00e9413f40d595f920347d700ff5b6 Mon Sep 17 00:00:00 2001 From: rchache <105247787+rchache@users.noreply.github.com> Date: Tue, 20 Oct 2026 15:17:18 -0400 Subject: [PATCH 4/5] Update gradle.properties to remove shutdown services --- gradle.properties | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/gradle.properties b/gradle.properties index 0bbecc7cb..b23c4b3e0 100644 --- a/gradle.properties +++ b/gradle.properties @@ -142,8 +142,6 @@ model.emr-containers.version=1.0.8 model.emr-serverless.version=1.0.12 model.entityresolution.version=1.0.10 model.eventbridge.version=1.0.6 -model.finspace.version=1.0.3 -model.finspace-data.version=1.0.3 model.firehose.version=1.0.4 model.fis.version=1.0.3 model.fms.version=1.0.4 @@ -368,7 +366,6 @@ model.textract.version=1.0.5 model.timestream-influxdb.version=1.0.11 model.timestream-query.version=1.0.3 model.timestream-write.version=1.0.3 -model.tnb.version=1.0.3 model.transcribe.version=1.0.11 model.transcribe-streaming.version=1.0.9 model.transfer.version=1.0.16 @@ -444,4 +441,4 @@ model.network-security-manager.version=1.0.0 model.eventbridgev2.version=1.0.0 model.endusermessaging.version=1.0.0 model.lambda-web.version=1.0.4 -model.sagemakertrainingsessionruntime.version=1.0.0 \ No newline at end of file +model.sagemakertrainingsessionruntime.version=1.0.0 From 6ff5afb58cb722e421a0b4dd0012699f772bd1cc Mon Sep 17 00:00:00 2001 From: rchache <105247787+rchache@users.noreply.github.com> Date: Tue, 20 Oct 2026 15:17:18 -0400 Subject: [PATCH 5/5] Update gradle.properties to remove shutdown services