FinSpace User Environment Management service
The FinSpace management service provides the APIs for managing FinSpace environments
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.0",
"info": {
"version": "2021-03-12",
"x-release": "v4",
"title": "FinSpace User Environment Management service",
"description": "The FinSpace management service provides the APIs for managing FinSpace environments.",
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png",
"backgroundColor": "#FFFFFF"
},
"termsOfService": "https://aws.amazon.com/service-terms/",
"contact": {
"name": "Mike Ralphson",
"email": "mike.ralphson@gmail.com",
"url": "https://github.com/mermade/aws2openapi",
"x-twitter": "PermittedSoc"
},
"license": {
"name": "Apache 2.0 License",
"url": "http://www.apache.org/licenses/"
},
"x-providerName": "amazonaws.com",
"x-serviceName": "finspace",
"x-aws-signingName": "finspace",
"x-origin": [
{
"contentType": "application/json",
"url": "https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/finspace-2021-03-12.normal.json",
"converter": {
"url": "https://github.com/mermade/aws2openapi",
"version": "1.0.0"
},
"x-apisguru-driver": "external"
}
],
"x-apiClientRegistration": {
"url": "https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"
},
"x-apisguru-categories": [
"cloud"
],
"x-preferred": true
},
"externalDocs": {
"description": "Amazon Web Services documentation",
"url": "https://docs.aws.amazon.com/finspace/"
},
"servers": [
{
"url": "http://finspace.{region}.amazonaws.com",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
"us-gov-west-1",
"us-gov-east-1",
"ca-central-1",
"eu-north-1",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"eu-central-1",
"eu-south-1",
"af-south-1",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ap-southeast-1",
"ap-southeast-2",
"ap-east-1",
"ap-south-1",
"sa-east-1",
"me-south-1"
],
"default": "us-east-1"
}
},
"description": "The finspace multi-region endpoint"
},
{
"url": "https://finspace.{region}.amazonaws.com",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2",
"us-gov-west-1",
"us-gov-east-1",
"ca-central-1",
"eu-north-1",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"eu-central-1",
"eu-south-1",
"af-south-1",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ap-southeast-1",
"ap-southeast-2",
"ap-east-1",
"ap-south-1",
"sa-east-1",
"me-south-1"
],
"default": "us-east-1"
}
},
"description": "The finspace multi-region endpoint"
},
{
"url": "http://finspace.{region}.amazonaws.com.cn",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"cn-north-1",
"cn-northwest-1"
],
"default": "cn-north-1"
}
},
"description": "The finspace endpoint for China (Beijing) and China (Ningxia)"
},
{
"url": "https://finspace.{region}.amazonaws.com.cn",
"variables": {
"region": {
"description": "The AWS region",
"enum": [
"cn-north-1",
"cn-northwest-1"
],
"default": "cn-north-1"
}
},
"description": "The finspace endpoint for China (Beijing) and China (Ningxia)"
}
],
"x-hasEquivalentPaths": true,
"paths": {
"/environment": {
"post": {
"operationId": "CreateEnvironment",
"description": "Create a new FinSpace environment.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEnvironmentResponse"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "ValidationException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationException"
}
}
}
},
"482": {
"description": "AccessDeniedException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessDeniedException"
}
}
}
},
"483": {
"description": "ThrottlingException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThrottlingException"
}
}
}
},
"484": {
"description": "ServiceQuotaExceededException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceQuotaExceededException"
}
}
}
},
"485": {
"description": "LimitExceededException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LimitExceededException"
}
}
}
}
},
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"description": "The name of the FinSpace environment to be created.",
"type": "string",
"pattern": "^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]$",
"minLength": 1,
"maxLength": 255
},
"description": {
"description": "The description of the FinSpace environment to be created.",
"type": "string",
"pattern": "^[a-zA-Z0-9. ]{1,1000}$",
"minLength": 1,
"maxLength": 1000
},
"kmsKeyId": {
"description": "The KMS key id to encrypt your data in the FinSpace environment.",
"type": "string",
"pattern": "^[a-zA-Z-0-9-:\\/]*$",
"minLength": 1,
"maxLength": 1000
},
"tags": {
"description": "Add tags to your FinSpace environment.",
"type": "object",
"minProperties": 1,
"maxProperties": 50,
"additionalProperties": {
"$ref": "#/components/schemas/TagValue"
}
},
"federationMode": {
"description": "<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>",
"type": "string",
"enum": [
"FEDERATED",
"LOCAL"
]
},
"federationParameters": {
"description": "Configuration information when authentication mode is FEDERATED.",
"type": "object",
"properties": {
"samlMetadataDocument": {
"allOf": [
{
"$ref": "#/components/schemas/SamlMetadataDocument"
},
{
"description": "SAML 2.0 Metadata document from identity provider (IdP)."
}
]
},
"samlMetadataURL": {
"allOf": [
{
"$ref": "#/components/schemas/url"
},
{
"description": "Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP)."
}
]
},
"applicationCallBackURL": {
"allOf": [
{
"$ref": "#/components/schemas/url"
},
{
"description": "The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP)."
}
]
},
"federationURN": {
"allOf": [
{
"$ref": "#/components/schemas/urn"
},
{
"description": "The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID."
}
]
},
"federationProviderName": {
"allOf": [
{
"$ref": "#/components/schemas/FederationProviderName"
},
{
"description": "Name of the identity provider (IdP)."
}
]
},
"attributeMap": {
"allOf": [
{
"$ref": "#/components/schemas/AttributeMap"
},
{
"description": "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."
}
]
}
}
},
"superuserParameters": {
"description": "Configuration information for the superuser.",
"type": "object",
"properties": {
"emailAddress": {
"allOf": [
{
"$ref": "#/components/schemas/EmailId"
},
{
"description": "The email address of the superuser."
}
]
},
"firstName": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "The first name of the superuser."
}
]
},
"lastName": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "The last name of the superuser."
}
]
}
}
},
"dataBundles": {
"description": "<p>The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:</p> <ul> <li> <p> <code>arn:aws:finspace:${Region}::data-bundle/capital-markets-sample</code> - Contains sample Capital Markets datasets, categories and controlled vocabularies.</p> </li> <li> <p> <code>arn:aws:finspace:${Region}::data-bundle/taq</code> (default) - Contains trades and quotes data in addition to sample Capital Markets data.</p> </li> </ul>",
"type": "array",
"items": {
"$ref": "#/components/schemas/DataBundleArn"
}
}
}
}
}
}
}
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
],
"get": {
"operationId": "ListEnvironments",
"description": "A list of all of your FinSpace environments.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListEnvironmentsResponse"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "ValidationException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationException"
}
}
}
}
},
"parameters": [
{
"name": "nextToken",
"in": "query",
"required": false,
"description": "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.",
"schema": {
"type": "string",
"pattern": ".*",
"minLength": 1,
"maxLength": 1000
}
},
{
"name": "maxResults",
"in": "query",
"required": false,
"description": "The maximum number of results to return in this request.",
"schema": {
"type": "integer",
"minimum": 0,
"maximum": 100
}
}
]
}
},
"/environment/{environmentId}": {
"delete": {
"operationId": "DeleteEnvironment",
"description": "Delete an FinSpace environment.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteEnvironmentResponse"
}
}
}
},
"480": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
},
"481": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"482": {
"description": "AccessDeniedException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessDeniedException"
}
}
}
},
"483": {
"description": "ThrottlingException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThrottlingException"
}
}
}
},
"484": {
"description": "ValidationException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationException"
}
}
}
}
},
"parameters": [
{
"name": "environmentId",
"in": "path",
"required": true,
"description": "The identifier for the FinSpace environment.",
"schema": {
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,26}$",
"minLength": 1,
"maxLength": 26
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
],
"get": {
"operationId": "GetEnvironment",
"description": "Returns the FinSpace environment object.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetEnvironmentResponse"
}
}
}
},
"480": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
},
"481": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"482": {
"description": "ValidationException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationException"
}
}
}
},
"483": {
"description": "AccessDeniedException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessDeniedException"
}
}
}
}
},
"parameters": [
{
"name": "environmentId",
"in": "path",
"required": true,
"description": "The identifier of the FinSpace environment.",
"schema": {
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,26}$",
"minLength": 1,
"maxLength": 26
}
}
]
},
"put": {
"operationId": "UpdateEnvironment",
"description": "Update your FinSpace environment.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEnvironmentResponse"
}
}
}
},
"480": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
},
"481": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"482": {
"description": "AccessDeniedException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessDeniedException"
}
}
}
},
"483": {
"description": "ThrottlingException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThrottlingException"
}
}
}
},
"484": {
"description": "ValidationException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValidationException"
}
}
}
}
},
"parameters": [
{
"name": "environmentId",
"in": "path",
"required": true,
"description": "The identifier of the FinSpace environment.",
"schema": {
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,26}$",
"minLength": 1,
"maxLength": 26
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"description": "The name of the environment.",
"type": "string",
"pattern": "^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]$",
"minLength": 1,
"maxLength": 255
},
"description": {
"description": "The description of the environment.",
"type": "string",
"pattern": "^[a-zA-Z0-9. ]{1,1000}$",
"minLength": 1,
"maxLength": 1000
},
"federationMode": {
"description": "<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>",
"type": "string",
"enum": [
"FEDERATED",
"LOCAL"
]
},
"federationParameters": {
"description": "Configuration information when authentication mode is FEDERATED.",
"type": "object",
"properties": {
"samlMetadataDocument": {
"allOf": [
{
"$ref": "#/components/schemas/SamlMetadataDocument"
},
{
"description": "SAML 2.0 Metadata document from identity provider (IdP)."
}
]
},
"samlMetadataURL": {
"allOf": [
{
"$ref": "#/components/schemas/url"
},
{
"description": "Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP)."
}
]
},
"applicationCallBackURL": {
"allOf": [
{
"$ref": "#/components/schemas/url"
},
{
"description": "The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP)."
}
]
},
"federationURN": {
"allOf": [
{
"$ref": "#/components/schemas/urn"
},
{
"description": "The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID."
}
]
},
"federationProviderName": {
"allOf": [
{
"$ref": "#/components/schemas/FederationProviderName"
},
{
"description": "Name of the identity provider (IdP)."
}
]
},
"attributeMap": {
"allOf": [
{
"$ref": "#/components/schemas/AttributeMap"
},
{
"description": "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."
}
]
}
}
}
}
}
}
}
}
}
},
"/tags/{resourceArn}": {
"get": {
"operationId": "ListTagsForResource",
"description": "A list of all tags for a resource.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListTagsForResourceResponse"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
}
},
"parameters": [
{
"name": "resourceArn",
"in": "path",
"required": true,
"description": "The Amazon Resource Name of the resource.",
"schema": {
"type": "string",
"pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:environment/[0-9A-Za-z_-]{1,128}$",
"minLength": 20,
"maxLength": 2048
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
],
"post": {
"operationId": "TagResource",
"description": "Adds metadata tags to a FinSpace resource.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TagResourceResponse"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
}
},
"parameters": [
{
"name": "resourceArn",
"in": "path",
"required": true,
"description": "The Amazon Resource Name (ARN) for the resource.",
"schema": {
"type": "string",
"pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:environment/[0-9A-Za-z_-]{1,128}$",
"minLength": 20,
"maxLength": 2048
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"tags"
],
"properties": {
"tags": {
"description": "One or more tags to be assigned to the resource.",
"type": "object",
"minProperties": 1,
"maxProperties": 50,
"additionalProperties": {
"$ref": "#/components/schemas/TagValue"
}
}
}
}
}
}
}
}
},
"/tags/{resourceArn}#tagKeys": {
"delete": {
"operationId": "UntagResource",
"description": "Removes metadata tags from a FinSpace resource.",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UntagResourceResponse"
}
}
}
},
"480": {
"description": "InternalServerException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerException"
}
}
}
},
"481": {
"description": "InvalidRequestException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidRequestException"
}
}
}
},
"482": {
"description": "ResourceNotFoundException",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceNotFoundException"
}
}
}
}
},
"parameters": [
{
"name": "resourceArn",
"in": "path",
"required": true,
"description": "A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).",
"schema": {
"type": "string",
"pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:environment/[0-9A-Za-z_-]{1,128}$",
"minLength": 20,
"maxLength": 2048
}
},
{
"name": "tagKeys",
"in": "query",
"required": true,
"description": "The tag keys (names) of one or more tags to be removed.",
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagKey"
},
"minItems": 1,
"maxItems": 50
}
}
]
},
"parameters": [
{
"$ref": "#/components/parameters/X-Amz-Content-Sha256"
},
{
"$ref": "#/components/parameters/X-Amz-Date"
},
{
"$ref": "#/components/parameters/X-Amz-Algorithm"
},
{
"$ref": "#/components/parameters/X-Amz-Credential"
},
{
"$ref": "#/components/parameters/X-Amz-Security-Token"
},
{
"$ref": "#/components/parameters/X-Amz-Signature"
},
{
"$ref": "#/components/parameters/X-Amz-SignedHeaders"
}
]
}
},
"components": {
"parameters": {
"X-Amz-Content-Sha256": {
"name": "X-Amz-Content-Sha256",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Date": {
"name": "X-Amz-Date",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Algorithm": {
"name": "X-Amz-Algorithm",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Credential": {
"name": "X-Amz-Credential",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Security-Token": {
"name": "X-Amz-Security-Token",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-Signature": {
"name": "X-Amz-Signature",
"in": "header",
"schema": {
"type": "string"
},
"required": false
},
"X-Amz-SignedHeaders": {
"name": "X-Amz-SignedHeaders",
"in": "header",
"schema": {
"type": "string"
},
"required": false
}
},
"securitySchemes": {
"hmac": {
"type": "apiKey",
"name": "Authorization",
"in": "header",
"description": "Amazon Signature authorization v4",
"x-amazon-apigateway-authtype": "awsSigv4"
}
},
"schemas": {
"CreateEnvironmentResponse": {
"type": "object",
"properties": {
"environmentId": {
"allOf": [
{
"$ref": "#/components/schemas/IdType"
},
{
"description": "The unique identifier for FinSpace environment that you created."
}
]
},
"environmentArn": {
"allOf": [
{
"$ref": "#/components/schemas/EnvironmentArn"
},
{
"description": "The Amazon Resource Name (ARN) of the FinSpace environment that you created."
}
]
},
"environmentUrl": {
"allOf": [
{
"$ref": "#/components/schemas/url"
},
{
"description": "The sign-in url for the web application of the FinSpace environment you created."
}
]
}
}
},
"TagValue": {
"type": "string",
"pattern": "^[a-zA-Z0-9+-=._:@ ]+$",
"minLength": 1,
"maxLength": 256
},
"SamlMetadataDocument": {
"type": "string",
"pattern": ".*",
"minLength": 1000,
"maxLength": 10000000
},
"url": {
"type": "string",
"pattern": "^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]",
"minLength": 1,
"maxLength": 1000
},
"urn": {
"type": "string",
"pattern": "^[A-Za-z0-9._\\-:\\/#\\+]+$",
"minLength": 1,
"maxLength": 255
},
"FederationProviderName": {
"type": "string",
"pattern": "[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+",
"minLength": 1,
"maxLength": 32
},
"AttributeMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/url"
}
},
"EmailId": {
"type": "string",
"pattern": "[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+[.]+[A-Za-z]+",
"minLength": 1,
"maxLength": 128,
"format": "password"
},
"NameString": {
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,50}$",
"minLength": 1,
"maxLength": 50
},
"DataBundleArn": {
"type": "string",
"pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d*:data-bundle/[0-9A-Za-z_-]{1,128}$",
"description": "The Amazon Resource Name (ARN) of the data bundle.",
"minLength": 20,
"maxLength": 2048
},
"InternalServerException": {},
"ValidationException": {},
"AccessDeniedException": {},
"ThrottlingException": {},
"ServiceQuotaExceededException": {},
"LimitExceededException": {},
"DeleteEnvironmentResponse": {
"type": "object",
"properties": {}
},
"ResourceNotFoundException": {},
"GetEnvironmentResponse": {
"type": "object",
"properties": {
"environment": {
"allOf": [
{
"$ref": "#/components/schemas/Environment"
},
{
"description": "The name of the FinSpace environment."
}
]
}
}
},
"ListEnvironmentsResponse": {
"type": "object",
"properties": {
"environments": {
"allOf": [
{
"$ref": "#/components/schemas/EnvironmentList"
},
{
"description": "A list of all of your FinSpace environments."
}
]
},
"nextToken": {
"allOf": [
{
"$ref": "#/components/schemas/PaginationToken"
},
{
"description": "A token that you can use in a subsequent call to retrieve the next set of results."
}
]
}
}
},
"ListTagsForResourceResponse": {
"type": "object",
"properties": {
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/TagMap"
},
{
"description": "A list of all tags for a resource."
}
]
}
}
},
"InvalidRequestException": {},
"TagResourceResponse": {
"type": "object",
"properties": {}
},
"UntagResourceResponse": {
"type": "object",
"properties": {}
},
"TagKey": {
"type": "string",
"pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$",
"minLength": 1,
"maxLength": 128
},
"UpdateEnvironmentResponse": {
"type": "object",
"properties": {
"environment": {
"allOf": [
{
"$ref": "#/components/schemas/Environment"
},
{
"description": "Returns the FinSpace environment object."
}
]
}
}
},
"EnvironmentName": {
"type": "string",
"pattern": "^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]$",
"minLength": 1,
"maxLength": 255
},
"Description": {
"type": "string",
"pattern": "^[a-zA-Z0-9. ]{1,1000}$",
"minLength": 1,
"maxLength": 1000
},
"KmsKeyId": {
"type": "string",
"pattern": "^[a-zA-Z-0-9-:\\/]*$",
"minLength": 1,
"maxLength": 1000
},
"TagMap": {
"type": "object",
"minProperties": 1,
"maxProperties": 50,
"additionalProperties": {
"$ref": "#/components/schemas/TagValue"
}
},
"FederationMode": {
"type": "string",
"enum": [
"FEDERATED",
"LOCAL"
]
},
"FederationParameters": {
"type": "object",
"properties": {
"samlMetadataDocument": {
"allOf": [
{
"$ref": "#/components/schemas/SamlMetadataDocument"
},
{
"description": "SAML 2.0 Metadata document from identity provider (IdP)."
}
]
},
"samlMetadataURL": {
"allOf": [
{
"$ref": "#/components/schemas/url"
},
{
"description": "Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP)."
}
]
},
"applicationCallBackURL": {
"allOf": [
{
"$ref": "#/components/schemas/url"
},
{
"description": "The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP)."
}
]
},
"federationURN": {
"allOf": [
{
"$ref": "#/components/schemas/urn"
},
{
"description": "The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID."
}
]
},
"federationProviderName": {
"allOf": [
{
"$ref": "#/components/schemas/FederationProviderName"
},
{
"description": "Name of the identity provider (IdP)."
}
]
},
"attributeMap": {
"allOf": [
{
"$ref": "#/components/schemas/AttributeMap"
},
{
"description": "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."
}
]
}
},
"description": "Configuration information when authentication mode is FEDERATED."
},
"SuperuserParameters": {
"type": "object",
"required": [
"emailAddress",
"firstName",
"lastName"
],
"properties": {
"emailAddress": {
"allOf": [
{
"$ref": "#/components/schemas/EmailId"
},
{
"description": "The email address of the superuser."
}
]
},
"firstName": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "The first name of the superuser."
}
]
},
"lastName": {
"allOf": [
{
"$ref": "#/components/schemas/NameString"
},
{
"description": "The last name of the superuser."
}
]
}
},
"description": "Configuration information for the superuser."
},
"DataBundleArns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataBundleArn"
}
},
"CreateEnvironmentRequest": {
"type": "object",
"required": [
"name"
],
"title": "CreateEnvironmentRequest",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/EnvironmentName"
},
{
"description": "The name of the FinSpace environment to be created."
}
]
},
"description": {
"allOf": [
{
"$ref": "#/components/schemas/Description"
},
{
"description": "The description of the FinSpace environment to be created."
}
]
},
"kmsKeyId": {
"allOf": [
{
"$ref": "#/components/schemas/KmsKeyId"
},
{
"description": "The KMS key id to encrypt your data in the FinSpace environment."
}
]
},
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/TagMap"
},
{
"description": "Add tags to your FinSpace environment."
}
]
},
"federationMode": {
"allOf": [
{
"$ref": "#/components/schemas/FederationMode"
},
{
"description": "<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>"
}
]
},
"federationParameters": {
"allOf": [
{
"$ref": "#/components/schemas/FederationParameters"
},
{
"description": "Configuration information when authentication mode is FEDERATED."
}
]
},
"superuserParameters": {
"allOf": [
{
"$ref": "#/components/schemas/SuperuserParameters"
},
{
"description": "Configuration information for the superuser."
}
]
},
"dataBundles": {
"allOf": [
{
"$ref": "#/components/schemas/DataBundleArns"
},
{
"description": "<p>The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:</p> <ul> <li> <p> <code>arn:aws:finspace:${Region}::data-bundle/capital-markets-sample</code> - Contains sample Capital Markets datasets, categories and controlled vocabularies.</p> </li> <li> <p> <code>arn:aws:finspace:${Region}::data-bundle/taq</code> (default) - Contains trades and quotes data in addition to sample Capital Markets data.</p> </li> </ul>"
}
]
}
}
},
"IdType": {
"type": "string",
"pattern": "^[a-zA-Z0-9]{1,26}$",
"minLength": 1,
"maxLength": 26
},
"EnvironmentArn": {
"type": "string",
"pattern": "^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:environment/[0-9A-Za-z_-]{1,128}$",
"minLength": 20,
"maxLength": 2048
},
"DeleteEnvironmentRequest": {
"type": "object",
"title": "DeleteEnvironmentRequest",
"properties": {}
},
"EnvironmentStatus": {
"type": "string",
"enum": [
"CREATE_REQUESTED",
"CREATING",
"CREATED",
"DELETE_REQUESTED",
"DELETING",
"DELETED",
"FAILED_CREATION",
"RETRY_DELETION",
"FAILED_DELETION",
"SUSPENDED"
]
},
"SmsDomainUrl": {
"type": "string",
"pattern": "^[a-zA-Z-0-9-:\\/.]*$",
"minLength": 1,
"maxLength": 1000
},
"Environment": {
"type": "object",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/EnvironmentName"
},
{
"description": "The name of the FinSpace environment."
}
]
},
"environmentId": {
"allOf": [
{
"$ref": "#/components/schemas/IdType"
},
{
"description": "The identifier of the FinSpace environment."
}
]
},
"awsAccountId": {
"allOf": [
{
"$ref": "#/components/schemas/IdType"
},
{
"description": "The ID of the AWS account in which the FinSpace environment is created."
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/EnvironmentStatus"
},
{
"description": "The current status of creation of the FinSpace environment."
}
]
},
"environmentUrl": {
"allOf": [
{
"$ref": "#/components/schemas/url"
},
{
"description": "The sign-in url for the web application of your FinSpace environment."
}
]
},
"description": {
"allOf": [
{
"$ref": "#/components/schemas/Description"
},
{
"description": "The description of the FinSpace environment."
}
]
},
"environmentArn": {
"allOf": [
{
"$ref": "#/components/schemas/EnvironmentArn"
},
{
"description": "The Amazon Resource Name (ARN) of your FinSpace environment."
}
]
},
"sageMakerStudioDomainUrl": {
"allOf": [
{
"$ref": "#/components/schemas/SmsDomainUrl"
},
{
"description": "The url of the integrated FinSpace notebook environment in your web application."
}
]
},
"kmsKeyId": {
"allOf": [
{
"$ref": "#/components/schemas/KmsKeyId"
},
{
"description": "The KMS key id used to encrypt in the FinSpace environment."
}
]
},
"dedicatedServiceAccountId": {
"allOf": [
{
"$ref": "#/components/schemas/IdType"
},
{
"description": "The AWS account ID of the dedicated service account associated with your FinSpace environment."
}
]
},
"federationMode": {
"allOf": [
{
"$ref": "#/components/schemas/FederationMode"
},
{
"description": "The authentication mode for the environment."
}
]
},
"federationParameters": {
"allOf": [
{
"$ref": "#/components/schemas/FederationParameters"
},
{
"description": "Configuration information when authentication mode is FEDERATED."
}
]
}
},
"description": "Represents an FinSpace environment."
},
"EnvironmentList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Environment"
}
},
"FederationAttributeKey": {
"type": "string",
"pattern": ".*",
"minLength": 1,
"maxLength": 32
},
"GetEnvironmentRequest": {
"type": "object",
"title": "GetEnvironmentRequest",
"properties": {}
},
"PaginationToken": {
"type": "string",
"pattern": ".*",
"minLength": 1,
"maxLength": 1000
},
"ResultLimit": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"ListEnvironmentsRequest": {
"type": "object",
"title": "ListEnvironmentsRequest",
"properties": {}
},
"ListTagsForResourceRequest": {
"type": "object",
"title": "ListTagsForResourceRequest",
"properties": {}
},
"TagKeyList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TagKey"
},
"minItems": 1,
"maxItems": 50
},
"TagResourceRequest": {
"type": "object",
"required": [
"tags"
],
"title": "TagResourceRequest",
"properties": {
"tags": {
"allOf": [
{
"$ref": "#/components/schemas/TagMap"
},
{
"description": "One or more tags to be assigned to the resource."
}
]
}
}
},
"UntagResourceRequest": {
"type": "object",
"title": "UntagResourceRequest",
"properties": {}
},
"UpdateEnvironmentRequest": {
"type": "object",
"title": "UpdateEnvironmentRequest",
"properties": {
"name": {
"allOf": [
{
"$ref": "#/components/schemas/EnvironmentName"
},
{
"description": "The name of the environment."
}
]
},
"description": {
"allOf": [
{
"$ref": "#/components/schemas/Description"
},
{
"description": "The description of the environment."
}
]
},
"federationMode": {
"allOf": [
{
"$ref": "#/components/schemas/FederationMode"
},
{
"description": "<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>"
}
]
},
"federationParameters": {
"$ref": "#/components/schemas/FederationParameters"
}
}
}
}
},
"security": [
{
"hmac": []
}
]
}