github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/finspace/2021-03-12/api-2.json (about)

     1  {
     2    "version":"2.0",
     3    "metadata":{
     4      "apiVersion":"2021-03-12",
     5      "endpointPrefix":"finspace",
     6      "jsonVersion":"1.1",
     7      "protocol":"rest-json",
     8      "serviceAbbreviation":"finspace",
     9      "serviceFullName":"FinSpace User Environment Management service",
    10      "serviceId":"finspace",
    11      "signatureVersion":"v4",
    12      "signingName":"finspace",
    13      "uid":"finspace-2021-03-12"
    14    },
    15    "operations":{
    16      "CreateEnvironment":{
    17        "name":"CreateEnvironment",
    18        "http":{
    19          "method":"POST",
    20          "requestUri":"/environment"
    21        },
    22        "input":{"shape":"CreateEnvironmentRequest"},
    23        "output":{"shape":"CreateEnvironmentResponse"},
    24        "errors":[
    25          {"shape":"InternalServerException"},
    26          {"shape":"ValidationException"},
    27          {"shape":"AccessDeniedException"},
    28          {"shape":"ThrottlingException"},
    29          {"shape":"ServiceQuotaExceededException"},
    30          {"shape":"LimitExceededException"}
    31        ]
    32      },
    33      "DeleteEnvironment":{
    34        "name":"DeleteEnvironment",
    35        "http":{
    36          "method":"DELETE",
    37          "requestUri":"/environment/{environmentId}"
    38        },
    39        "input":{"shape":"DeleteEnvironmentRequest"},
    40        "output":{"shape":"DeleteEnvironmentResponse"},
    41        "errors":[
    42          {"shape":"ResourceNotFoundException"},
    43          {"shape":"InternalServerException"},
    44          {"shape":"AccessDeniedException"},
    45          {"shape":"ThrottlingException"},
    46          {"shape":"ValidationException"}
    47        ]
    48      },
    49      "GetEnvironment":{
    50        "name":"GetEnvironment",
    51        "http":{
    52          "method":"GET",
    53          "requestUri":"/environment/{environmentId}"
    54        },
    55        "input":{"shape":"GetEnvironmentRequest"},
    56        "output":{"shape":"GetEnvironmentResponse"},
    57        "errors":[
    58          {"shape":"ResourceNotFoundException"},
    59          {"shape":"InternalServerException"},
    60          {"shape":"ValidationException"},
    61          {"shape":"AccessDeniedException"}
    62        ]
    63      },
    64      "ListEnvironments":{
    65        "name":"ListEnvironments",
    66        "http":{
    67          "method":"GET",
    68          "requestUri":"/environment"
    69        },
    70        "input":{"shape":"ListEnvironmentsRequest"},
    71        "output":{"shape":"ListEnvironmentsResponse"},
    72        "errors":[
    73          {"shape":"InternalServerException"},
    74          {"shape":"ValidationException"}
    75        ]
    76      },
    77      "ListTagsForResource":{
    78        "name":"ListTagsForResource",
    79        "http":{
    80          "method":"GET",
    81          "requestUri":"/tags/{resourceArn}"
    82        },
    83        "input":{"shape":"ListTagsForResourceRequest"},
    84        "output":{"shape":"ListTagsForResourceResponse"},
    85        "errors":[
    86          {"shape":"InternalServerException"},
    87          {"shape":"InvalidRequestException"},
    88          {"shape":"ResourceNotFoundException"}
    89        ]
    90      },
    91      "TagResource":{
    92        "name":"TagResource",
    93        "http":{
    94          "method":"POST",
    95          "requestUri":"/tags/{resourceArn}"
    96        },
    97        "input":{"shape":"TagResourceRequest"},
    98        "output":{"shape":"TagResourceResponse"},
    99        "errors":[
   100          {"shape":"InternalServerException"},
   101          {"shape":"InvalidRequestException"},
   102          {"shape":"ResourceNotFoundException"}
   103        ]
   104      },
   105      "UntagResource":{
   106        "name":"UntagResource",
   107        "http":{
   108          "method":"DELETE",
   109          "requestUri":"/tags/{resourceArn}"
   110        },
   111        "input":{"shape":"UntagResourceRequest"},
   112        "output":{"shape":"UntagResourceResponse"},
   113        "errors":[
   114          {"shape":"InternalServerException"},
   115          {"shape":"InvalidRequestException"},
   116          {"shape":"ResourceNotFoundException"}
   117        ]
   118      },
   119      "UpdateEnvironment":{
   120        "name":"UpdateEnvironment",
   121        "http":{
   122          "method":"PUT",
   123          "requestUri":"/environment/{environmentId}"
   124        },
   125        "input":{"shape":"UpdateEnvironmentRequest"},
   126        "output":{"shape":"UpdateEnvironmentResponse"},
   127        "errors":[
   128          {"shape":"ResourceNotFoundException"},
   129          {"shape":"InternalServerException"},
   130          {"shape":"AccessDeniedException"},
   131          {"shape":"ThrottlingException"},
   132          {"shape":"ValidationException"}
   133        ]
   134      }
   135    },
   136    "shapes":{
   137      "AccessDeniedException":{
   138        "type":"structure",
   139        "members":{
   140        },
   141        "error":{"httpStatusCode":403},
   142        "exception":true
   143      },
   144      "AttributeMap":{
   145        "type":"map",
   146        "key":{"shape":"FederationAttributeKey"},
   147        "value":{"shape":"url"}
   148      },
   149      "CreateEnvironmentRequest":{
   150        "type":"structure",
   151        "required":["name"],
   152        "members":{
   153          "name":{"shape":"EnvironmentName"},
   154          "description":{"shape":"Description"},
   155          "kmsKeyId":{"shape":"KmsKeyId"},
   156          "tags":{"shape":"TagMap"},
   157          "federationMode":{"shape":"FederationMode"},
   158          "federationParameters":{"shape":"FederationParameters"}
   159        }
   160      },
   161      "CreateEnvironmentResponse":{
   162        "type":"structure",
   163        "members":{
   164          "environmentId":{"shape":"IdType"},
   165          "environmentArn":{"shape":"EnvironmentArn"},
   166          "environmentUrl":{"shape":"url"}
   167        }
   168      },
   169      "DeleteEnvironmentRequest":{
   170        "type":"structure",
   171        "required":["environmentId"],
   172        "members":{
   173          "environmentId":{
   174            "shape":"IdType",
   175            "location":"uri",
   176            "locationName":"environmentId"
   177          }
   178        }
   179      },
   180      "DeleteEnvironmentResponse":{
   181        "type":"structure",
   182        "members":{
   183        }
   184      },
   185      "Description":{
   186        "type":"string",
   187        "max":1000,
   188        "min":1,
   189        "pattern":"^[a-zA-Z0-9. ]{1,1000}$"
   190      },
   191      "Environment":{
   192        "type":"structure",
   193        "members":{
   194          "name":{"shape":"EnvironmentName"},
   195          "environmentId":{"shape":"IdType"},
   196          "awsAccountId":{"shape":"IdType"},
   197          "status":{"shape":"EnvironmentStatus"},
   198          "environmentUrl":{"shape":"url"},
   199          "description":{"shape":"Description"},
   200          "environmentArn":{"shape":"EnvironmentArn"},
   201          "sageMakerStudioDomainUrl":{"shape":"SmsDomainUrl"},
   202          "kmsKeyId":{"shape":"KmsKeyId"},
   203          "dedicatedServiceAccountId":{"shape":"IdType"},
   204          "federationMode":{"shape":"FederationMode"},
   205          "federationParameters":{"shape":"FederationParameters"}
   206        }
   207      },
   208      "EnvironmentArn":{
   209        "type":"string",
   210        "max":2048,
   211        "min":20,
   212        "pattern":"^arn:aws:finspace:[A-Za-z0-9_/.-]{0,63}:\\d+:environment/[0-9A-Za-z_-]{1,128}$"
   213      },
   214      "EnvironmentList":{
   215        "type":"list",
   216        "member":{"shape":"Environment"}
   217      },
   218      "EnvironmentName":{
   219        "type":"string",
   220        "max":255,
   221        "min":1,
   222        "pattern":"^[a-zA-Z0-9]+[a-zA-Z0-9-]*[a-zA-Z0-9]$"
   223      },
   224      "EnvironmentStatus":{
   225        "type":"string",
   226        "enum":[
   227          "CREATE_REQUESTED",
   228          "CREATING",
   229          "CREATED",
   230          "DELETE_REQUESTED",
   231          "DELETING",
   232          "DELETED",
   233          "FAILED_CREATION",
   234          "RETRY_DELETION",
   235          "FAILED_DELETION",
   236          "SUSPENDED"
   237        ]
   238      },
   239      "FederationAttributeKey":{
   240        "type":"string",
   241        "max":32,
   242        "min":1,
   243        "pattern":".*"
   244      },
   245      "FederationMode":{
   246        "type":"string",
   247        "enum":[
   248          "FEDERATED",
   249          "LOCAL"
   250        ]
   251      },
   252      "FederationParameters":{
   253        "type":"structure",
   254        "members":{
   255          "samlMetadataDocument":{"shape":"SamlMetadataDocument"},
   256          "samlMetadataURL":{"shape":"url"},
   257          "applicationCallBackURL":{"shape":"url"},
   258          "federationURN":{"shape":"urn"},
   259          "federationProviderName":{"shape":"FederationProviderName"},
   260          "attributeMap":{"shape":"AttributeMap"}
   261        }
   262      },
   263      "FederationProviderName":{
   264        "type":"string",
   265        "max":32,
   266        "min":1,
   267        "pattern":"[^_\\p{Z}][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_\\p{Z}]+"
   268      },
   269      "GetEnvironmentRequest":{
   270        "type":"structure",
   271        "required":["environmentId"],
   272        "members":{
   273          "environmentId":{
   274            "shape":"IdType",
   275            "location":"uri",
   276            "locationName":"environmentId"
   277          }
   278        }
   279      },
   280      "GetEnvironmentResponse":{
   281        "type":"structure",
   282        "members":{
   283          "environment":{"shape":"Environment"}
   284        }
   285      },
   286      "IdType":{
   287        "type":"string",
   288        "max":26,
   289        "min":1,
   290        "pattern":"^[a-zA-Z0-9]{1,26}$"
   291      },
   292      "InternalServerException":{
   293        "type":"structure",
   294        "members":{
   295          "message":{"shape":"errorMessage"}
   296        },
   297        "error":{"httpStatusCode":500},
   298        "exception":true
   299      },
   300      "InvalidRequestException":{
   301        "type":"structure",
   302        "members":{
   303          "message":{"shape":"errorMessage"}
   304        },
   305        "error":{"httpStatusCode":400},
   306        "exception":true
   307      },
   308      "KmsKeyId":{
   309        "type":"string",
   310        "max":1000,
   311        "min":1,
   312        "pattern":"^[a-zA-Z-0-9-:\\/]*$"
   313      },
   314      "LimitExceededException":{
   315        "type":"structure",
   316        "members":{
   317          "message":{"shape":"errorMessage"}
   318        },
   319        "error":{"httpStatusCode":400},
   320        "exception":true
   321      },
   322      "ListEnvironmentsRequest":{
   323        "type":"structure",
   324        "members":{
   325          "nextToken":{
   326            "shape":"PaginationToken",
   327            "location":"querystring",
   328            "locationName":"nextToken"
   329          },
   330          "maxResults":{
   331            "shape":"ResultLimit",
   332            "location":"querystring",
   333            "locationName":"maxResults"
   334          }
   335        }
   336      },
   337      "ListEnvironmentsResponse":{
   338        "type":"structure",
   339        "members":{
   340          "environments":{"shape":"EnvironmentList"},
   341          "nextToken":{"shape":"PaginationToken"}
   342        }
   343      },
   344      "ListTagsForResourceRequest":{
   345        "type":"structure",
   346        "required":["resourceArn"],
   347        "members":{
   348          "resourceArn":{
   349            "shape":"EnvironmentArn",
   350            "location":"uri",
   351            "locationName":"resourceArn"
   352          }
   353        }
   354      },
   355      "ListTagsForResourceResponse":{
   356        "type":"structure",
   357        "members":{
   358          "tags":{"shape":"TagMap"}
   359        }
   360      },
   361      "PaginationToken":{
   362        "type":"string",
   363        "max":1000,
   364        "min":1,
   365        "pattern":".*"
   366      },
   367      "ResourceNotFoundException":{
   368        "type":"structure",
   369        "members":{
   370          "message":{"shape":"errorMessage"}
   371        },
   372        "error":{"httpStatusCode":400},
   373        "exception":true
   374      },
   375      "ResultLimit":{
   376        "type":"integer",
   377        "max":100,
   378        "min":0
   379      },
   380      "SamlMetadataDocument":{
   381        "type":"string",
   382        "max":10000000,
   383        "min":1000,
   384        "pattern":".*"
   385      },
   386      "ServiceQuotaExceededException":{
   387        "type":"structure",
   388        "members":{
   389          "message":{"shape":"errorMessage"}
   390        },
   391        "error":{"httpStatusCode":402},
   392        "exception":true
   393      },
   394      "SmsDomainUrl":{
   395        "type":"string",
   396        "max":1000,
   397        "min":1,
   398        "pattern":"^[a-zA-Z-0-9-:\\/.]*$"
   399      },
   400      "TagKey":{
   401        "type":"string",
   402        "max":128,
   403        "min":1,
   404        "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$"
   405      },
   406      "TagKeyList":{
   407        "type":"list",
   408        "member":{"shape":"TagKey"},
   409        "max":50,
   410        "min":1
   411      },
   412      "TagMap":{
   413        "type":"map",
   414        "key":{"shape":"TagKey"},
   415        "value":{"shape":"TagValue"},
   416        "max":50,
   417        "min":1
   418      },
   419      "TagResourceRequest":{
   420        "type":"structure",
   421        "required":[
   422          "resourceArn",
   423          "tags"
   424        ],
   425        "members":{
   426          "resourceArn":{
   427            "shape":"EnvironmentArn",
   428            "location":"uri",
   429            "locationName":"resourceArn"
   430          },
   431          "tags":{"shape":"TagMap"}
   432        }
   433      },
   434      "TagResourceResponse":{
   435        "type":"structure",
   436        "members":{
   437        }
   438      },
   439      "TagValue":{
   440        "type":"string",
   441        "max":256,
   442        "min":1,
   443        "pattern":"^[a-zA-Z0-9+-=._:@ ]+$"
   444      },
   445      "ThrottlingException":{
   446        "type":"structure",
   447        "members":{
   448        },
   449        "error":{"httpStatusCode":429},
   450        "exception":true
   451      },
   452      "UntagResourceRequest":{
   453        "type":"structure",
   454        "required":[
   455          "resourceArn",
   456          "tagKeys"
   457        ],
   458        "members":{
   459          "resourceArn":{
   460            "shape":"EnvironmentArn",
   461            "location":"uri",
   462            "locationName":"resourceArn"
   463          },
   464          "tagKeys":{
   465            "shape":"TagKeyList",
   466            "location":"querystring",
   467            "locationName":"tagKeys"
   468          }
   469        }
   470      },
   471      "UntagResourceResponse":{
   472        "type":"structure",
   473        "members":{
   474        }
   475      },
   476      "UpdateEnvironmentRequest":{
   477        "type":"structure",
   478        "required":["environmentId"],
   479        "members":{
   480          "environmentId":{
   481            "shape":"IdType",
   482            "location":"uri",
   483            "locationName":"environmentId"
   484          },
   485          "name":{"shape":"EnvironmentName"},
   486          "description":{"shape":"Description"},
   487          "federationMode":{"shape":"FederationMode"},
   488          "federationParameters":{"shape":"FederationParameters"}
   489        }
   490      },
   491      "UpdateEnvironmentResponse":{
   492        "type":"structure",
   493        "members":{
   494          "environment":{"shape":"Environment"}
   495        }
   496      },
   497      "ValidationException":{
   498        "type":"structure",
   499        "members":{
   500          "message":{"shape":"errorMessage"}
   501        },
   502        "error":{"httpStatusCode":400},
   503        "exception":true
   504      },
   505      "errorMessage":{"type":"string"},
   506      "url":{
   507        "type":"string",
   508        "max":1000,
   509        "min":1,
   510        "pattern":"^https?://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
   511      },
   512      "urn":{
   513        "type":"string",
   514        "max":255,
   515        "min":1,
   516        "pattern":"^[A-Za-z0-9._\\-:\\/#\\+]+$"
   517      }
   518    }
   519  }