aws-sdk
Version:
AWS SDK for JavaScript
2,080 lines • 250 kB
JSON
{
"version": "2.0",
"metadata": {
"apiVersion": "2018-05-10",
"endpointPrefix": "datazone",
"jsonVersion": "1.1",
"protocol": "rest-json",
"serviceFullName": "Amazon DataZone",
"serviceId": "DataZone",
"signatureVersion": "v4",
"signingName": "datazone",
"uid": "datazone-2018-05-10"
},
"operations": {
"AcceptPredictions": {
"http": {
"method": "PUT",
"requestUri": "/v2/domains/{domainIdentifier}/assets/{identifier}/accept-predictions",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"identifier"
],
"members": {
"acceptChoices": {
"type": "list",
"member": {
"type": "structure",
"required": [
"predictionTarget"
],
"members": {
"editedValue": {
"type": "string",
"sensitive": true
},
"predictionChoice": {
"type": "integer"
},
"predictionTarget": {}
}
}
},
"acceptRule": {
"type": "structure",
"members": {
"rule": {},
"threshold": {
"type": "float"
}
}
},
"clientToken": {
"idempotencyToken": true
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"identifier": {
"location": "uri",
"locationName": "identifier"
},
"revision": {
"location": "querystring",
"locationName": "revision"
}
}
},
"output": {
"type": "structure",
"required": [
"assetId",
"domainId",
"revision"
],
"members": {
"assetId": {},
"domainId": {},
"revision": {}
}
},
"idempotent": true
},
"AcceptSubscriptionRequest": {
"http": {
"method": "PUT",
"requestUri": "/v2/domains/{domainIdentifier}/subscription-requests/{identifier}/accept",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"identifier"
],
"members": {
"assetScopes": {
"type": "list",
"member": {
"type": "structure",
"required": [
"assetId",
"filterIds"
],
"members": {
"assetId": {},
"filterIds": {
"shape": "Sj"
}
}
}
},
"decisionComment": {
"shape": "Sl"
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"identifier": {
"location": "uri",
"locationName": "identifier"
}
}
},
"output": {
"type": "structure",
"required": [
"createdAt",
"createdBy",
"domainId",
"id",
"requestReason",
"status",
"subscribedListings",
"subscribedPrincipals",
"updatedAt"
],
"members": {
"createdAt": {
"type": "timestamp"
},
"createdBy": {},
"decisionComment": {
"shape": "Sl"
},
"domainId": {},
"id": {},
"requestReason": {
"shape": "Sq"
},
"reviewerId": {},
"status": {},
"subscribedListings": {
"type": "list",
"member": {
"shape": "St"
}
},
"subscribedPrincipals": {
"type": "list",
"member": {
"shape": "S1b"
}
},
"updatedAt": {
"type": "timestamp"
},
"updatedBy": {}
}
},
"idempotent": true
},
"AddEntityOwner": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/entities/{entityType}/{entityIdentifier}/addOwner",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"entityIdentifier",
"entityType",
"owner"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"entityIdentifier": {
"location": "uri",
"locationName": "entityIdentifier"
},
"entityType": {
"location": "uri",
"locationName": "entityType"
},
"owner": {
"shape": "S1i"
}
}
},
"output": {
"type": "structure",
"members": {}
},
"idempotent": true
},
"AddPolicyGrant": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/policies/managed/{entityType}/{entityIdentifier}/addGrant",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"detail",
"domainIdentifier",
"entityIdentifier",
"entityType",
"policyType",
"principal"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"detail": {
"shape": "S1p"
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"entityIdentifier": {
"location": "uri",
"locationName": "entityIdentifier"
},
"entityType": {
"location": "uri",
"locationName": "entityType"
},
"policyType": {},
"principal": {
"shape": "S24"
}
}
},
"output": {
"type": "structure",
"members": {}
},
"idempotent": true
},
"AssociateEnvironmentRole": {
"http": {
"method": "PUT",
"requestUri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/roles/{environmentRoleArn}",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"environmentIdentifier",
"environmentRoleArn"
],
"members": {
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"environmentIdentifier": {
"location": "uri",
"locationName": "environmentIdentifier"
},
"environmentRoleArn": {
"location": "uri",
"locationName": "environmentRoleArn"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"CancelMetadataGenerationRun": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/metadata-generation-runs/{identifier}/cancel",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"identifier"
],
"members": {
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"identifier": {
"location": "uri",
"locationName": "identifier"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"CancelSubscription": {
"http": {
"method": "PUT",
"requestUri": "/v2/domains/{domainIdentifier}/subscriptions/{identifier}/cancel",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"identifier"
],
"members": {
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"identifier": {
"location": "uri",
"locationName": "identifier"
}
}
},
"output": {
"type": "structure",
"required": [
"createdAt",
"createdBy",
"domainId",
"id",
"status",
"subscribedListing",
"subscribedPrincipal",
"updatedAt"
],
"members": {
"createdAt": {
"type": "timestamp"
},
"createdBy": {},
"domainId": {},
"id": {},
"retainPermissions": {
"type": "boolean"
},
"status": {},
"subscribedListing": {
"shape": "St"
},
"subscribedPrincipal": {
"shape": "S1b"
},
"subscriptionRequestId": {},
"updatedAt": {
"type": "timestamp"
},
"updatedBy": {}
}
},
"idempotent": true
},
"CreateAsset": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/assets",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"name",
"owningProjectIdentifier",
"typeIdentifier"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"description": {
"shape": "Su"
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"externalIdentifier": {
"shape": "S2s"
},
"formsInput": {
"shape": "S2t"
},
"glossaryTerms": {
"shape": "S2y"
},
"name": {
"shape": "S30"
},
"owningProjectIdentifier": {},
"predictionConfiguration": {
"shape": "S31"
},
"typeIdentifier": {},
"typeRevision": {}
}
},
"output": {
"type": "structure",
"required": [
"domainId",
"formsOutput",
"id",
"name",
"owningProjectId",
"revision",
"typeIdentifier",
"typeRevision"
],
"members": {
"createdAt": {
"type": "timestamp"
},
"createdBy": {},
"description": {
"shape": "Su"
},
"domainId": {},
"externalIdentifier": {
"shape": "S2s"
},
"firstRevisionCreatedAt": {
"type": "timestamp"
},
"firstRevisionCreatedBy": {},
"formsOutput": {
"shape": "S35"
},
"glossaryTerms": {
"shape": "S2y"
},
"id": {},
"latestTimeSeriesDataPointFormsOutput": {
"shape": "S38"
},
"listing": {
"shape": "S3e"
},
"name": {
"shape": "S30"
},
"owningProjectId": {},
"predictionConfiguration": {
"shape": "S31"
},
"readOnlyFormsOutput": {
"shape": "S35"
},
"revision": {},
"typeIdentifier": {},
"typeRevision": {}
}
},
"idempotent": true
},
"CreateAssetFilter": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"assetIdentifier",
"configuration",
"domainIdentifier",
"name"
],
"members": {
"assetIdentifier": {
"location": "uri",
"locationName": "assetIdentifier"
},
"clientToken": {
"idempotencyToken": true
},
"configuration": {
"shape": "S3h"
},
"description": {
"shape": "Su"
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"name": {
"shape": "S41"
}
}
},
"output": {
"type": "structure",
"required": [
"assetId",
"configuration",
"domainId",
"id",
"name"
],
"members": {
"assetId": {},
"configuration": {
"shape": "S3h"
},
"createdAt": {
"type": "timestamp"
},
"description": {
"shape": "Su"
},
"domainId": {},
"effectiveColumnNames": {
"shape": "S3j"
},
"effectiveRowFilter": {},
"errorMessage": {},
"id": {},
"name": {
"shape": "S41"
},
"status": {}
}
},
"idempotent": true
},
"CreateAssetRevision": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/assets/{identifier}/revisions",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"identifier",
"name"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"description": {
"shape": "Su"
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"formsInput": {
"shape": "S2t"
},
"glossaryTerms": {
"shape": "S2y"
},
"identifier": {
"location": "uri",
"locationName": "identifier"
},
"name": {
"shape": "S30"
},
"predictionConfiguration": {
"shape": "S31"
},
"typeRevision": {}
}
},
"output": {
"type": "structure",
"required": [
"domainId",
"formsOutput",
"id",
"name",
"owningProjectId",
"revision",
"typeIdentifier",
"typeRevision"
],
"members": {
"createdAt": {
"type": "timestamp"
},
"createdBy": {},
"description": {
"shape": "Su"
},
"domainId": {},
"externalIdentifier": {
"shape": "S2s"
},
"firstRevisionCreatedAt": {
"type": "timestamp"
},
"firstRevisionCreatedBy": {},
"formsOutput": {
"shape": "S35"
},
"glossaryTerms": {
"shape": "S2y"
},
"id": {},
"latestTimeSeriesDataPointFormsOutput": {
"shape": "S38"
},
"listing": {
"shape": "S3e"
},
"name": {
"shape": "S30"
},
"owningProjectId": {},
"predictionConfiguration": {
"shape": "S31"
},
"readOnlyFormsOutput": {
"shape": "S35"
},
"revision": {},
"typeIdentifier": {},
"typeRevision": {}
}
},
"idempotent": true
},
"CreateAssetType": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/asset-types",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"formsInput",
"name",
"owningProjectIdentifier"
],
"members": {
"description": {
"shape": "Su"
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"formsInput": {
"type": "map",
"key": {},
"value": {
"type": "structure",
"required": [
"typeIdentifier",
"typeRevision"
],
"members": {
"required": {
"type": "boolean"
},
"typeIdentifier": {},
"typeRevision": {}
}
}
},
"name": {},
"owningProjectIdentifier": {}
}
},
"output": {
"type": "structure",
"required": [
"domainId",
"formsOutput",
"name",
"revision"
],
"members": {
"createdAt": {
"type": "timestamp"
},
"createdBy": {},
"description": {
"shape": "Su"
},
"domainId": {},
"formsOutput": {
"shape": "S4a"
},
"name": {},
"originDomainId": {},
"originProjectId": {},
"owningProjectId": {},
"revision": {},
"updatedAt": {
"type": "timestamp"
},
"updatedBy": {}
}
}
},
"CreateDataProduct": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/data-products",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"name",
"owningProjectIdentifier"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"description": {
"shape": "S4d"
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"formsInput": {
"shape": "S2t"
},
"glossaryTerms": {
"shape": "S2y"
},
"items": {
"shape": "S4e"
},
"name": {
"shape": "S4j"
},
"owningProjectIdentifier": {}
}
},
"output": {
"type": "structure",
"required": [
"domainId",
"id",
"name",
"owningProjectId",
"revision",
"status"
],
"members": {
"createdAt": {
"type": "timestamp"
},
"createdBy": {},
"description": {
"shape": "S4d"
},
"domainId": {},
"firstRevisionCreatedAt": {
"type": "timestamp"
},
"firstRevisionCreatedBy": {},
"formsOutput": {
"shape": "S35"
},
"glossaryTerms": {
"shape": "S2y"
},
"id": {},
"items": {
"shape": "S4e"
},
"name": {
"shape": "S4j"
},
"owningProjectId": {},
"revision": {},
"status": {}
}
},
"idempotent": true
},
"CreateDataProductRevision": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/data-products/{identifier}/revisions",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"identifier",
"name"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"description": {
"shape": "S4d"
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"formsInput": {
"shape": "S2t"
},
"glossaryTerms": {
"shape": "S2y"
},
"identifier": {
"location": "uri",
"locationName": "identifier"
},
"items": {
"shape": "S4e"
},
"name": {
"shape": "S4j"
}
}
},
"output": {
"type": "structure",
"required": [
"domainId",
"id",
"name",
"owningProjectId",
"revision",
"status"
],
"members": {
"createdAt": {
"type": "timestamp"
},
"createdBy": {},
"description": {
"shape": "S4d"
},
"domainId": {},
"firstRevisionCreatedAt": {
"type": "timestamp"
},
"firstRevisionCreatedBy": {},
"formsOutput": {
"shape": "S35"
},
"glossaryTerms": {
"shape": "S2y"
},
"id": {},
"items": {
"shape": "S4e"
},
"name": {
"shape": "S4j"
},
"owningProjectId": {},
"revision": {},
"status": {}
}
},
"idempotent": true
},
"CreateDataSource": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/data-sources",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"environmentIdentifier",
"name",
"projectIdentifier",
"type"
],
"members": {
"assetFormsInput": {
"shape": "S2t"
},
"clientToken": {
"idempotencyToken": true
},
"configuration": {
"shape": "S4q"
},
"description": {
"shape": "Su"
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"enableSetting": {},
"environmentIdentifier": {},
"name": {
"shape": "S5b"
},
"projectIdentifier": {},
"publishOnImport": {
"type": "boolean"
},
"recommendation": {
"shape": "S5c"
},
"schedule": {
"shape": "S5d"
},
"type": {}
}
},
"output": {
"type": "structure",
"required": [
"domainId",
"environmentId",
"id",
"name",
"projectId"
],
"members": {
"assetFormsOutput": {
"shape": "S35"
},
"configuration": {
"shape": "S5i"
},
"createdAt": {
"shape": "S5r"
},
"description": {
"shape": "Su"
},
"domainId": {},
"enableSetting": {},
"environmentId": {},
"errorMessage": {
"shape": "S5s"
},
"id": {},
"lastRunAt": {
"shape": "S5r"
},
"lastRunErrorMessage": {
"shape": "S5s"
},
"lastRunStatus": {},
"name": {
"shape": "S5b"
},
"projectId": {},
"publishOnImport": {
"type": "boolean"
},
"recommendation": {
"shape": "S5c"
},
"schedule": {
"shape": "S5d"
},
"status": {},
"type": {},
"updatedAt": {
"shape": "S5r"
}
}
},
"idempotent": true
},
"CreateDomain": {
"http": {
"requestUri": "/v2/domains",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainExecutionRole",
"name"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"description": {},
"domainExecutionRole": {},
"kmsKeyIdentifier": {},
"name": {},
"singleSignOn": {
"shape": "S60"
},
"tags": {
"shape": "S63"
}
}
},
"output": {
"type": "structure",
"required": [
"id"
],
"members": {
"arn": {},
"description": {},
"domainExecutionRole": {},
"id": {},
"kmsKeyIdentifier": {},
"name": {},
"portalUrl": {},
"rootDomainUnitId": {},
"singleSignOn": {
"shape": "S60"
},
"status": {},
"tags": {
"shape": "S63"
}
}
},
"idempotent": true
},
"CreateDomainUnit": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/domain-units",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"name",
"parentDomainUnitIdentifier"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"description": {
"shape": "S69"
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"name": {
"shape": "S6a"
},
"parentDomainUnitIdentifier": {}
}
},
"output": {
"type": "structure",
"required": [
"ancestorDomainUnitIds",
"domainId",
"id",
"name",
"owners"
],
"members": {
"ancestorDomainUnitIds": {
"type": "list",
"member": {}
},
"createdAt": {
"type": "timestamp"
},
"createdBy": {},
"description": {
"shape": "S69"
},
"domainId": {},
"id": {},
"name": {
"shape": "S6a"
},
"owners": {
"shape": "S6d"
},
"parentDomainUnitId": {}
}
},
"idempotent": true
},
"CreateEnvironment": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/environments",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"environmentProfileIdentifier",
"name",
"projectIdentifier"
],
"members": {
"description": {},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"environmentAccountIdentifier": {},
"environmentAccountRegion": {},
"environmentBlueprintIdentifier": {},
"environmentProfileIdentifier": {},
"glossaryTerms": {
"shape": "S2y"
},
"name": {},
"projectIdentifier": {},
"userParameters": {
"shape": "S6j"
}
}
},
"output": {
"type": "structure",
"required": [
"createdBy",
"domainId",
"name",
"projectId",
"provider"
],
"members": {
"awsAccountId": {},
"awsAccountRegion": {},
"createdAt": {
"shape": "S6o"
},
"createdBy": {},
"deploymentProperties": {
"shape": "S6p"
},
"description": {
"shape": "Su"
},
"domainId": {},
"environmentActions": {
"shape": "S6s"
},
"environmentBlueprintId": {},
"environmentProfileId": {},
"glossaryTerms": {
"shape": "S2y"
},
"id": {},
"lastDeployment": {
"shape": "S6y"
},
"name": {
"shape": "S74"
},
"projectId": {},
"provider": {},
"provisionedResources": {
"shape": "S75"
},
"provisioningProperties": {
"shape": "S77"
},
"status": {},
"updatedAt": {
"shape": "S6o"
},
"userParameters": {
"shape": "S7a"
}
}
}
},
"CreateEnvironmentAction": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/actions",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"environmentIdentifier",
"name",
"parameters"
],
"members": {
"description": {},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"environmentIdentifier": {
"location": "uri",
"locationName": "environmentIdentifier"
},
"name": {},
"parameters": {
"shape": "S7e"
}
}
},
"output": {
"type": "structure",
"required": [
"domainId",
"environmentId",
"id",
"name",
"parameters"
],
"members": {
"description": {},
"domainId": {},
"environmentId": {},
"id": {},
"name": {},
"parameters": {
"shape": "S7e"
}
}
}
},
"CreateEnvironmentProfile": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/environment-profiles",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"environmentBlueprintIdentifier",
"name",
"projectIdentifier"
],
"members": {
"awsAccountId": {},
"awsAccountRegion": {},
"description": {
"shape": "Su"
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"environmentBlueprintIdentifier": {},
"name": {
"shape": "S7j"
},
"projectIdentifier": {},
"userParameters": {
"shape": "S6j"
}
}
},
"output": {
"type": "structure",
"required": [
"createdBy",
"domainId",
"environmentBlueprintId",
"id",
"name"
],
"members": {
"awsAccountId": {},
"awsAccountRegion": {},
"createdAt": {
"shape": "S6o"
},
"createdBy": {},
"description": {
"shape": "Su"
},
"domainId": {},
"environmentBlueprintId": {},
"id": {},
"name": {
"shape": "S7j"
},
"projectId": {},
"updatedAt": {
"shape": "S6o"
},
"userParameters": {
"shape": "S7a"
}
}
}
},
"CreateFormType": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/form-types",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"model",
"name",
"owningProjectIdentifier"
],
"members": {
"description": {
"shape": "Su"
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"model": {
"shape": "S7m"
},
"name": {
"shape": "S37"
},
"owningProjectIdentifier": {},
"status": {}
}
},
"output": {
"type": "structure",
"required": [
"domainId",
"name",
"revision"
],
"members": {
"description": {
"shape": "Su"
},
"domainId": {},
"name": {
"shape": "S37"
},
"originDomainId": {},
"originProjectId": {},
"owningProjectId": {},
"revision": {}
}
}
},
"CreateGlossary": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/glossaries",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"name",
"owningProjectIdentifier"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"description": {
"shape": "S7r"
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"name": {
"shape": "S7s"
},
"owningProjectIdentifier": {},
"status": {}
}
},
"output": {
"type": "structure",
"required": [
"domainId",
"id",
"name",
"owningProjectId"
],
"members": {
"description": {
"shape": "S7r"
},
"domainId": {},
"id": {},
"name": {
"shape": "S7s"
},
"owningProjectId": {},
"status": {}
}
},
"idempotent": true
},
"CreateGlossaryTerm": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/glossary-terms",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"glossaryIdentifier",
"name"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"glossaryIdentifier": {},
"longDescription": {
"shape": "S7x"
},
"name": {
"shape": "S13"
},
"shortDescription": {
"shape": "S14"
},
"status": {},
"termRelations": {
"shape": "S7z"
}
}
},
"output": {
"type": "structure",
"required": [
"domainId",
"glossaryId",
"id",
"name",
"status"
],
"members": {
"domainId": {},
"glossaryId": {},
"id": {},
"longDescription": {
"shape": "S7x"
},
"name": {
"shape": "S13"
},
"shortDescription": {
"shape": "S14"
},
"status": {},
"termRelations": {
"shape": "S7z"
}
}
},
"idempotent": true
},
"CreateGroupProfile": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/group-profiles",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"groupIdentifier"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"groupIdentifier": {}
}
},
"output": {
"type": "structure",
"members": {
"domainId": {},
"groupName": {
"shape": "S85"
},
"id": {},
"status": {}
}
},
"idempotent": true
},
"CreateListingChangeSet": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/listings/change-set",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"action",
"domainIdentifier",
"entityIdentifier",
"entityType"
],
"members": {
"action": {},
"clientToken": {
"idempotencyToken": true
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"entityIdentifier": {},
"entityRevision": {},
"entityType": {}
}
},
"output": {
"type": "structure",
"required": [
"listingId",
"listingRevision",
"status"
],
"members": {
"listingId": {},
"listingRevision": {},
"status": {}
}
}
},
"CreateProject": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/projects",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"name"
],
"members": {
"description": {
"shape": "Su"
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"domainUnitId": {},
"glossaryTerms": {
"shape": "S2y"
},
"name": {
"shape": "S1d"
}
}
},
"output": {
"type": "structure",
"required": [
"createdBy",
"domainId",
"id",
"name"
],
"members": {
"createdAt": {
"shape": "S6o"
},
"createdBy": {},
"description": {
"shape": "Su"
},
"domainId": {},
"domainUnitId": {},
"failureReasons": {
"shape": "S8e"
},
"glossaryTerms": {
"shape": "S2y"
},
"id": {},
"lastUpdatedAt": {
"shape": "S6o"
},
"name": {
"shape": "S1d"
},
"projectStatus": {}
}
}
},
"CreateProjectMembership": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/projects/{projectIdentifier}/createMembership",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"designation",
"domainIdentifier",
"member",
"projectIdentifier"
],
"members": {
"designation": {},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"member": {
"shape": "S8j"
},
"projectIdentifier": {
"location": "uri",
"locationName": "projectIdentifier"
}
}
},
"output": {
"type": "structure",
"members": {}
}
},
"CreateSubscriptionGrant": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/subscription-grants",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"environmentIdentifier",
"grantedEntity",
"subscriptionTargetIdentifier"
],
"members": {
"assetTargetNames": {
"type": "list",
"member": {
"type": "structure",
"required": [
"assetId",
"targetName"
],
"members": {
"assetId": {},
"targetName": {}
}
}
},
"clientToken": {
"idempotencyToken": true
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"environmentIdentifier": {},
"grantedEntity": {
"type": "structure",
"members": {
"listing": {
"type": "structure",
"required": [
"identifier",
"revision"
],
"members": {
"identifier": {},
"revision": {}
}
}
},
"union": true
},
"subscriptionTargetIdentifier": {}
}
},
"output": {
"type": "structure",
"required": [
"createdAt",
"createdBy",
"domainId",
"grantedEntity",
"id",
"status",
"subscriptionTargetId",
"updatedAt"
],
"members": {
"assets": {
"shape": "S8s"
},
"createdAt": {
"type": "timestamp"
},
"createdBy": {},
"domainId": {},
"grantedEntity": {
"shape": "S8w"
},
"id": {},
"status": {},
"subscriptionId": {
"deprecated": true,
"deprecatedMessage": "Multiple subscriptions can exist for a single grant"
},
"subscriptionTargetId": {},
"updatedAt": {
"type": "timestamp"
},
"updatedBy": {}
}
}
},
"CreateSubscriptionRequest": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/subscription-requests",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"requestReason",
"subscribedListings",
"subscribedPrincipals"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"requestReason": {
"shape": "Sq"
},
"subscribedListings": {
"type": "list",
"member": {
"type": "structure",
"required": [
"identifier"
],
"members": {
"identifier": {}
}
}
},
"subscribedPrincipals": {
"type": "list",
"member": {
"type": "structure",
"members": {
"project": {
"type": "structure",
"members": {
"identifier": {}
}
}
},
"union": true
}
}
}
},
"output": {
"type": "structure",
"required": [
"createdAt",
"createdBy",
"domainId",
"id",
"requestReason",
"status",
"subscribedListings",
"subscribedPrincipals",
"updatedAt"
],
"members": {
"createdAt": {
"type": "timestamp"
},
"createdBy": {},
"decisionComment": {
"shape": "Sl"
},
"domainId": {},
"id": {},
"requestReason": {
"shape": "Sq"
},
"reviewerId": {},
"status": {},
"subscribedListings": {
"type": "list",
"member": {
"shape": "St"
}
},
"subscribedPrincipals": {
"type": "list",
"member": {
"shape": "S1b"
}
},
"updatedAt": {
"type": "timestamp"
},
"updatedBy": {}
}
}
},
"CreateSubscriptionTarget": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/environments/{environmentIdentifier}/subscription-targets",
"responseCode": 200
},
"input": {
"type": "structure",
"required": [
"applicableAssetTypes",
"authorizedPrincipals",
"domainIdentifier",
"environmentIdentifier",
"manageAccessRole",
"name",
"subscriptionTargetConfig",
"type"
],
"members": {
"applicableAssetTypes": {
"shape": "S9a"
},
"authorizedPrincipals": {
"shape": "S9b"
},
"clientToken": {
"idempotencyToken": true
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"environmentIdentifier": {
"location": "uri",
"locationName": "environmentIdentifier"
},
"manageAccessRole": {},
"name": {
"shape": "S9d"
},
"provider": {},
"subscriptionTargetConfig": {
"shape": "S9e"
},
"type": {}
}
},
"output": {
"type": "structure",
"required": [
"applicableAssetTypes",
"authorizedPrincipals",
"createdAt",
"createdBy",
"domainId",
"environmentId",
"id",
"manageAccessRole",
"name",
"projectId",
"provider",
"subscriptionTargetConfig",
"type"
],
"members": {
"applicableAssetTypes": {
"shape": "S9a"
},
"authorizedPrincipals": {
"shape": "S9b"
},
"createdAt": {
"type": "timestamp"
},
"createdBy": {},
"domainId": {},
"environmentId": {},
"id": {},
"manageAccessRole": {},
"name": {
"shape": "S9d"
},
"projectId": {},
"provider": {},
"subscriptionTargetConfig": {
"shape": "S9e"
},
"type": {},
"updatedAt": {
"type": "timestamp"
},
"updatedBy": {}
}
}
},
"CreateUserProfile": {
"http": {
"requestUri": "/v2/domains/{domainIdentifier}/user-profiles",
"responseCode": 201
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"userIdentifier"
],
"members": {
"clientToken": {
"idempotencyToken": true
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"userIdentifier": {},
"userType": {}
}
},
"output": {
"type": "structure",
"members": {
"details": {
"shape": "S9k"
},
"domainId": {},
"id": {},
"status": {},
"type": {}
}
},
"idempotent": true
},
"DeleteAsset": {
"http": {
"method": "DELETE",
"requestUri": "/v2/domains/{domainIdentifier}/assets/{identifier}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"identifier"
],
"members": {
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"identifier": {
"location": "uri",
"locationName": "identifier"
}
}
},
"output": {
"type": "structure",
"members": {}
},
"idempotent": true
},
"DeleteAssetFilter": {
"http": {
"method": "DELETE",
"requestUri": "/v2/domains/{domainIdentifier}/assets/{assetIdentifier}/filters/{identifier}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"assetIdentifier",
"domainIdentifier",
"identifier"
],
"members": {
"assetIdentifier": {
"location": "uri",
"locationName": "assetIdentifier"
},
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"identifier": {
"location": "uri",
"locationName": "identifier"
}
}
},
"idempotent": true
},
"DeleteAssetType": {
"http": {
"method": "DELETE",
"requestUri": "/v2/domains/{domainIdentifier}/asset-types/{identifier}",
"responseCode": 204
},
"input": {
"type": "structure",
"required": [
"domainIdentifier",
"identifier"
],
"members": {
"domainIdentifier": {
"location": "uri",
"locationName": "domainIdentifier"
},
"identifier": {
"location": "uri",
"locationName": "identifier"
}
}
},
"output": {
"type": "structure",
"members":