TripleDNN

Current Directory: /usr/lib/fence-agents/bundled/botocore/data/finspace/2021-03-12

File Name	Size	Actions
paginators-1.json	23 bytes	Edit \| Delete \| Rename \| Download
service-2.json	23091 bytes	Edit \| Delete \| Rename \| Download

{
 "version":"2.0",
 "metadata":{
 "apiVersion":"2021-03-12",
 "endpointPrefix":"finspace",
 "jsonVersion":"1.1",
 "protocol":"rest-json",
 "serviceAbbreviation":"finspace",
 "serviceFullName":"FinSpace User Environment Management service",
 "serviceId":"finspace",
 "signatureVersion":"v4",
 "signingName":"finspace",
 "uid":"finspace-2021-03-12"
 },
 "operations":{
 "CreateEnvironment":{
 "name":"CreateEnvironment",
 "http":{
 "method":"POST",
 "requestUri":"/environment"
 },
 "input":{"shape":"CreateEnvironmentRequest"},
 "output":{"shape":"CreateEnvironmentResponse"},
 "errors":[
 {"shape":"InternalServerException"},
 {"shape":"ValidationException"},
 {"shape":"AccessDeniedException"},
 {"shape":"ThrottlingException"},
 {"shape":"ServiceQuotaExceededException"},
 {"shape":"LimitExceededException"}
 ],
 "documentation":"Create a new FinSpace environment."
 },
 "DeleteEnvironment":{
 "name":"DeleteEnvironment",
 "http":{
 "method":"DELETE",
 "requestUri":"/environment/{environmentId}"
 },
 "input":{"shape":"DeleteEnvironmentRequest"},
 "output":{"shape":"DeleteEnvironmentResponse"},
 "errors":[
 {"shape":"ResourceNotFoundException"},
 {"shape":"InternalServerException"},
 {"shape":"AccessDeniedException"},
 {"shape":"ThrottlingException"},
 {"shape":"ValidationException"}
 ],
 "documentation":"Delete an FinSpace environment."
 },
 "GetEnvironment":{
 "name":"GetEnvironment",
 "http":{
 "method":"GET",
 "requestUri":"/environment/{environmentId}"
 },
 "input":{"shape":"GetEnvironmentRequest"},
 "output":{"shape":"GetEnvironmentResponse"},
 "errors":[
 {"shape":"ResourceNotFoundException"},
 {"shape":"InternalServerException"},
 {"shape":"ValidationException"},
 {"shape":"AccessDeniedException"}
 ],
 "documentation":"Returns the FinSpace environment object."
 },
 "ListEnvironments":{
 "name":"ListEnvironments",
 "http":{
 "method":"GET",
 "requestUri":"/environment"
 },
 "input":{"shape":"ListEnvironmentsRequest"},
 "output":{"shape":"ListEnvironmentsResponse"},
 "errors":[
 {"shape":"InternalServerException"},
 {"shape":"ValidationException"}
 ],
 "documentation":"A list of all of your FinSpace environments."
 },
 "ListTagsForResource":{
 "name":"ListTagsForResource",
 "http":{
 "method":"GET",
 "requestUri":"/tags/{resourceArn}"
 },
 "input":{"shape":"ListTagsForResourceRequest"},
 "output":{"shape":"ListTagsForResourceResponse"},
 "errors":[
 {"shape":"InternalServerException"},
 {"shape":"InvalidRequestException"},
 {"shape":"ResourceNotFoundException"}
 ],
 "documentation":"A list of all tags for a resource."
 },
 "TagResource":{
 "name":"TagResource",
 "http":{
 "method":"POST",
 "requestUri":"/tags/{resourceArn}"
 },
 "input":{"shape":"TagResourceRequest"},
 "output":{"shape":"TagResourceResponse"},
 "errors":[
 {"shape":"InternalServerException"},
 {"shape":"InvalidRequestException"},
 {"shape":"ResourceNotFoundException"}
 ],
 "documentation":"Adds metadata tags to a FinSpace resource."
 },
 "UntagResource":{
 "name":"UntagResource",
 "http":{
 "method":"DELETE",
 "requestUri":"/tags/{resourceArn}"
 },
 "input":{"shape":"UntagResourceRequest"},
 "output":{"shape":"UntagResourceResponse"},
 "errors":[
 {"shape":"InternalServerException"},
 {"shape":"InvalidRequestException"},
 {"shape":"ResourceNotFoundException"}
 ],
 "documentation":"Removes metadata tags from a FinSpace resource."
 },
 "UpdateEnvironment":{
 "name":"UpdateEnvironment",
 "http":{
 "method":"PUT",
 "requestUri":"/environment/{environmentId}"
 },
 "input":{"shape":"UpdateEnvironmentRequest"},
 "output":{"shape":"UpdateEnvironmentResponse"},
 "errors":[
 {"shape":"ResourceNotFoundException"},
 {"shape":"InternalServerException"},
 {"shape":"AccessDeniedException"},
 {"shape":"ThrottlingException"},
 {"shape":"ValidationException"}
 ],
 "documentation":"Update your FinSpace environment."
 }
 },
 "shapes":{
 "AccessDeniedException":{
 "type":"structure",
 "members":{
 },
 "documentation":"You do not have sufficient access to perform this action.",
 "error":{"httpStatusCode":403},
 "exception":true
 },
 "AttributeMap":{
 "type":"map",
 "key":{"shape":"FederationAttributeKey"},
 "value":{"shape":"url"}
 },
 "CreateEnvironmentRequest":{
 "type":"structure",
 "required":["name"],
 "members":{
 "name":{
 "shape":"EnvironmentName",
 "documentation":"The name of the FinSpace environment to be created."
 },
 "description":{
 "shape":"Description",
 "documentation":"The description of the FinSpace environment to be created."
 },
 "kmsKeyId":{
 "shape":"KmsKeyId",
 "documentation":"The KMS key id to encrypt your data in the FinSpace environment."
 },
 "tags":{
 "shape":"TagMap",
 "documentation":"Add tags to your FinSpace environment."
 },
 "federationMode":{
 "shape":"FederationMode",
 "documentation":"Authentication mode for the environment. <ul> <li> <code>FEDERATED</code> - Users access FinSpace through Single Sign On (SSO) via your Identity provider. </li> <li> <code>LOCAL</code> - Users access FinSpace via email and password managed within the FinSpace environment. </li> </ul>"
 },
 "federationParameters":{
 "shape":"FederationParameters",
 "documentation":"Configuration information when authentication mode is FEDERATED."
 },
 "superuserParameters":{
 "shape":"SuperuserParameters",
 "documentation":"Configuration information for the superuser."
 },
 "dataBundles":{
 "shape":"DataBundleArns",
 "documentation":"The list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs: <ul> <li> <code>arn:aws:finspace:${Region}::data-bundle/capital-markets-sample</code> - Contains sample Capital Markets datasets, categories and controlled vocabularies. </li> <li> <code>arn:aws:finspace:${Region}::data-bundle/taq</code> (default) - Contains trades and quotes data in addition to sample Capital Markets data. </li> </ul>"
 }
 }
 },
 "CreateEnvironmentResponse":{
 "type":"structure",
 "members":{
 "environmentId":{
 "shape":"IdType",
 "documentation":"The unique identifier for FinSpace environment that you created."
 },
 "environmentArn":{
 "shape":"EnvironmentArn",
 "documentation":"The Amazon Resource Name (ARN) of the FinSpace environment that you created."
 },
 "environmentUrl":{
 "shape":"url",
 "documentation":"The sign-in url for the web application of the FinSpace environment you created."
 }
 }
 },
 "DataBundleArn":{
 "type":"string",
 "documentation":"The Amazon Resource Name (ARN) of the data bundle.",
 "max":2048,
 "min":20,
 "pattern":"^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d*:data-bundle/[0-9A-Za-z_-]{1,128}$"
 },
 "DataBundleArns":{
 "type":"list",
 "member":{"shape":"DataBundleArn"}
 },
 "DeleteEnvironmentRequest":{
 "type":"structure",
 "required":["environmentId"],
 "members":{
 "environmentId":{
 "shape":"IdType",
 "documentation":"The identifier for the FinSpace environment.",
 "location":"uri",
 "locationName":"environmentId"
 }
 }
 },
 "DeleteEnvironmentResponse":{
 "type":"structure",
 "members":{
 }
 },
 "Description":{
 "type":"string",
 "max":1000,
 "min":1,
 "pattern":"^[a-zA-Z0-9. ]{1,1000}$"
 },
 "EmailId":{
 "type":"string",
 "max":128,
 "min":1,
 "pattern":"[A-Z0-9a-z._%+-]+@[A-Za-z0-9.-]+[.]+[A-Za-z]+",
 "sensitive":true
 },
 "Environment":{
 "type":"structure",
 "members":{
 "name":{
 "shape":"EnvironmentName",
 "documentation":"The name of the FinSpace environment."
 },
 "environmentId":{
 "shape":"IdType",
 "documentation":"The identifier of the FinSpace environment."
 },
 "awsAccountId":{
 "shape":"IdType",
 "documentation":"The ID of the AWS account in which the FinSpace environment is created."
 },
 "status":{
 "shape":"EnvironmentStatus",
 "documentation":"The current status of creation of the FinSpace environment."
 },
 "environmentUrl":{
 "shape":"url",
 "documentation":"The sign-in url for the web application of your FinSpace environment."
 },
 "description":{
 "shape":"Description",
 "documentation":"The description of the FinSpace environment."
 },
 "environmentArn":{
 "shape":"EnvironmentArn",
 "documentation":"The Amazon Resource Name (ARN) of your FinSpace environment."
 },
 "sageMakerStudioDomainUrl":{
 "shape":"SmsDomainUrl",
 "documentation":"The url of the integrated FinSpace notebook environment in your web application."
 },
 "kmsKeyId":{
 "shape":"KmsKeyId",
 "documentation":"The KMS key id used to encrypt in the FinSpace environment."
 },
 "dedicatedServiceAccountId":{
 "shape":"IdType",
 "documentation":"The AWS account ID of the dedicated service account associated with your FinSpace environment."
 },
 "federationMode":{
 "shape":"FederationMode",
 "documentation":"The authentication mode for the environment."
 },
 "federationParameters":{
 "shape":"FederationParameters",
 "documentation":"Configuration information when authentication mode is FEDERATED."
 }
 },
 "documentation":"Represents an FinSpace environment."
 },
 "EnvironmentArn":{
 "type":"string",
 "max":2048,
 "min":20,
 "pattern":"^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:environment/[0-9A-Za-z_-]{1,128}$"
 },
 "EnvironmentList":{
 "type":"list",
 "member":{"shape":"Environment"}
 },
 "EnvironmentName":{
 "type":"string",
 "max":255,
 "min":1,
 "pattern":"^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]$"
 },
 "EnvironmentStatus":{
 "type":"string",
 "enum":[
 "CREATE_REQUESTED",
 "CREATING",
 "CREATED",
 "DELETE_REQUESTED",
 "DELETING",
 "DELETED",
 "FAILED_CREATION",
 "RETRY_DELETION",
 "FAILED_DELETION",
 "SUSPENDED"
 ]
 },
 "FederationAttributeKey":{
 "type":"string",
 "max":32,
 "min":1,
 "pattern":".*"
 },
 "FederationMode":{
 "type":"string",
 "enum":[
 "FEDERATED",
 "LOCAL"
 ]
 },
 "FederationParameters":{
 "type":"structure",
 "members":{
 "samlMetadataDocument":{
 "shape":"SamlMetadataDocument",
 "documentation":"SAML 2.0 Metadata document from identity provider (IdP)."
 },
 "samlMetadataURL":{
 "shape":"url",
 "documentation":"Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP)."
 },
 "applicationCallBackURL":{
 "shape":"url",
 "documentation":"The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP)."
 },
 "federationURN":{
 "shape":"urn",
 "documentation":"The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID."
 },
 "federationProviderName":{
 "shape":"FederationProviderName",
 "documentation":"Name of the identity provider (IdP)."
 },
 "attributeMap":{
 "shape":"AttributeMap",
 "documentation":"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."
 }
 },
 "documentation":"Configuration information when authentication mode is FEDERATED."
 },
 "FederationProviderName":{
 "type":"string",
 "max":32,
 "min":1,
 "pattern":"[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+"
 },
 "GetEnvironmentRequest":{
 "type":"structure",
 "required":["environmentId"],
 "members":{
 "environmentId":{
 "shape":"IdType",
 "documentation":"The identifier of the FinSpace environment.",
 "location":"uri",
 "locationName":"environmentId"
 }
 }
 },
 "GetEnvironmentResponse":{
 "type":"structure",
 "members":{
 "environment":{
 "shape":"Environment",
 "documentation":"The name of the FinSpace environment."
 }
 }
 },
 "IdType":{
 "type":"string",
 "max":26,
 "min":1,
 "pattern":"^[a-zA-Z0-9]{1,26}$"
 },
 "InternalServerException":{
 "type":"structure",
 "members":{
 "message":{"shape":"errorMessage"}
 },
 "documentation":"The request processing has failed because of an unknown error, exception or failure.",
 "error":{"httpStatusCode":500},
 "exception":true
 },
 "InvalidRequestException":{
 "type":"structure",
 "members":{
 "message":{"shape":"errorMessage"}
 },
 "documentation":"The request is invalid. Something is wrong with the input to the request.",
 "error":{"httpStatusCode":400},
 "exception":true
 },
 "KmsKeyId":{
 "type":"string",
 "max":1000,
 "min":1,
 "pattern":"^[a-zA-Z-0-9-:\\/]*$"
 },
 "LimitExceededException":{
 "type":"structure",
 "members":{
 "message":{"shape":"errorMessage"}
 },
 "documentation":"A service limit or quota is exceeded.",
 "error":{"httpStatusCode":400},
 "exception":true
 },
 "ListEnvironmentsRequest":{
 "type":"structure",
 "members":{
 "nextToken":{
 "shape":"PaginationToken",
 "documentation":"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.",
 "location":"querystring",
 "locationName":"nextToken"
 },
 "maxResults":{
 "shape":"ResultLimit",
 "documentation":"The maximum number of results to return in this request.",
 "location":"querystring",
 "locationName":"maxResults"
 }
 }
 },
 "ListEnvironmentsResponse":{
 "type":"structure",
 "members":{
 "environments":{
 "shape":"EnvironmentList",
 "documentation":"A list of all of your FinSpace environments."
 },
 "nextToken":{
 "shape":"PaginationToken",
 "documentation":"A token that you can use in a subsequent call to retrieve the next set of results."
 }
 }
 },
 "ListTagsForResourceRequest":{
 "type":"structure",
 "required":["resourceArn"],
 "members":{
 "resourceArn":{
 "shape":"EnvironmentArn",
 "documentation":"The Amazon Resource Name of the resource.",
 "location":"uri",
 "locationName":"resourceArn"
 }
 }
 },
 "ListTagsForResourceResponse":{
 "type":"structure",
 "members":{
 "tags":{
 "shape":"TagMap",
 "documentation":"A list of all tags for a resource."
 }
 }
 },
 "NameString":{
 "type":"string",
 "max":50,
 "min":1,
 "pattern":"^[a-zA-Z0-9]{1,50}$"
 },
 "PaginationToken":{
 "type":"string",
 "max":1000,
 "min":1,
 "pattern":".*"
 },
 "ResourceNotFoundException":{
 "type":"structure",
 "members":{
 "message":{"shape":"errorMessage"}
 },
 "documentation":"One or more resources can't be found.",
 "error":{"httpStatusCode":400},
 "exception":true
 },
 "ResultLimit":{
 "type":"integer",
 "max":100,
 "min":0
 },
 "SamlMetadataDocument":{
 "type":"string",
 "max":10000000,
 "min":1000,
 "pattern":".*"
 },
 "ServiceQuotaExceededException":{
 "type":"structure",
 "members":{
 "message":{"shape":"errorMessage"}
 },
 "documentation":" 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.",
 "error":{"httpStatusCode":402},
 "exception":true
 },
 "SmsDomainUrl":{
 "type":"string",
 "max":1000,
 "min":1,
 "pattern":"^[a-zA-Z-0-9-:\\/.]*$"
 },
 "SuperuserParameters":{
 "type":"structure",
 "required":[
 "emailAddress",
 "firstName",
 "lastName"
 ],
 "members":{
 "emailAddress":{
 "shape":"EmailId",
 "documentation":"The email address of the superuser."
 },
 "firstName":{
 "shape":"NameString",
 "documentation":"The first name of the superuser."
 },
 "lastName":{
 "shape":"NameString",
 "documentation":"The last name of the superuser."
 }
 },
 "documentation":"Configuration information for the superuser."
 },
 "TagKey":{
 "type":"string",
 "max":128,
 "min":1,
 "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$"
 },
 "TagKeyList":{
 "type":"list",
 "member":{"shape":"TagKey"},
 "max":50,
 "min":1
 },
 "TagMap":{
 "type":"map",
 "key":{"shape":"TagKey"},
 "value":{"shape":"TagValue"},
 "max":50,
 "min":1
 },
 "TagResourceRequest":{
 "type":"structure",
 "required":[
 "resourceArn",
 "tags"
 ],
 "members":{
 "resourceArn":{
 "shape":"EnvironmentArn",
 "documentation":"The Amazon Resource Name (ARN) for the resource.",
 "location":"uri",
 "locationName":"resourceArn"
 },
 "tags":{
 "shape":"TagMap",
 "documentation":"One or more tags to be assigned to the resource."
 }
 }
 },
 "TagResourceResponse":{
 "type":"structure",
 "members":{
 }
 },
 "TagValue":{
 "type":"string",
 "max":256,
 "min":1,
 "pattern":"^[a-zA-Z0-9+-=._:@ ]+$"
 },
 "ThrottlingException":{
 "type":"structure",
 "members":{
 },
 "documentation":"The request was denied due to request throttling.",
 "error":{"httpStatusCode":429},
 "exception":true
 },
 "UntagResourceRequest":{
 "type":"structure",
 "required":[
 "resourceArn",
 "tagKeys"
 ],
 "members":{
 "resourceArn":{
 "shape":"EnvironmentArn",
 "documentation":"A FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).",
 "location":"uri",
 "locationName":"resourceArn"
 },
 "tagKeys":{
 "shape":"TagKeyList",
 "documentation":"The tag keys (names) of one or more tags to be removed.",
 "location":"querystring",
 "locationName":"tagKeys"
 }
 }
 },
 "UntagResourceResponse":{
 "type":"structure",
 "members":{
 }
 },
 "UpdateEnvironmentRequest":{
 "type":"structure",
 "required":["environmentId"],
 "members":{
 "environmentId":{
 "shape":"IdType",
 "documentation":"The identifier of the FinSpace environment.",
 "location":"uri",
 "locationName":"environmentId"
 },
 "name":{
 "shape":"EnvironmentName",
 "documentation":"The name of the environment."
 },
 "description":{
 "shape":"Description",
 "documentation":"The description of the environment."
 },
 "federationMode":{
 "shape":"FederationMode",
 "documentation":"Authentication mode for the environment. <ul> <li> <code>FEDERATED</code> - Users access FinSpace through Single Sign On (SSO) via your Identity provider. </li> <li> <code>LOCAL</code> - Users access FinSpace via email and password managed within the FinSpace environment. </li> </ul>"
 },
 "federationParameters":{"shape":"FederationParameters"}
 }
 },
 "UpdateEnvironmentResponse":{
 "type":"structure",
 "members":{
 "environment":{
 "shape":"Environment",
 "documentation":"Returns the FinSpace environment object."
 }
 }
 },
 "ValidationException":{
 "type":"structure",
 "members":{
 "message":{"shape":"errorMessage"}
 },
 "documentation":"The input fails to satisfy the constraints specified by an AWS service.",
 "error":{"httpStatusCode":400},
 "exception":true
 },
 "errorMessage":{"type":"string"},
 "url":{
 "type":"string",
 "max":1000,
 "min":1,
 "pattern":"^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
 },
 "urn":{
 "type":"string",
 "max":255,
 "min":1,
 "pattern":"^[A-Za-z0-9._\\-:\\/#\\+]+$"
 }
 },
 "documentation":"The FinSpace management service provides the APIs for managing FinSpace environments."
}