github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/finspace/2021-03-12/docs-2.json (about) 1 { 2 "version": "2.0", 3 "service": "<p>The FinSpace management service provides the APIs for managing the FinSpace environments. </p>", 4 "operations": { 5 "CreateEnvironment": "<p>Create a new FinSpace environment.</p>", 6 "DeleteEnvironment": "<p>Delete an FinSpace environment.</p>", 7 "GetEnvironment": "<p>Returns the FinSpace environment object.</p>", 8 "ListEnvironments": "<p>A list of all of your FinSpace environments.</p>", 9 "ListTagsForResource": "<p>A list of all tags for a resource.</p>", 10 "TagResource": "<p>Adds metadata tags to a FinSpace resource.</p>", 11 "UntagResource": "<p>Removes metadata tags from a FinSpace resource.</p>", 12 "UpdateEnvironment": "<p>Update your FinSpace environment.</p>" 13 }, 14 "shapes": { 15 "AccessDeniedException": { 16 "base": "<p>You do not have sufficient access to perform this action.</p>", 17 "refs": { 18 } 19 }, 20 "AttributeMap": { 21 "base": null, 22 "refs": { 23 "FederationParameters$attributeMap": "<p>SAML attribute name and value. The name must always be <code>Email</code> and the value should be set to the attribute definition in which user email is set. For example, name would be <code>Email</code> and value <code>http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress</code>. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.</p>" 24 } 25 }, 26 "CreateEnvironmentRequest": { 27 "base": null, 28 "refs": { 29 } 30 }, 31 "CreateEnvironmentResponse": { 32 "base": null, 33 "refs": { 34 } 35 }, 36 "DeleteEnvironmentRequest": { 37 "base": null, 38 "refs": { 39 } 40 }, 41 "DeleteEnvironmentResponse": { 42 "base": null, 43 "refs": { 44 } 45 }, 46 "Description": { 47 "base": null, 48 "refs": { 49 "CreateEnvironmentRequest$description": "<p>The description of the FinSpace environment to be created.</p>", 50 "Environment$description": "<p>The description of the FinSpace environment.</p>", 51 "UpdateEnvironmentRequest$description": "<p>The description of the environment.</p>" 52 } 53 }, 54 "Environment": { 55 "base": "<p>Represents an FinSpace environment.</p>", 56 "refs": { 57 "EnvironmentList$member": null, 58 "GetEnvironmentResponse$environment": "<p>The name of the FinSpace environment.</p>", 59 "UpdateEnvironmentResponse$environment": "<p>Returns the FinSpace environment object.</p>" 60 } 61 }, 62 "EnvironmentArn": { 63 "base": null, 64 "refs": { 65 "CreateEnvironmentResponse$environmentArn": "<p>The Amazon Resource Name (ARN) of the FinSpace environment that you created.</p>", 66 "Environment$environmentArn": "<p>The Amazon Resource Name (ARN) of your FinSpace environment.</p>", 67 "ListTagsForResourceRequest$resourceArn": "<p>The Amazon Resource Name of the resource.</p>", 68 "TagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) for the resource.</p>", 69 "UntagResourceRequest$resourceArn": "<p>A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).</p>" 70 } 71 }, 72 "EnvironmentList": { 73 "base": null, 74 "refs": { 75 "ListEnvironmentsResponse$environments": "<p>A list of all of your FinSpace environments.</p>" 76 } 77 }, 78 "EnvironmentName": { 79 "base": null, 80 "refs": { 81 "CreateEnvironmentRequest$name": "<p>The name of the FinSpace environment to be created.</p>", 82 "Environment$name": "<p>The name of the FinSpace environment.</p>", 83 "UpdateEnvironmentRequest$name": "<p>The name of the environment.</p>" 84 } 85 }, 86 "EnvironmentStatus": { 87 "base": null, 88 "refs": { 89 "Environment$status": "<p>The current status of creation of the FinSpace environment.</p>" 90 } 91 }, 92 "FederationAttributeKey": { 93 "base": null, 94 "refs": { 95 "AttributeMap$key": null 96 } 97 }, 98 "FederationMode": { 99 "base": null, 100 "refs": { 101 "CreateEnvironmentRequest$federationMode": "<p>Authentication mode for the environment.</p> <ul> <li> <p> <code>FEDERATED</code> - Users access FinSpace through Single Sign On (SSO) via your Identity provider.</p> </li> <li> <p> <code>LOCAL</code> - Users access FinSpace via email and password managed within the FinSpace environment.</p> </li> </ul>", 102 "Environment$federationMode": "<p>The authentication mode for the environment.</p>", 103 "UpdateEnvironmentRequest$federationMode": "<p>Authentication mode for the environment.</p> <ul> <li> <p> <code>FEDERATED</code> - Users access FinSpace through Single Sign On (SSO) via your Identity provider.</p> </li> <li> <p> <code>LOCAL</code> - Users access FinSpace via email and password managed within the FinSpace environment.</p> </li> </ul>" 104 } 105 }, 106 "FederationParameters": { 107 "base": "<p>Configuration information when authentication mode is FEDERATED.</p>", 108 "refs": { 109 "CreateEnvironmentRequest$federationParameters": "<p>Configuration information when authentication mode is FEDERATED.</p>", 110 "Environment$federationParameters": "<p>Configuration information when authentication mode is FEDERATED.</p>", 111 "UpdateEnvironmentRequest$federationParameters": null 112 } 113 }, 114 "FederationProviderName": { 115 "base": null, 116 "refs": { 117 "FederationParameters$federationProviderName": "<p>Name of the identity provider (IdP).</p>" 118 } 119 }, 120 "GetEnvironmentRequest": { 121 "base": null, 122 "refs": { 123 } 124 }, 125 "GetEnvironmentResponse": { 126 "base": null, 127 "refs": { 128 } 129 }, 130 "IdType": { 131 "base": null, 132 "refs": { 133 "CreateEnvironmentResponse$environmentId": "<p>The unique identifier for FinSpace environment that you created.</p>", 134 "DeleteEnvironmentRequest$environmentId": "<p>The identifier for the FinSpace environment.</p>", 135 "Environment$environmentId": "<p>The identifier of the FinSpace environment.</p>", 136 "Environment$awsAccountId": "<p>The ID of the AWS account in which the FinSpace environment is created.</p>", 137 "Environment$dedicatedServiceAccountId": "<p>The AWS account ID of the dedicated service account associated with your FinSpace environment.</p>", 138 "GetEnvironmentRequest$environmentId": "<p>The identifier of the FinSpace environment.</p>", 139 "UpdateEnvironmentRequest$environmentId": "<p>The identifier of the FinSpace environment.</p>" 140 } 141 }, 142 "InternalServerException": { 143 "base": "<p>The request processing has failed because of an unknown error, exception or failure.</p>", 144 "refs": { 145 } 146 }, 147 "InvalidRequestException": { 148 "base": "<p>The request is invalid. Something is wrong with the input to the request.</p>", 149 "refs": { 150 } 151 }, 152 "KmsKeyId": { 153 "base": null, 154 "refs": { 155 "CreateEnvironmentRequest$kmsKeyId": "<p>The KMS key id to encrypt your data in the FinSpace environment.</p>", 156 "Environment$kmsKeyId": "<p>The KMS key id used to encrypt in the FinSpace environment.</p>" 157 } 158 }, 159 "LimitExceededException": { 160 "base": "<p>A service limit or quota is exceeded.</p>", 161 "refs": { 162 } 163 }, 164 "ListEnvironmentsRequest": { 165 "base": null, 166 "refs": { 167 } 168 }, 169 "ListEnvironmentsResponse": { 170 "base": null, 171 "refs": { 172 } 173 }, 174 "ListTagsForResourceRequest": { 175 "base": null, 176 "refs": { 177 } 178 }, 179 "ListTagsForResourceResponse": { 180 "base": null, 181 "refs": { 182 } 183 }, 184 "PaginationToken": { 185 "base": null, 186 "refs": { 187 "ListEnvironmentsRequest$nextToken": "<p>A token generated by FinSpace that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the nextToken value from the response object of the previous page call.</p>", 188 "ListEnvironmentsResponse$nextToken": "<p>A token that you can use in a subsequent call to retrieve the next set of results.</p>" 189 } 190 }, 191 "ResourceNotFoundException": { 192 "base": "<p>One or more resources can't be found.</p>", 193 "refs": { 194 } 195 }, 196 "ResultLimit": { 197 "base": null, 198 "refs": { 199 "ListEnvironmentsRequest$maxResults": "<p>The maximum number of results to return in this request.</p>" 200 } 201 }, 202 "SamlMetadataDocument": { 203 "base": null, 204 "refs": { 205 "FederationParameters$samlMetadataDocument": "<p>SAML 2.0 Metadata document from identity provider (IdP).</p>" 206 } 207 }, 208 "ServiceQuotaExceededException": { 209 "base": "<p> You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.</p>", 210 "refs": { 211 } 212 }, 213 "SmsDomainUrl": { 214 "base": null, 215 "refs": { 216 "Environment$sageMakerStudioDomainUrl": "<p>The url of the integrated FinSpace notebook environment in your web application.</p>" 217 } 218 }, 219 "TagKey": { 220 "base": null, 221 "refs": { 222 "TagKeyList$member": null, 223 "TagMap$key": null 224 } 225 }, 226 "TagKeyList": { 227 "base": null, 228 "refs": { 229 "UntagResourceRequest$tagKeys": "<p>The tag keys (names) of one or more tags to be removed.</p>" 230 } 231 }, 232 "TagMap": { 233 "base": null, 234 "refs": { 235 "CreateEnvironmentRequest$tags": "<p>Add tags to your FinSpace environment.</p>", 236 "ListTagsForResourceResponse$tags": "<p>A list of all tags for a resource.</p>", 237 "TagResourceRequest$tags": "<p>One or more tags to be assigned to the resource.</p>" 238 } 239 }, 240 "TagResourceRequest": { 241 "base": null, 242 "refs": { 243 } 244 }, 245 "TagResourceResponse": { 246 "base": null, 247 "refs": { 248 } 249 }, 250 "TagValue": { 251 "base": null, 252 "refs": { 253 "TagMap$value": null 254 } 255 }, 256 "ThrottlingException": { 257 "base": "<p>The request was denied due to request throttling.</p>", 258 "refs": { 259 } 260 }, 261 "UntagResourceRequest": { 262 "base": null, 263 "refs": { 264 } 265 }, 266 "UntagResourceResponse": { 267 "base": null, 268 "refs": { 269 } 270 }, 271 "UpdateEnvironmentRequest": { 272 "base": null, 273 "refs": { 274 } 275 }, 276 "UpdateEnvironmentResponse": { 277 "base": null, 278 "refs": { 279 } 280 }, 281 "ValidationException": { 282 "base": "<p>The input fails to satisfy the constraints specified by an AWS service.</p>", 283 "refs": { 284 } 285 }, 286 "errorMessage": { 287 "base": null, 288 "refs": { 289 "InternalServerException$message": null, 290 "InvalidRequestException$message": null, 291 "LimitExceededException$message": null, 292 "ResourceNotFoundException$message": null, 293 "ServiceQuotaExceededException$message": null, 294 "ValidationException$message": null 295 } 296 }, 297 "url": { 298 "base": null, 299 "refs": { 300 "AttributeMap$value": null, 301 "CreateEnvironmentResponse$environmentUrl": "<p>The sign-in url for the web application of the FinSpace environment you created.</p>", 302 "Environment$environmentUrl": "<p>The sign-in url for the web application of your FinSpace environment.</p>", 303 "FederationParameters$samlMetadataURL": "<p>Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).</p>", 304 "FederationParameters$applicationCallBackURL": "<p>The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).</p>" 305 } 306 }, 307 "urn": { 308 "base": null, 309 "refs": { 310 "FederationParameters$federationURN": "<p>The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.</p>" 311 } 312 } 313 } 314 }