12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067 |
- {
- "version": "2.0",
- "metadata": {
- "apiVersion": "2020-08-18",
- "endpointPrefix": "grafana",
- "jsonVersion": "1.1",
- "protocol": "rest-json",
- "serviceFullName": "Amazon Managed Grafana",
- "serviceId": "grafana",
- "signatureVersion": "v4",
- "signingName": "grafana",
- "uid": "grafana-2020-08-18"
- },
- "operations": {
- "AssociateLicense": {
- "http": {
- "requestUri": "/workspaces/{workspaceId}/licenses/{licenseType}",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "licenseType",
- "workspaceId"
- ],
- "members": {
- "grafanaToken": {
- "location": "header",
- "locationName": "Grafana-Token"
- },
- "licenseType": {
- "location": "uri",
- "locationName": "licenseType"
- },
- "workspaceId": {
- "location": "uri",
- "locationName": "workspaceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "workspace"
- ],
- "members": {
- "workspace": {
- "shape": "S6"
- }
- }
- }
- },
- "CreateWorkspace": {
- "http": {
- "requestUri": "/workspaces",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "accountAccessType",
- "authenticationProviders",
- "permissionType"
- ],
- "members": {
- "accountAccessType": {},
- "authenticationProviders": {
- "shape": "S9"
- },
- "clientToken": {
- "idempotencyToken": true
- },
- "configuration": {
- "jsonvalue": true
- },
- "grafanaVersion": {},
- "networkAccessControl": {
- "shape": "Sk"
- },
- "organizationRoleName": {
- "shape": "Sr"
- },
- "permissionType": {},
- "stackSetName": {},
- "tags": {
- "shape": "Sx"
- },
- "vpcConfiguration": {
- "shape": "S10"
- },
- "workspaceDataSources": {
- "shape": "Sd"
- },
- "workspaceDescription": {
- "shape": "Sf"
- },
- "workspaceName": {
- "shape": "Sj"
- },
- "workspaceNotificationDestinations": {
- "shape": "Sp"
- },
- "workspaceOrganizationalUnits": {
- "shape": "Ss"
- },
- "workspaceRoleArn": {
- "shape": "S15"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "workspace"
- ],
- "members": {
- "workspace": {
- "shape": "S6"
- }
- }
- },
- "idempotent": true
- },
- "CreateWorkspaceApiKey": {
- "http": {
- "requestUri": "/workspaces/{workspaceId}/apikeys",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "keyName",
- "keyRole",
- "secondsToLive",
- "workspaceId"
- ],
- "members": {
- "keyName": {},
- "keyRole": {},
- "secondsToLive": {
- "type": "integer"
- },
- "workspaceId": {
- "location": "uri",
- "locationName": "workspaceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "key",
- "keyName",
- "workspaceId"
- ],
- "members": {
- "key": {
- "type": "string",
- "sensitive": true
- },
- "keyName": {},
- "workspaceId": {}
- }
- }
- },
- "DeleteWorkspace": {
- "http": {
- "method": "DELETE",
- "requestUri": "/workspaces/{workspaceId}",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "workspaceId"
- ],
- "members": {
- "workspaceId": {
- "location": "uri",
- "locationName": "workspaceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "workspace"
- ],
- "members": {
- "workspace": {
- "shape": "S6"
- }
- }
- },
- "idempotent": true
- },
- "DeleteWorkspaceApiKey": {
- "http": {
- "method": "DELETE",
- "requestUri": "/workspaces/{workspaceId}/apikeys/{keyName}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "keyName",
- "workspaceId"
- ],
- "members": {
- "keyName": {
- "location": "uri",
- "locationName": "keyName"
- },
- "workspaceId": {
- "location": "uri",
- "locationName": "workspaceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "keyName",
- "workspaceId"
- ],
- "members": {
- "keyName": {},
- "workspaceId": {}
- }
- }
- },
- "DescribeWorkspace": {
- "http": {
- "method": "GET",
- "requestUri": "/workspaces/{workspaceId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "workspaceId"
- ],
- "members": {
- "workspaceId": {
- "location": "uri",
- "locationName": "workspaceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "workspace"
- ],
- "members": {
- "workspace": {
- "shape": "S6"
- }
- }
- }
- },
- "DescribeWorkspaceAuthentication": {
- "http": {
- "method": "GET",
- "requestUri": "/workspaces/{workspaceId}/authentication",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "workspaceId"
- ],
- "members": {
- "workspaceId": {
- "location": "uri",
- "locationName": "workspaceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "authentication"
- ],
- "members": {
- "authentication": {
- "shape": "S1o"
- }
- }
- }
- },
- "DescribeWorkspaceConfiguration": {
- "http": {
- "method": "GET",
- "requestUri": "/workspaces/{workspaceId}/configuration",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "workspaceId"
- ],
- "members": {
- "workspaceId": {
- "location": "uri",
- "locationName": "workspaceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "configuration"
- ],
- "members": {
- "configuration": {
- "jsonvalue": true
- },
- "grafanaVersion": {}
- }
- }
- },
- "DisassociateLicense": {
- "http": {
- "method": "DELETE",
- "requestUri": "/workspaces/{workspaceId}/licenses/{licenseType}",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "licenseType",
- "workspaceId"
- ],
- "members": {
- "licenseType": {
- "location": "uri",
- "locationName": "licenseType"
- },
- "workspaceId": {
- "location": "uri",
- "locationName": "workspaceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "workspace"
- ],
- "members": {
- "workspace": {
- "shape": "S6"
- }
- }
- }
- },
- "ListPermissions": {
- "http": {
- "method": "GET",
- "requestUri": "/workspaces/{workspaceId}/permissions",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "workspaceId"
- ],
- "members": {
- "groupId": {
- "location": "querystring",
- "locationName": "groupId"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "userId": {
- "location": "querystring",
- "locationName": "userId"
- },
- "userType": {
- "location": "querystring",
- "locationName": "userType"
- },
- "workspaceId": {
- "location": "uri",
- "locationName": "workspaceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "permissions"
- ],
- "members": {
- "nextToken": {},
- "permissions": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "role",
- "user"
- ],
- "members": {
- "role": {},
- "user": {
- "shape": "S2g"
- }
- }
- }
- }
- }
- }
- },
- "ListTagsForResource": {
- "http": {
- "method": "GET",
- "requestUri": "/tags/{resourceArn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "resourceArn"
- ],
- "members": {
- "resourceArn": {
- "location": "uri",
- "locationName": "resourceArn"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "tags": {
- "shape": "Sx"
- }
- }
- }
- },
- "ListVersions": {
- "http": {
- "method": "GET",
- "requestUri": "/versions",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "workspaceId": {
- "location": "querystring",
- "locationName": "workspace-id"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "grafanaVersions": {
- "type": "list",
- "member": {}
- },
- "nextToken": {}
- }
- }
- },
- "ListWorkspaces": {
- "http": {
- "method": "GET",
- "requestUri": "/workspaces",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "workspaces"
- ],
- "members": {
- "nextToken": {},
- "workspaces": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "authentication",
- "created",
- "endpoint",
- "grafanaVersion",
- "id",
- "modified",
- "status"
- ],
- "members": {
- "authentication": {
- "shape": "S8"
- },
- "created": {
- "type": "timestamp"
- },
- "description": {
- "shape": "Sf"
- },
- "endpoint": {},
- "grafanaToken": {},
- "grafanaVersion": {},
- "id": {},
- "licenseType": {},
- "modified": {
- "type": "timestamp"
- },
- "name": {
- "shape": "Sj"
- },
- "notificationDestinations": {
- "shape": "Sp"
- },
- "status": {},
- "tags": {
- "shape": "Sx"
- }
- }
- }
- }
- }
- }
- },
- "TagResource": {
- "http": {
- "requestUri": "/tags/{resourceArn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "resourceArn",
- "tags"
- ],
- "members": {
- "resourceArn": {
- "location": "uri",
- "locationName": "resourceArn"
- },
- "tags": {
- "shape": "Sx"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- },
- "UntagResource": {
- "http": {
- "method": "DELETE",
- "requestUri": "/tags/{resourceArn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "resourceArn",
- "tagKeys"
- ],
- "members": {
- "resourceArn": {
- "location": "uri",
- "locationName": "resourceArn"
- },
- "tagKeys": {
- "location": "querystring",
- "locationName": "tagKeys",
- "type": "list",
- "member": {}
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "UpdatePermissions": {
- "http": {
- "method": "PATCH",
- "requestUri": "/workspaces/{workspaceId}/permissions",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "updateInstructionBatch",
- "workspaceId"
- ],
- "members": {
- "updateInstructionBatch": {
- "type": "list",
- "member": {
- "shape": "S2z"
- }
- },
- "workspaceId": {
- "location": "uri",
- "locationName": "workspaceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "errors"
- ],
- "members": {
- "errors": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "causedBy",
- "code",
- "message"
- ],
- "members": {
- "causedBy": {
- "shape": "S2z"
- },
- "code": {
- "type": "integer"
- },
- "message": {}
- }
- }
- }
- }
- }
- },
- "UpdateWorkspace": {
- "http": {
- "method": "PUT",
- "requestUri": "/workspaces/{workspaceId}",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "workspaceId"
- ],
- "members": {
- "accountAccessType": {},
- "networkAccessControl": {
- "shape": "Sk"
- },
- "organizationRoleName": {
- "shape": "Sr"
- },
- "permissionType": {},
- "removeNetworkAccessConfiguration": {
- "type": "boolean"
- },
- "removeVpcConfiguration": {
- "type": "boolean"
- },
- "stackSetName": {},
- "vpcConfiguration": {
- "shape": "S10"
- },
- "workspaceDataSources": {
- "shape": "Sd"
- },
- "workspaceDescription": {
- "shape": "Sf"
- },
- "workspaceId": {
- "location": "uri",
- "locationName": "workspaceId"
- },
- "workspaceName": {
- "shape": "Sj"
- },
- "workspaceNotificationDestinations": {
- "shape": "Sp"
- },
- "workspaceOrganizationalUnits": {
- "shape": "Ss"
- },
- "workspaceRoleArn": {
- "shape": "S15"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "workspace"
- ],
- "members": {
- "workspace": {
- "shape": "S6"
- }
- }
- }
- },
- "UpdateWorkspaceAuthentication": {
- "http": {
- "requestUri": "/workspaces/{workspaceId}/authentication",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "authenticationProviders",
- "workspaceId"
- ],
- "members": {
- "authenticationProviders": {
- "shape": "S9"
- },
- "samlConfiguration": {
- "shape": "S1s"
- },
- "workspaceId": {
- "location": "uri",
- "locationName": "workspaceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "authentication"
- ],
- "members": {
- "authentication": {
- "shape": "S1o"
- }
- }
- }
- },
- "UpdateWorkspaceConfiguration": {
- "http": {
- "method": "PUT",
- "requestUri": "/workspaces/{workspaceId}/configuration",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "configuration",
- "workspaceId"
- ],
- "members": {
- "configuration": {
- "jsonvalue": true
- },
- "grafanaVersion": {},
- "workspaceId": {
- "location": "uri",
- "locationName": "workspaceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- }
- },
- "shapes": {
- "S6": {
- "type": "structure",
- "required": [
- "authentication",
- "created",
- "dataSources",
- "endpoint",
- "grafanaVersion",
- "id",
- "modified",
- "status"
- ],
- "members": {
- "accountAccessType": {},
- "authentication": {
- "shape": "S8"
- },
- "created": {
- "type": "timestamp"
- },
- "dataSources": {
- "shape": "Sd"
- },
- "description": {
- "shape": "Sf"
- },
- "endpoint": {},
- "freeTrialConsumed": {
- "type": "boolean"
- },
- "freeTrialExpiration": {
- "type": "timestamp"
- },
- "grafanaToken": {},
- "grafanaVersion": {},
- "id": {},
- "licenseExpiration": {
- "type": "timestamp"
- },
- "licenseType": {},
- "modified": {
- "type": "timestamp"
- },
- "name": {
- "shape": "Sj"
- },
- "networkAccessControl": {
- "shape": "Sk"
- },
- "notificationDestinations": {
- "shape": "Sp"
- },
- "organizationRoleName": {
- "shape": "Sr"
- },
- "organizationalUnits": {
- "shape": "Ss"
- },
- "permissionType": {},
- "stackSetName": {},
- "status": {},
- "tags": {
- "shape": "Sx"
- },
- "vpcConfiguration": {
- "shape": "S10"
- },
- "workspaceRoleArn": {
- "shape": "S15"
- }
- }
- },
- "S8": {
- "type": "structure",
- "required": [
- "providers"
- ],
- "members": {
- "providers": {
- "shape": "S9"
- },
- "samlConfigurationStatus": {}
- }
- },
- "S9": {
- "type": "list",
- "member": {}
- },
- "Sd": {
- "type": "list",
- "member": {}
- },
- "Sf": {
- "type": "string",
- "sensitive": true
- },
- "Sj": {
- "type": "string",
- "sensitive": true
- },
- "Sk": {
- "type": "structure",
- "required": [
- "prefixListIds",
- "vpceIds"
- ],
- "members": {
- "prefixListIds": {
- "type": "list",
- "member": {}
- },
- "vpceIds": {
- "type": "list",
- "member": {}
- }
- }
- },
- "Sp": {
- "type": "list",
- "member": {}
- },
- "Sr": {
- "type": "string",
- "sensitive": true
- },
- "Ss": {
- "type": "list",
- "member": {},
- "sensitive": true
- },
- "Sx": {
- "type": "map",
- "key": {},
- "value": {}
- },
- "S10": {
- "type": "structure",
- "required": [
- "securityGroupIds",
- "subnetIds"
- ],
- "members": {
- "securityGroupIds": {
- "type": "list",
- "member": {}
- },
- "subnetIds": {
- "type": "list",
- "member": {}
- }
- }
- },
- "S15": {
- "type": "string",
- "sensitive": true
- },
- "S1o": {
- "type": "structure",
- "required": [
- "providers"
- ],
- "members": {
- "awsSso": {
- "type": "structure",
- "members": {
- "ssoClientId": {}
- }
- },
- "providers": {
- "shape": "S9"
- },
- "saml": {
- "type": "structure",
- "required": [
- "status"
- ],
- "members": {
- "configuration": {
- "shape": "S1s"
- },
- "status": {}
- }
- }
- }
- },
- "S1s": {
- "type": "structure",
- "required": [
- "idpMetadata"
- ],
- "members": {
- "allowedOrganizations": {
- "type": "list",
- "member": {}
- },
- "assertionAttributes": {
- "type": "structure",
- "members": {
- "email": {},
- "groups": {},
- "login": {},
- "name": {},
- "org": {},
- "role": {}
- }
- },
- "idpMetadata": {
- "type": "structure",
- "members": {
- "url": {},
- "xml": {}
- },
- "union": true
- },
- "loginValidityDuration": {
- "type": "integer"
- },
- "roleValues": {
- "type": "structure",
- "members": {
- "admin": {
- "shape": "S21"
- },
- "editor": {
- "shape": "S21"
- }
- }
- }
- }
- },
- "S21": {
- "type": "list",
- "member": {},
- "sensitive": true
- },
- "S2g": {
- "type": "structure",
- "required": [
- "id",
- "type"
- ],
- "members": {
- "id": {},
- "type": {}
- }
- },
- "S2z": {
- "type": "structure",
- "required": [
- "action",
- "role",
- "users"
- ],
- "members": {
- "action": {},
- "role": {},
- "users": {
- "type": "list",
- "member": {
- "shape": "S2g"
- }
- }
- }
- }
- }
- }
|