@aws-sdk/client-cloudwatchomni 3.1138.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +611 -0
- package/dist-cjs/index.js +3006 -0
- package/dist-es/CloudWatchOmni.js +161 -0
- package/dist-es/CloudWatchOmniClient.js +47 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +40 -0
- package/dist-es/commandBuilder.js +6 -0
- package/dist-es/commands/CreateAccessGrantCommand.js +4 -0
- package/dist-es/commands/CreateAccessProfileCommand.js +4 -0
- package/dist-es/commands/CreateAlertCommand.js +4 -0
- package/dist-es/commands/CreateDomainAccessGrantForOrganizationCommand.js +4 -0
- package/dist-es/commands/CreateDomainCommand.js +4 -0
- package/dist-es/commands/CreateDomainForOrganizationCommand.js +4 -0
- package/dist-es/commands/CreateIntegrationCommand.js +4 -0
- package/dist-es/commands/CreateOmniDashboardCommand.js +4 -0
- package/dist-es/commands/CreateOneTimeDeepLinkCodeCommand.js +4 -0
- package/dist-es/commands/CreateSpaceCommand.js +4 -0
- package/dist-es/commands/CreateViewCommand.js +4 -0
- package/dist-es/commands/DeleteAccessGrantCommand.js +4 -0
- package/dist-es/commands/DeleteAccessProfileCommand.js +4 -0
- package/dist-es/commands/DeleteAlertCommand.js +4 -0
- package/dist-es/commands/DeleteDomainAccessGrantForOrganizationCommand.js +4 -0
- package/dist-es/commands/DeleteDomainCommand.js +4 -0
- package/dist-es/commands/DeleteDomainForOrganizationCommand.js +4 -0
- package/dist-es/commands/DeleteIntegrationCommand.js +4 -0
- package/dist-es/commands/DeleteOmniDashboardCommand.js +4 -0
- package/dist-es/commands/DeleteSpaceCommand.js +4 -0
- package/dist-es/commands/DeleteViewCommand.js +4 -0
- package/dist-es/commands/GetAccessGrantCommand.js +4 -0
- package/dist-es/commands/GetAccessProfileCommand.js +4 -0
- package/dist-es/commands/GetAlertCommand.js +4 -0
- package/dist-es/commands/GetContextGraphCommand.js +4 -0
- package/dist-es/commands/GetDomainAccessGrantForOrganizationCommand.js +4 -0
- package/dist-es/commands/GetDomainCommand.js +4 -0
- package/dist-es/commands/GetDomainForOrganizationCommand.js +4 -0
- package/dist-es/commands/GetIntegrationCommand.js +4 -0
- package/dist-es/commands/GetIntelligenceConfigurationCommand.js +4 -0
- package/dist-es/commands/GetOmniDashboardCommand.js +4 -0
- package/dist-es/commands/GetSpaceCommand.js +4 -0
- package/dist-es/commands/GetSpaceCredentialsForOrganizationCommand.js +4 -0
- package/dist-es/commands/GetTelemetryQueryResultsCommand.js +4 -0
- package/dist-es/commands/GetViewCommand.js +4 -0
- package/dist-es/commands/ListAccessGrantsCommand.js +4 -0
- package/dist-es/commands/ListAccessProfilesCommand.js +4 -0
- package/dist-es/commands/ListAlertsCommand.js +4 -0
- package/dist-es/commands/ListDomainAccessGrantsForOrganizationCommand.js +4 -0
- package/dist-es/commands/ListDomainsCommand.js +4 -0
- package/dist-es/commands/ListIntegrationsCommand.js +4 -0
- package/dist-es/commands/ListOmniDashboardsCommand.js +4 -0
- package/dist-es/commands/ListSpacesCommand.js +4 -0
- package/dist-es/commands/ListSpacesForOrganizationCommand.js +4 -0
- package/dist-es/commands/ListTelemetryFieldsCommand.js +4 -0
- package/dist-es/commands/ListTelemetryQuerySessionsCommand.js +4 -0
- package/dist-es/commands/ListViewsCommand.js +4 -0
- package/dist-es/commands/PutIntelligenceConfigurationCommand.js +4 -0
- package/dist-es/commands/SearchPrincipalsCommand.js +4 -0
- package/dist-es/commands/StartTelemetryQueryCommand.js +4 -0
- package/dist-es/commands/StartTelemetryQuerySessionCommand.js +4 -0
- package/dist-es/commands/StopTelemetryQueryCommand.js +4 -0
- package/dist-es/commands/StopTelemetryQuerySessionCommand.js +4 -0
- package/dist-es/commands/UpdateAccessProfileCommand.js +4 -0
- package/dist-es/commands/UpdateAlertCommand.js +4 -0
- package/dist-es/commands/UpdateDomainCommand.js +4 -0
- package/dist-es/commands/UpdateDomainForOrganizationCommand.js +4 -0
- package/dist-es/commands/UpdateIntegrationCommand.js +4 -0
- package/dist-es/commands/UpdateOmniDashboardCommand.js +4 -0
- package/dist-es/commands/UpdateSpaceCommand.js +4 -0
- package/dist-es/commands/UpdateViewCommand.js +4 -0
- package/dist-es/commands/index.js +61 -0
- package/dist-es/endpoint/EndpointParameters.js +11 -0
- package/dist-es/endpoint/bdd.js +29 -0
- package/dist-es/endpoint/endpointResolver.js +14 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +10 -0
- package/dist-es/models/CloudWatchOmniServiceException.js +8 -0
- package/dist-es/models/enums.js +182 -0
- package/dist-es/models/errors.js +109 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/pagination/GetContextGraphPaginator.js +4 -0
- package/dist-es/pagination/GetTelemetryQueryResultsPaginator.js +4 -0
- package/dist-es/pagination/Interfaces.js +1 -0
- package/dist-es/pagination/ListAccessGrantsPaginator.js +4 -0
- package/dist-es/pagination/ListAccessProfilesPaginator.js +4 -0
- package/dist-es/pagination/ListAlertsPaginator.js +4 -0
- package/dist-es/pagination/ListDomainAccessGrantsForOrganizationPaginator.js +4 -0
- package/dist-es/pagination/ListDomainsPaginator.js +4 -0
- package/dist-es/pagination/ListIntegrationsPaginator.js +4 -0
- package/dist-es/pagination/ListOmniDashboardsPaginator.js +4 -0
- package/dist-es/pagination/ListSpacesForOrganizationPaginator.js +4 -0
- package/dist-es/pagination/ListSpacesPaginator.js +4 -0
- package/dist-es/pagination/ListTelemetryFieldsPaginator.js +4 -0
- package/dist-es/pagination/ListTelemetryQuerySessionsPaginator.js +4 -0
- package/dist-es/pagination/ListViewsPaginator.js +4 -0
- package/dist-es/pagination/SearchPrincipalsPaginator.js +4 -0
- package/dist-es/pagination/index.js +16 -0
- package/dist-es/runtimeConfig.browser.js +29 -0
- package/dist-es/runtimeConfig.js +43 -0
- package/dist-es/runtimeConfig.native.js +9 -0
- package/dist-es/runtimeConfig.shared.js +40 -0
- package/dist-es/runtimeExtensions.js +9 -0
- package/dist-es/schemas/schemas_0.js +1807 -0
- package/dist-types/CloudWatchOmni.d.ts +562 -0
- package/dist-types/CloudWatchOmniClient.d.ts +250 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +75 -0
- package/dist-types/commandBuilder.d.ts +18 -0
- package/dist-types/commands/CreateAccessGrantCommand.d.ts +285 -0
- package/dist-types/commands/CreateAccessProfileCommand.d.ts +143 -0
- package/dist-types/commands/CreateAlertCommand.d.ts +490 -0
- package/dist-types/commands/CreateDomainAccessGrantForOrganizationCommand.d.ts +169 -0
- package/dist-types/commands/CreateDomainCommand.d.ts +174 -0
- package/dist-types/commands/CreateDomainForOrganizationCommand.d.ts +177 -0
- package/dist-types/commands/CreateIntegrationCommand.d.ts +158 -0
- package/dist-types/commands/CreateOmniDashboardCommand.d.ts +149 -0
- package/dist-types/commands/CreateOneTimeDeepLinkCodeCommand.d.ts +112 -0
- package/dist-types/commands/CreateSpaceCommand.d.ts +166 -0
- package/dist-types/commands/CreateViewCommand.d.ts +131 -0
- package/dist-types/commands/DeleteAccessGrantCommand.d.ts +100 -0
- package/dist-types/commands/DeleteAccessProfileCommand.d.ts +102 -0
- package/dist-types/commands/DeleteAlertCommand.d.ts +98 -0
- package/dist-types/commands/DeleteDomainAccessGrantForOrganizationCommand.d.ts +101 -0
- package/dist-types/commands/DeleteDomainCommand.d.ts +101 -0
- package/dist-types/commands/DeleteDomainForOrganizationCommand.d.ts +101 -0
- package/dist-types/commands/DeleteIntegrationCommand.d.ts +100 -0
- package/dist-types/commands/DeleteOmniDashboardCommand.d.ts +96 -0
- package/dist-types/commands/DeleteSpaceCommand.d.ts +94 -0
- package/dist-types/commands/DeleteViewCommand.d.ts +100 -0
- package/dist-types/commands/GetAccessGrantCommand.d.ts +192 -0
- package/dist-types/commands/GetAccessProfileCommand.d.ts +126 -0
- package/dist-types/commands/GetAlertCommand.d.ts +224 -0
- package/dist-types/commands/GetContextGraphCommand.d.ts +393 -0
- package/dist-types/commands/GetDomainAccessGrantForOrganizationCommand.d.ts +135 -0
- package/dist-types/commands/GetDomainCommand.d.ts +143 -0
- package/dist-types/commands/GetDomainForOrganizationCommand.d.ts +149 -0
- package/dist-types/commands/GetIntegrationCommand.d.ts +134 -0
- package/dist-types/commands/GetIntelligenceConfigurationCommand.d.ts +102 -0
- package/dist-types/commands/GetOmniDashboardCommand.d.ts +127 -0
- package/dist-types/commands/GetSpaceCommand.d.ts +134 -0
- package/dist-types/commands/GetSpaceCredentialsForOrganizationCommand.d.ts +125 -0
- package/dist-types/commands/GetTelemetryQueryResultsCommand.d.ts +138 -0
- package/dist-types/commands/GetViewCommand.d.ts +110 -0
- package/dist-types/commands/ListAccessGrantsCommand.d.ts +160 -0
- package/dist-types/commands/ListAccessProfilesCommand.d.ts +129 -0
- package/dist-types/commands/ListAlertsCommand.d.ts +191 -0
- package/dist-types/commands/ListDomainAccessGrantsForOrganizationCommand.d.ts +162 -0
- package/dist-types/commands/ListDomainsCommand.d.ts +131 -0
- package/dist-types/commands/ListIntegrationsCommand.d.ts +135 -0
- package/dist-types/commands/ListOmniDashboardsCommand.d.ts +139 -0
- package/dist-types/commands/ListSpacesCommand.d.ts +139 -0
- package/dist-types/commands/ListSpacesForOrganizationCommand.d.ts +138 -0
- package/dist-types/commands/ListTelemetryFieldsCommand.d.ts +137 -0
- package/dist-types/commands/ListTelemetryQuerySessionsCommand.d.ts +114 -0
- package/dist-types/commands/ListViewsCommand.d.ts +119 -0
- package/dist-types/commands/PutIntelligenceConfigurationCommand.d.ts +108 -0
- package/dist-types/commands/SearchPrincipalsCommand.d.ts +130 -0
- package/dist-types/commands/StartTelemetryQueryCommand.d.ts +106 -0
- package/dist-types/commands/StartTelemetryQuerySessionCommand.d.ts +106 -0
- package/dist-types/commands/StopTelemetryQueryCommand.d.ts +97 -0
- package/dist-types/commands/StopTelemetryQuerySessionCommand.d.ts +97 -0
- package/dist-types/commands/UpdateAccessProfileCommand.d.ts +134 -0
- package/dist-types/commands/UpdateAlertCommand.d.ts +159 -0
- package/dist-types/commands/UpdateDomainCommand.d.ts +163 -0
- package/dist-types/commands/UpdateDomainForOrganizationCommand.d.ts +167 -0
- package/dist-types/commands/UpdateIntegrationCommand.d.ts +156 -0
- package/dist-types/commands/UpdateOmniDashboardCommand.d.ts +140 -0
- package/dist-types/commands/UpdateSpaceCommand.d.ts +149 -0
- package/dist-types/commands/UpdateViewCommand.d.ts +123 -0
- package/dist-types/commands/index.d.ts +61 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +44 -0
- package/dist-types/endpoint/bdd.d.ts +2 -0
- package/dist-types/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/extensionConfiguration.d.ts +9 -0
- package/dist-types/index.d.ts +21 -0
- package/dist-types/models/CloudWatchOmniServiceException.d.ts +14 -0
- package/dist-types/models/enums.d.ts +655 -0
- package/dist-types/models/errors.d.ts +142 -0
- package/dist-types/models/models_0.d.ts +4583 -0
- package/dist-types/pagination/GetContextGraphPaginator.d.ts +7 -0
- package/dist-types/pagination/GetTelemetryQueryResultsPaginator.d.ts +7 -0
- package/dist-types/pagination/Interfaces.d.ts +8 -0
- package/dist-types/pagination/ListAccessGrantsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAccessProfilesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAlertsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDomainAccessGrantsForOrganizationPaginator.d.ts +7 -0
- package/dist-types/pagination/ListDomainsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListIntegrationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListOmniDashboardsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListSpacesForOrganizationPaginator.d.ts +7 -0
- package/dist-types/pagination/ListSpacesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListTelemetryFieldsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListTelemetryQuerySessionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListViewsPaginator.d.ts +7 -0
- package/dist-types/pagination/SearchPrincipalsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +16 -0
- package/dist-types/runtimeConfig.browser.d.ts +57 -0
- package/dist-types/runtimeConfig.d.ts +57 -0
- package/dist-types/runtimeConfig.native.d.ts +56 -0
- package/dist-types/runtimeConfig.shared.d.ts +28 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +264 -0
- package/dist-types/ts3.4/CloudWatchOmni.d.ts +1106 -0
- package/dist-types/ts3.4/CloudWatchOmniClient.d.ts +416 -0
- package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +25 -0
- package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +43 -0
- package/dist-types/ts3.4/commandBuilder.d.ts +40 -0
- package/dist-types/ts3.4/commands/CreateAccessGrantCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateAccessProfileCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateAlertCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateDomainAccessGrantForOrganizationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateDomainCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateDomainForOrganizationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateIntegrationCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateOmniDashboardCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/CreateOneTimeDeepLinkCodeCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateSpaceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateViewCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteAccessGrantCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteAccessProfileCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteAlertCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteDomainAccessGrantForOrganizationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteDomainCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteDomainForOrganizationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteIntegrationCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteOmniDashboardCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteSpaceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/DeleteViewCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetAccessGrantCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetAccessProfileCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetAlertCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetContextGraphCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetDomainAccessGrantForOrganizationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetDomainCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetDomainForOrganizationCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/GetIntegrationCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetIntelligenceConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetOmniDashboardCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetSpaceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/GetSpaceCredentialsForOrganizationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetTelemetryQueryResultsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetViewCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListAccessGrantsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListAccessProfilesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListAlertsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListDomainAccessGrantsForOrganizationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListDomainsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListIntegrationsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListOmniDashboardsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListSpacesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListSpacesForOrganizationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListTelemetryFieldsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListTelemetryQuerySessionsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListViewsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/PutIntelligenceConfigurationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/SearchPrincipalsCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/StartTelemetryQueryCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/StartTelemetryQuerySessionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StopTelemetryQueryCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/StopTelemetryQuerySessionCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateAccessProfileCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateAlertCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateDomainCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateDomainForOrganizationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateIntegrationCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateOmniDashboardCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateSpaceCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/UpdateViewCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +61 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
- package/dist-types/ts3.4/endpoint/bdd.d.ts +2 -0
- package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/ts3.4/extensionConfiguration.d.ts +10 -0
- package/dist-types/ts3.4/index.d.ts +13 -0
- package/dist-types/ts3.4/models/CloudWatchOmniServiceException.d.ts +9 -0
- package/dist-types/ts3.4/models/enums.d.ts +223 -0
- package/dist-types/ts3.4/models/errors.d.ts +51 -0
- package/dist-types/ts3.4/models/models_0.d.ts +1116 -0
- package/dist-types/ts3.4/pagination/GetContextGraphPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/GetTelemetryQueryResultsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/Interfaces.d.ts +5 -0
- package/dist-types/ts3.4/pagination/ListAccessGrantsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAccessProfilesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAlertsPaginator.d.ts +8 -0
- package/dist-types/ts3.4/pagination/ListDomainAccessGrantsForOrganizationPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListDomainsPaginator.d.ts +8 -0
- package/dist-types/ts3.4/pagination/ListIntegrationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListOmniDashboardsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListSpacesForOrganizationPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListSpacesPaginator.d.ts +8 -0
- package/dist-types/ts3.4/pagination/ListTelemetryFieldsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListTelemetryQuerySessionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListViewsPaginator.d.ts +8 -0
- package/dist-types/ts3.4/pagination/SearchPrincipalsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +16 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +93 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +95 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +97 -0
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +31 -0
- package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +264 -0
- package/package.json +69 -0
|
@@ -0,0 +1,4583 @@
|
|
|
1
|
+
import type { AccessGrantPermission, AccessGrantPrincipalType, AccessGrantType, AccessProfileType, AlertSortField, AlertSortOrder, AlertState, AssumeStatus, AuthType, Comparator, DomainStatus, EdgeType, EncryptionStrategy, IdentityProvider, IntegrationStatus, IntegrationType, NodeCategory, NodeType, NotificationStatus, NotificationTargetType, OrganizationCredentialType, OrganizationGrantPermission, OrganizationGrantPrincipalType, PrincipalType, QueryLanguage, QueryStatus, RowScopeOperator, Scope, Signal, SignalType, Source, SpaceStatus, TelemetryType, ThresholdMode, ViewType } from "./enums";
|
|
2
|
+
/**
|
|
3
|
+
* A single attribute condition used to match principals for attribute-based
|
|
4
|
+
* access.
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface AccessGrantPrincipalAttribute {
|
|
8
|
+
/**
|
|
9
|
+
* The Identity Center user attribute to match on. One of userName, active,
|
|
10
|
+
* userStatus, displayName, email, name.givenName, name.familyName,
|
|
11
|
+
* enterprise.department, enterprise.division, enterprise.organization,
|
|
12
|
+
* enterprise.costCenter, or enterprise.employeeNumber. Each key may appear
|
|
13
|
+
* only once per grant.
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
key: string | undefined;
|
|
17
|
+
/**
|
|
18
|
+
* The attribute value.
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
value: string | undefined;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* The principal receiving the grant. Specify principalId, principalAttributes,
|
|
25
|
+
* or both.
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
export interface AccessGrantPrincipal {
|
|
29
|
+
/**
|
|
30
|
+
* The type of principal receiving the grant.
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
principalType: AccessGrantPrincipalType | undefined;
|
|
34
|
+
/**
|
|
35
|
+
* The ID of the principal receiving the grant.
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
principalId?: string | undefined;
|
|
39
|
+
/**
|
|
40
|
+
* Attribute conditions for attribute-based access. When provided, the grant
|
|
41
|
+
* targets any principal matching all specified conditions. Supported only for
|
|
42
|
+
* IDC_USER principals.
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
principalAttributes?: AccessGrantPrincipalAttribute[] | undefined;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* A single additive row-level filter on an AccessGrant. A row is visible when
|
|
49
|
+
* its value for the given field matches the filter's values. Row filters are
|
|
50
|
+
* additive: the visible rows are the union of all row filters across a
|
|
51
|
+
* principal's matching grants.
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
export interface RowScope {
|
|
55
|
+
/**
|
|
56
|
+
* The field (column) the allowlist applies to (e.g., "serviceName", "accountId").
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
field: string | undefined;
|
|
60
|
+
/**
|
|
61
|
+
* Match operator applied to this filter's values.
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
operator: RowScopeOperator | undefined;
|
|
65
|
+
/**
|
|
66
|
+
* The values the field is matched against.
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
values: string[] | undefined;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* A single resource scope entry within an AccessGrant. Associates a resource
|
|
73
|
+
* type with optional ARN patterns, tag conditions, and row-level filters.
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
export interface ResourceScope {
|
|
77
|
+
/**
|
|
78
|
+
* Resource type name (e.g., "DataSet", "OmniDashboard").
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
resourceType: string | undefined;
|
|
82
|
+
/**
|
|
83
|
+
* Specific resource ARNs or ARN patterns. When set, actions are limited to
|
|
84
|
+
* these resources. When absent, defaults to "*".
|
|
85
|
+
* @public
|
|
86
|
+
*/
|
|
87
|
+
resourceArns?: string[] | undefined;
|
|
88
|
+
/**
|
|
89
|
+
* Tag-based conditions for dynamic resource scoping. Access applies only to
|
|
90
|
+
* resources carrying all of the specified tag key/value pairs.
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
tags?: Record<string, string> | undefined;
|
|
94
|
+
/**
|
|
95
|
+
* Signal types this scope's row filtering applies to.
|
|
96
|
+
* Required when rowScopeGroups is set.
|
|
97
|
+
* @public
|
|
98
|
+
*/
|
|
99
|
+
signalTypes?: SignalType[] | undefined;
|
|
100
|
+
/**
|
|
101
|
+
* Row-level filters for this scope, as an OR of AND-groups: a row is visible
|
|
102
|
+
* when it matches every filter in any one group. Requires signalTypes.
|
|
103
|
+
*
|
|
104
|
+
* Row filters are additive across a principal's matching grants. A signal type
|
|
105
|
+
* with no matching group is unrestricted, and when rowScopeGroups is omitted
|
|
106
|
+
* all rows are visible for all signal types.
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
rowScopeGroups?: RowScope[][] | undefined;
|
|
110
|
+
}
|
|
111
|
+
/**
|
|
112
|
+
* A group of actions within an access grant, together with the resource scopes
|
|
113
|
+
* and context conditions that apply to exactly those actions.
|
|
114
|
+
* @public
|
|
115
|
+
*/
|
|
116
|
+
export interface ScopedActions {
|
|
117
|
+
/**
|
|
118
|
+
* The actions this group applies to.
|
|
119
|
+
* @public
|
|
120
|
+
*/
|
|
121
|
+
actions: string[] | undefined;
|
|
122
|
+
/**
|
|
123
|
+
* Optional resource scopes constraining these actions to specific resources.
|
|
124
|
+
* @public
|
|
125
|
+
*/
|
|
126
|
+
resources?: ResourceScope[] | undefined;
|
|
127
|
+
/**
|
|
128
|
+
* Optional context conditions for fine-grained access control on these actions.
|
|
129
|
+
* @public
|
|
130
|
+
*/
|
|
131
|
+
contextConditions?: Record<string, string[]> | undefined;
|
|
132
|
+
}
|
|
133
|
+
/**
|
|
134
|
+
* Full AccessGrant structure returned by API operations.
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
export interface AccessGrant {
|
|
138
|
+
/**
|
|
139
|
+
* The unique ID of the access grant.
|
|
140
|
+
* @public
|
|
141
|
+
*/
|
|
142
|
+
grantId: string | undefined;
|
|
143
|
+
/**
|
|
144
|
+
* The Amazon Resource Name (ARN) of the access grant.
|
|
145
|
+
* @public
|
|
146
|
+
*/
|
|
147
|
+
grantArn: string | undefined;
|
|
148
|
+
/**
|
|
149
|
+
* A name that identifies the access grant.
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
name?: string | undefined;
|
|
153
|
+
/**
|
|
154
|
+
* The AWS account ID that owns the grant.
|
|
155
|
+
* @public
|
|
156
|
+
*/
|
|
157
|
+
accountId: string | undefined;
|
|
158
|
+
/**
|
|
159
|
+
* The ID of the domain the grant belongs to.
|
|
160
|
+
* @public
|
|
161
|
+
*/
|
|
162
|
+
domainId: string | undefined;
|
|
163
|
+
/**
|
|
164
|
+
* The principal receiving the grant.
|
|
165
|
+
* @public
|
|
166
|
+
*/
|
|
167
|
+
principal: AccessGrantPrincipal | undefined;
|
|
168
|
+
/**
|
|
169
|
+
* The permission granted.
|
|
170
|
+
* @public
|
|
171
|
+
*/
|
|
172
|
+
permission: AccessGrantPermission | undefined;
|
|
173
|
+
/**
|
|
174
|
+
* Who manages the grant.
|
|
175
|
+
* @public
|
|
176
|
+
*/
|
|
177
|
+
grantType: AccessGrantType | undefined;
|
|
178
|
+
/**
|
|
179
|
+
* The principal that created the grant.
|
|
180
|
+
* @public
|
|
181
|
+
*/
|
|
182
|
+
createdBy: string | undefined;
|
|
183
|
+
/**
|
|
184
|
+
* The timestamp when the grant was created.
|
|
185
|
+
* @public
|
|
186
|
+
*/
|
|
187
|
+
createdAt: Date | undefined;
|
|
188
|
+
/**
|
|
189
|
+
* The timestamp when the grant was last updated.
|
|
190
|
+
* @public
|
|
191
|
+
*/
|
|
192
|
+
updatedAt: Date | undefined;
|
|
193
|
+
/**
|
|
194
|
+
* The space this grant applies to. Domain-scoped grants are returned by
|
|
195
|
+
* ListDomainAccessGrantsForOrganization instead.
|
|
196
|
+
* @public
|
|
197
|
+
*/
|
|
198
|
+
spaceId: string | undefined;
|
|
199
|
+
/**
|
|
200
|
+
* Groups of actions allowed by the grant, each with the resource scopes and
|
|
201
|
+
* conditions that limit those actions.
|
|
202
|
+
* @public
|
|
203
|
+
*/
|
|
204
|
+
scopedActions?: ScopedActions[] | undefined;
|
|
205
|
+
}
|
|
206
|
+
/**
|
|
207
|
+
* Summary of an AccessGrant. Call GetAccessGrant for the full grant.
|
|
208
|
+
* @public
|
|
209
|
+
*/
|
|
210
|
+
export interface AccessGrantSummary {
|
|
211
|
+
/**
|
|
212
|
+
* The unique ID of the access grant.
|
|
213
|
+
* @public
|
|
214
|
+
*/
|
|
215
|
+
grantId: string | undefined;
|
|
216
|
+
/**
|
|
217
|
+
* The Amazon Resource Name (ARN) of the access grant.
|
|
218
|
+
* @public
|
|
219
|
+
*/
|
|
220
|
+
grantArn: string | undefined;
|
|
221
|
+
/**
|
|
222
|
+
* A name that identifies the access grant.
|
|
223
|
+
* @public
|
|
224
|
+
*/
|
|
225
|
+
name?: string | undefined;
|
|
226
|
+
/**
|
|
227
|
+
* The ID of the domain the grant belongs to.
|
|
228
|
+
* @public
|
|
229
|
+
*/
|
|
230
|
+
domainId: string | undefined;
|
|
231
|
+
/**
|
|
232
|
+
* The principal receiving the grant.
|
|
233
|
+
* @public
|
|
234
|
+
*/
|
|
235
|
+
principal: AccessGrantPrincipal | undefined;
|
|
236
|
+
/**
|
|
237
|
+
* The permission granted.
|
|
238
|
+
* @public
|
|
239
|
+
*/
|
|
240
|
+
permission: AccessGrantPermission | undefined;
|
|
241
|
+
/**
|
|
242
|
+
* Who manages the grant.
|
|
243
|
+
* @public
|
|
244
|
+
*/
|
|
245
|
+
grantType: AccessGrantType | undefined;
|
|
246
|
+
/**
|
|
247
|
+
* The space this grant applies to. Domain-scoped grants are returned by
|
|
248
|
+
* ListDomainAccessGrantsForOrganization instead.
|
|
249
|
+
* @public
|
|
250
|
+
*/
|
|
251
|
+
spaceId: string | undefined;
|
|
252
|
+
}
|
|
253
|
+
/**
|
|
254
|
+
* An Access Profile.
|
|
255
|
+
* @public
|
|
256
|
+
*/
|
|
257
|
+
export interface AccessProfile {
|
|
258
|
+
/**
|
|
259
|
+
* The unique ID of the access profile.
|
|
260
|
+
* @public
|
|
261
|
+
*/
|
|
262
|
+
profileId: string | undefined;
|
|
263
|
+
/**
|
|
264
|
+
* The ID of the space the profile belongs to.
|
|
265
|
+
* @public
|
|
266
|
+
*/
|
|
267
|
+
spaceId: string | undefined;
|
|
268
|
+
/**
|
|
269
|
+
* The ARN of this access profile.
|
|
270
|
+
* @public
|
|
271
|
+
*/
|
|
272
|
+
arn: string | undefined;
|
|
273
|
+
/**
|
|
274
|
+
* A name that identifies the access profile.
|
|
275
|
+
* @public
|
|
276
|
+
*/
|
|
277
|
+
name: string | undefined;
|
|
278
|
+
/**
|
|
279
|
+
* An optional description of the access profile.
|
|
280
|
+
* @public
|
|
281
|
+
*/
|
|
282
|
+
description?: string | undefined;
|
|
283
|
+
/**
|
|
284
|
+
* The timestamp when the access profile was created.
|
|
285
|
+
* @public
|
|
286
|
+
*/
|
|
287
|
+
createdAt: Date | undefined;
|
|
288
|
+
/**
|
|
289
|
+
* The timestamp when the access profile was last updated.
|
|
290
|
+
* @public
|
|
291
|
+
*/
|
|
292
|
+
updatedAt: Date | undefined;
|
|
293
|
+
/**
|
|
294
|
+
* The calling principal's authorization to assume this access profile.
|
|
295
|
+
* @public
|
|
296
|
+
*/
|
|
297
|
+
assumeStatus?: AssumeStatus | undefined;
|
|
298
|
+
/**
|
|
299
|
+
* Who manages the access profile.
|
|
300
|
+
* @public
|
|
301
|
+
*/
|
|
302
|
+
profileType?: AccessProfileType | undefined;
|
|
303
|
+
}
|
|
304
|
+
/**
|
|
305
|
+
* Summary of an access profile. Call GetAccessProfile for the full profile.
|
|
306
|
+
* @public
|
|
307
|
+
*/
|
|
308
|
+
export interface AccessProfileSummary {
|
|
309
|
+
/**
|
|
310
|
+
* The unique ID of the access profile.
|
|
311
|
+
* @public
|
|
312
|
+
*/
|
|
313
|
+
profileId: string | undefined;
|
|
314
|
+
/**
|
|
315
|
+
* The ARN of this access profile.
|
|
316
|
+
* @public
|
|
317
|
+
*/
|
|
318
|
+
arn: string | undefined;
|
|
319
|
+
/**
|
|
320
|
+
* A name that identifies the access profile.
|
|
321
|
+
* @public
|
|
322
|
+
*/
|
|
323
|
+
name: string | undefined;
|
|
324
|
+
/**
|
|
325
|
+
* An optional description of the access profile.
|
|
326
|
+
* @public
|
|
327
|
+
*/
|
|
328
|
+
description?: string | undefined;
|
|
329
|
+
/**
|
|
330
|
+
* Who manages the access profile.
|
|
331
|
+
* @public
|
|
332
|
+
*/
|
|
333
|
+
profileType?: AccessProfileType | undefined;
|
|
334
|
+
}
|
|
335
|
+
/**
|
|
336
|
+
* The destination for a notification.
|
|
337
|
+
* @public
|
|
338
|
+
*/
|
|
339
|
+
export interface NotificationTarget {
|
|
340
|
+
/**
|
|
341
|
+
* The type of notification target.
|
|
342
|
+
* @public
|
|
343
|
+
*/
|
|
344
|
+
type: NotificationTargetType | undefined;
|
|
345
|
+
/**
|
|
346
|
+
* The Amazon Resource Name (ARN) of the notification target. For \{@code slack\} and
|
|
347
|
+
* \{@code pagerduty\}, an integration ARN as returned by \{@code ListIntegrations\}.
|
|
348
|
+
* @public
|
|
349
|
+
*/
|
|
350
|
+
arn: string | undefined;
|
|
351
|
+
/**
|
|
352
|
+
* Additional target-specific metadata.
|
|
353
|
+
* @public
|
|
354
|
+
*/
|
|
355
|
+
metadata?: Record<string, string> | undefined;
|
|
356
|
+
}
|
|
357
|
+
/**
|
|
358
|
+
* Trigger conditions for a notification rule. \{@code stateValues\} entries
|
|
359
|
+
* combine with OR semantics; empty / omitted = any state.
|
|
360
|
+
* @public
|
|
361
|
+
*/
|
|
362
|
+
export interface NotificationTrigger {
|
|
363
|
+
/**
|
|
364
|
+
* Alert state(s) that trigger this rule. Empty / omitted = any state.
|
|
365
|
+
* @public
|
|
366
|
+
*/
|
|
367
|
+
stateValues?: AlertState[] | undefined;
|
|
368
|
+
}
|
|
369
|
+
/**
|
|
370
|
+
* Single notification rule: which transitions trigger this rule and
|
|
371
|
+
* where the resulting notification should be sent.
|
|
372
|
+
* @public
|
|
373
|
+
*/
|
|
374
|
+
export interface NotificationRule {
|
|
375
|
+
/**
|
|
376
|
+
* The conditions that trigger this notification rule.
|
|
377
|
+
* @public
|
|
378
|
+
*/
|
|
379
|
+
trigger: NotificationTrigger | undefined;
|
|
380
|
+
/**
|
|
381
|
+
* The destination for notifications from this rule.
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
384
|
+
target: NotificationTarget | undefined;
|
|
385
|
+
}
|
|
386
|
+
/**
|
|
387
|
+
* The condition that determines when the alert fires.
|
|
388
|
+
*
|
|
389
|
+
* On UpdateAlert a supplied condition is replaced whole, not merged: an omitted
|
|
390
|
+
* \{@code warningThreshold\} or \{@code criticalThreshold\} removes that tier, and an
|
|
391
|
+
* omitted \{@code thresholdField\} clears it. A condition must keep at least one
|
|
392
|
+
* tier. \{@code thresholdMode\} and \{@code comparator\} are optional at the Smithy
|
|
393
|
+
* level (so a single-tier condition is expressible) but are required whenever a
|
|
394
|
+
* threshold is present; enforced by the service-side validator.
|
|
395
|
+
* @public
|
|
396
|
+
*/
|
|
397
|
+
export interface AlertCondition {
|
|
398
|
+
/**
|
|
399
|
+
* How the threshold is applied to query results.
|
|
400
|
+
* @public
|
|
401
|
+
*/
|
|
402
|
+
thresholdMode?: ThresholdMode | undefined;
|
|
403
|
+
/**
|
|
404
|
+
* The field the threshold is evaluated against.
|
|
405
|
+
* @public
|
|
406
|
+
*/
|
|
407
|
+
thresholdField?: string | undefined;
|
|
408
|
+
/**
|
|
409
|
+
* The comparison operator applied to the threshold.
|
|
410
|
+
* @public
|
|
411
|
+
*/
|
|
412
|
+
comparator?: Comparator | undefined;
|
|
413
|
+
/**
|
|
414
|
+
* The value at which the alert enters the WARNING state.
|
|
415
|
+
* @public
|
|
416
|
+
*/
|
|
417
|
+
warningThreshold?: number | undefined;
|
|
418
|
+
/**
|
|
419
|
+
* The value at which the alert enters the CRITICAL state.
|
|
420
|
+
* @public
|
|
421
|
+
*/
|
|
422
|
+
criticalThreshold?: number | undefined;
|
|
423
|
+
}
|
|
424
|
+
/**
|
|
425
|
+
* Evaluation cadence. \{@code intervalSeconds\} must be one of
|
|
426
|
+
* \{30, 60, 120, 300, 600, 900, 1800, 3600\}; \{@code pendingDurationSeconds\} and
|
|
427
|
+
* \{@code recoveryDurationSeconds\} must be multiples of \{@code intervalSeconds\}.
|
|
428
|
+
* A duration of 0 means fire/clear immediately with no delay.
|
|
429
|
+
*
|
|
430
|
+
* On UpdateAlert a supplied evaluation block is replaced whole, not merged: an
|
|
431
|
+
* omitted \{@code pendingDurationSeconds\} or \{@code recoveryDurationSeconds\} is
|
|
432
|
+
* cleared to unset (no such duration), not preserved and not defaulted to 0.
|
|
433
|
+
* \{@code intervalSeconds\} is required whenever the block is present. All enforced
|
|
434
|
+
* server-side / by the front-door validator.
|
|
435
|
+
* @public
|
|
436
|
+
*/
|
|
437
|
+
export interface AlertEvaluation {
|
|
438
|
+
/**
|
|
439
|
+
* The interval between evaluations, in seconds.
|
|
440
|
+
* @public
|
|
441
|
+
*/
|
|
442
|
+
intervalSeconds: number | undefined;
|
|
443
|
+
/**
|
|
444
|
+
* The duration a breach must persist before the alert fires, in seconds.
|
|
445
|
+
* @public
|
|
446
|
+
*/
|
|
447
|
+
pendingDurationSeconds?: number | undefined;
|
|
448
|
+
/**
|
|
449
|
+
* The duration a recovery must persist before the alert clears, in seconds.
|
|
450
|
+
* @public
|
|
451
|
+
*/
|
|
452
|
+
recoveryDurationSeconds?: number | undefined;
|
|
453
|
+
}
|
|
454
|
+
/**
|
|
455
|
+
* Configures how the alert reacts when an evaluation produces no
|
|
456
|
+
* data. \{@code treatAs\} carries the resulting state; defaults to
|
|
457
|
+
* \{@code NODATA\} when omitted.
|
|
458
|
+
* @public
|
|
459
|
+
*/
|
|
460
|
+
export interface NoData {
|
|
461
|
+
/**
|
|
462
|
+
* The state to report when an evaluation produces no data.
|
|
463
|
+
* @public
|
|
464
|
+
*/
|
|
465
|
+
treatAs: AlertState | undefined;
|
|
466
|
+
}
|
|
467
|
+
/**
|
|
468
|
+
* Query expression and the language it's written in.
|
|
469
|
+
* @public
|
|
470
|
+
*/
|
|
471
|
+
export interface AlertRuleQuery {
|
|
472
|
+
/**
|
|
473
|
+
* The query language of the expression.
|
|
474
|
+
* @public
|
|
475
|
+
*/
|
|
476
|
+
language: QueryLanguage | undefined;
|
|
477
|
+
/**
|
|
478
|
+
* The query expression to evaluate.
|
|
479
|
+
* @public
|
|
480
|
+
*/
|
|
481
|
+
expression: string | undefined;
|
|
482
|
+
}
|
|
483
|
+
/**
|
|
484
|
+
* Telemetry-based rule: what to query, how to evaluate the result, what
|
|
485
|
+
* condition makes it fire, and what to do on missing data.
|
|
486
|
+
* @public
|
|
487
|
+
*/
|
|
488
|
+
export interface TelemetryRule {
|
|
489
|
+
/**
|
|
490
|
+
* The query expression to evaluate.
|
|
491
|
+
* @public
|
|
492
|
+
*/
|
|
493
|
+
query?: AlertRuleQuery | undefined;
|
|
494
|
+
/**
|
|
495
|
+
* The condition that determines when the alert fires.
|
|
496
|
+
* @public
|
|
497
|
+
*/
|
|
498
|
+
condition?: AlertCondition | undefined;
|
|
499
|
+
/**
|
|
500
|
+
* The evaluation cadence and durations.
|
|
501
|
+
* @public
|
|
502
|
+
*/
|
|
503
|
+
evaluation?: AlertEvaluation | undefined;
|
|
504
|
+
/**
|
|
505
|
+
* How the alert behaves when a query produces no data.
|
|
506
|
+
* @public
|
|
507
|
+
*/
|
|
508
|
+
noData?: NoData | undefined;
|
|
509
|
+
}
|
|
510
|
+
/**
|
|
511
|
+
* Top-level rule definition.
|
|
512
|
+
*
|
|
513
|
+
* \{@code telemetryRule\} members are optional at the Smithy level to support
|
|
514
|
+
* PATCH semantics on UpdateAlert (send only the sub-blocks you want to
|
|
515
|
+
* change). On CreateAlert, presence is enforced by the service-side validator.
|
|
516
|
+
* @public
|
|
517
|
+
*/
|
|
518
|
+
export type Rule = Rule.TelemetryRuleMember | Rule.$UnknownMember;
|
|
519
|
+
/**
|
|
520
|
+
* @public
|
|
521
|
+
*/
|
|
522
|
+
export declare namespace Rule {
|
|
523
|
+
/**
|
|
524
|
+
* The telemetry-based rule definition.
|
|
525
|
+
* @public
|
|
526
|
+
*/
|
|
527
|
+
interface TelemetryRuleMember {
|
|
528
|
+
telemetryRule: TelemetryRule;
|
|
529
|
+
$unknown?: never;
|
|
530
|
+
}
|
|
531
|
+
/**
|
|
532
|
+
* @public
|
|
533
|
+
*/
|
|
534
|
+
interface $UnknownMember {
|
|
535
|
+
telemetryRule?: never;
|
|
536
|
+
$unknown: [string, any];
|
|
537
|
+
}
|
|
538
|
+
/**
|
|
539
|
+
* @deprecated unused in schema-serde mode.
|
|
540
|
+
*
|
|
541
|
+
*/
|
|
542
|
+
interface Visitor<T> {
|
|
543
|
+
telemetryRule: (value: TelemetryRule) => T;
|
|
544
|
+
_: (name: string, value: any) => T;
|
|
545
|
+
}
|
|
546
|
+
}
|
|
547
|
+
/**
|
|
548
|
+
* Counts of contributors currently breaching each severity threshold.
|
|
549
|
+
* @public
|
|
550
|
+
*/
|
|
551
|
+
export interface ContributorSummary {
|
|
552
|
+
/**
|
|
553
|
+
* Number of contributors currently breaching the warning threshold.
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
warningCount?: number | undefined;
|
|
557
|
+
/**
|
|
558
|
+
* Number of contributors currently breaching the critical threshold.
|
|
559
|
+
* @public
|
|
560
|
+
*/
|
|
561
|
+
criticalCount?: number | undefined;
|
|
562
|
+
}
|
|
563
|
+
/**
|
|
564
|
+
* Structured detail about the current evaluation.
|
|
565
|
+
* @public
|
|
566
|
+
*/
|
|
567
|
+
export interface AlertStateData {
|
|
568
|
+
/**
|
|
569
|
+
* For COUNT_OF_RESULTS alerts, the row count that breached; null for
|
|
570
|
+
* FIELD_VALUE (multi-contributor) alerts.
|
|
571
|
+
* @public
|
|
572
|
+
*/
|
|
573
|
+
thresholdBreached?: number | undefined;
|
|
574
|
+
}
|
|
575
|
+
/**
|
|
576
|
+
* Live evaluation state for an alert. Read-only, system-managed.
|
|
577
|
+
* @public
|
|
578
|
+
*/
|
|
579
|
+
export interface AlertStateInfo {
|
|
580
|
+
/**
|
|
581
|
+
* Current flat state.
|
|
582
|
+
* @public
|
|
583
|
+
*/
|
|
584
|
+
value: AlertState | undefined;
|
|
585
|
+
/**
|
|
586
|
+
* When the alert transitioned to its current state.
|
|
587
|
+
* @public
|
|
588
|
+
*/
|
|
589
|
+
transitionedAt?: Date | undefined;
|
|
590
|
+
/**
|
|
591
|
+
* Counts of contributors currently breaching each severity threshold.
|
|
592
|
+
* Present only when contributor-level tracking is active; absent until
|
|
593
|
+
* the first contributor breaches a \{@code WARNING\} or \{@code CRITICAL\}
|
|
594
|
+
* threshold.
|
|
595
|
+
* @public
|
|
596
|
+
*/
|
|
597
|
+
contributorSummary?: ContributorSummary | undefined;
|
|
598
|
+
/**
|
|
599
|
+
* Structured detail about why the alert is in its current state.
|
|
600
|
+
* @public
|
|
601
|
+
*/
|
|
602
|
+
data?: AlertStateData | undefined;
|
|
603
|
+
}
|
|
604
|
+
/**
|
|
605
|
+
* Full alert entity, returned by both CreateAlert and GetAlert. A create and a read of the
|
|
606
|
+
* same alert describe it identically except for \{@code state\}, which only the read paths
|
|
607
|
+
* populate. UpdateAlert returns an empty response.
|
|
608
|
+
* @public
|
|
609
|
+
*/
|
|
610
|
+
export interface Alert {
|
|
611
|
+
/**
|
|
612
|
+
* The name of the alert.
|
|
613
|
+
* @public
|
|
614
|
+
*/
|
|
615
|
+
name: string | undefined;
|
|
616
|
+
/**
|
|
617
|
+
* The stable alert identifier (see \{@link AlertId\}), minted on create and
|
|
618
|
+
* immutable across updates. Use it (not \{@code name\}) to address the alert
|
|
619
|
+
* on GetAlert/UpdateAlert/DeleteAlert; it is also the ARN's resource id.
|
|
620
|
+
* @public
|
|
621
|
+
*/
|
|
622
|
+
alertId?: string | undefined;
|
|
623
|
+
/**
|
|
624
|
+
* An optional description of the alert.
|
|
625
|
+
* @public
|
|
626
|
+
*/
|
|
627
|
+
description?: string | undefined;
|
|
628
|
+
/**
|
|
629
|
+
* The AWS account ID that owns the alert.
|
|
630
|
+
* @public
|
|
631
|
+
*/
|
|
632
|
+
accountId: string | undefined;
|
|
633
|
+
/**
|
|
634
|
+
* The ID of the space the alert belongs to.
|
|
635
|
+
* @public
|
|
636
|
+
*/
|
|
637
|
+
spaceId?: string | undefined;
|
|
638
|
+
/**
|
|
639
|
+
* The ID of the access profile associated with the alert.
|
|
640
|
+
* @public
|
|
641
|
+
*/
|
|
642
|
+
profileId?: string | undefined;
|
|
643
|
+
/**
|
|
644
|
+
* The rule that defines how the alert is evaluated.
|
|
645
|
+
* @public
|
|
646
|
+
*/
|
|
647
|
+
rule: Rule | undefined;
|
|
648
|
+
/**
|
|
649
|
+
* Whether notifications are enabled.
|
|
650
|
+
* @public
|
|
651
|
+
*/
|
|
652
|
+
notificationStatus?: NotificationStatus | undefined;
|
|
653
|
+
/**
|
|
654
|
+
* Live evaluation state (read-only, system-managed). Populated by GetAlert. ListAlerts
|
|
655
|
+
* reports state on `AlertSummary` instead, where it stays required.
|
|
656
|
+
*
|
|
657
|
+
* Absent on CreateAlert: a newly created alert has never been evaluated, so any state
|
|
658
|
+
* reported there would be a default rather than an observation. Call GetAlert for live
|
|
659
|
+
* state. Not @required for that reason — GetAlert always populates it.
|
|
660
|
+
*
|
|
661
|
+
* `contributorSummary` is nested inside this member, so it too is absent on CreateAlert.
|
|
662
|
+
* @public
|
|
663
|
+
*/
|
|
664
|
+
state?: AlertStateInfo | undefined;
|
|
665
|
+
/**
|
|
666
|
+
* The notification rules for the alert.
|
|
667
|
+
* @public
|
|
668
|
+
*/
|
|
669
|
+
notificationRules?: NotificationRule[] | undefined;
|
|
670
|
+
/**
|
|
671
|
+
* The timestamp when the alert was created.
|
|
672
|
+
* @public
|
|
673
|
+
*/
|
|
674
|
+
createdAt: Date | undefined;
|
|
675
|
+
/**
|
|
676
|
+
* The timestamp when the alert was last updated.
|
|
677
|
+
* @public
|
|
678
|
+
*/
|
|
679
|
+
updatedAt: Date | undefined;
|
|
680
|
+
/**
|
|
681
|
+
* The Amazon Resource Name (ARN) of the alert.
|
|
682
|
+
* @public
|
|
683
|
+
*/
|
|
684
|
+
alertArn: string | undefined;
|
|
685
|
+
}
|
|
686
|
+
/**
|
|
687
|
+
* Filter criteria for ListAlerts. All members are optional; each omitted
|
|
688
|
+
* member is unconstrained. At most one of \{@code names\}, \{@code namePrefix\},
|
|
689
|
+
* \{@code ids\} may be provided (mutually exclusive; the service rejects more
|
|
690
|
+
* than one). The remaining members combine with AND.
|
|
691
|
+
* @public
|
|
692
|
+
*/
|
|
693
|
+
export interface AlertFilterCriteria {
|
|
694
|
+
/**
|
|
695
|
+
* Filter to alerts whose name exactly matches any entry (OR semantics).
|
|
696
|
+
* Mutually exclusive with \{@code namePrefix\} and \{@code ids\}.
|
|
697
|
+
* @public
|
|
698
|
+
*/
|
|
699
|
+
names?: string[] | undefined;
|
|
700
|
+
/**
|
|
701
|
+
* Filter to alerts whose name starts with this prefix. Mutually exclusive
|
|
702
|
+
* with \{@code names\} and \{@code ids\}.
|
|
703
|
+
* @public
|
|
704
|
+
*/
|
|
705
|
+
namePrefix?: string | undefined;
|
|
706
|
+
/**
|
|
707
|
+
* Filter to alerts whose \{@link AlertId\} exactly matches any entry (OR
|
|
708
|
+
* semantics). Mutually exclusive with \{@code names\} and \{@code namePrefix\}.
|
|
709
|
+
* @public
|
|
710
|
+
*/
|
|
711
|
+
ids?: string[] | undefined;
|
|
712
|
+
/**
|
|
713
|
+
* Filter to alerts currently in any of these states (OR semantics).
|
|
714
|
+
* @public
|
|
715
|
+
*/
|
|
716
|
+
stateValue?: AlertState[] | undefined;
|
|
717
|
+
/**
|
|
718
|
+
* Filter to alerts by whether notifications are enabled.
|
|
719
|
+
* @public
|
|
720
|
+
*/
|
|
721
|
+
notificationsEnabled?: boolean | undefined;
|
|
722
|
+
}
|
|
723
|
+
/**
|
|
724
|
+
* Summary representation of an alert used in list responses.
|
|
725
|
+
* @public
|
|
726
|
+
*/
|
|
727
|
+
export interface AlertSummary {
|
|
728
|
+
/**
|
|
729
|
+
* The name of the alert.
|
|
730
|
+
* @public
|
|
731
|
+
*/
|
|
732
|
+
name: string | undefined;
|
|
733
|
+
/**
|
|
734
|
+
* The stable alert identifier (see \{@link Alert#alertId\}). Use it to address
|
|
735
|
+
* the alert; it is also the ARN's resource id.
|
|
736
|
+
* @public
|
|
737
|
+
*/
|
|
738
|
+
alertId?: string | undefined;
|
|
739
|
+
/**
|
|
740
|
+
* The ID of the space the alert belongs to.
|
|
741
|
+
* @public
|
|
742
|
+
*/
|
|
743
|
+
spaceId?: string | undefined;
|
|
744
|
+
/**
|
|
745
|
+
* The ID of the access profile associated with the alert.
|
|
746
|
+
* @public
|
|
747
|
+
*/
|
|
748
|
+
profileId?: string | undefined;
|
|
749
|
+
/**
|
|
750
|
+
* Whether notifications are enabled.
|
|
751
|
+
* @public
|
|
752
|
+
*/
|
|
753
|
+
notificationStatus?: NotificationStatus | undefined;
|
|
754
|
+
/**
|
|
755
|
+
* Live evaluation state (read-only, system-managed).
|
|
756
|
+
* @public
|
|
757
|
+
*/
|
|
758
|
+
state: AlertStateInfo | undefined;
|
|
759
|
+
/**
|
|
760
|
+
* The timestamp when the alert was created.
|
|
761
|
+
* @public
|
|
762
|
+
*/
|
|
763
|
+
createdAt: Date | undefined;
|
|
764
|
+
/**
|
|
765
|
+
* The timestamp when the alert was last updated.
|
|
766
|
+
* @public
|
|
767
|
+
*/
|
|
768
|
+
updatedAt: Date | undefined;
|
|
769
|
+
/**
|
|
770
|
+
* The Amazon Resource Name (ARN) of the alert.
|
|
771
|
+
* @public
|
|
772
|
+
*/
|
|
773
|
+
alertArn: string | undefined;
|
|
774
|
+
}
|
|
775
|
+
/**
|
|
776
|
+
* An API key used to authenticate an integration with its external system.
|
|
777
|
+
* @public
|
|
778
|
+
*/
|
|
779
|
+
export interface ApiKeyCredential {
|
|
780
|
+
/**
|
|
781
|
+
* The API key value used to authenticate with the external system.
|
|
782
|
+
* @public
|
|
783
|
+
*/
|
|
784
|
+
apiKeyValue: string | undefined;
|
|
785
|
+
}
|
|
786
|
+
/**
|
|
787
|
+
* A set of temporary AWS credentials.
|
|
788
|
+
* @public
|
|
789
|
+
*/
|
|
790
|
+
export interface AwsCredentials {
|
|
791
|
+
/**
|
|
792
|
+
* The AWS access key ID.
|
|
793
|
+
* @public
|
|
794
|
+
*/
|
|
795
|
+
accessKeyId: string | undefined;
|
|
796
|
+
/**
|
|
797
|
+
* The AWS secret access key.
|
|
798
|
+
* @public
|
|
799
|
+
*/
|
|
800
|
+
secretAccessKey: string | undefined;
|
|
801
|
+
/**
|
|
802
|
+
* The AWS session token.
|
|
803
|
+
* @public
|
|
804
|
+
*/
|
|
805
|
+
sessionToken: string | undefined;
|
|
806
|
+
/**
|
|
807
|
+
* The timestamp when the credentials expire.
|
|
808
|
+
* @public
|
|
809
|
+
*/
|
|
810
|
+
expiration: Date | undefined;
|
|
811
|
+
}
|
|
812
|
+
/**
|
|
813
|
+
* @public
|
|
814
|
+
*/
|
|
815
|
+
export interface CreateAccessGrantInput {
|
|
816
|
+
/**
|
|
817
|
+
* The ID of the domain that contains the space.
|
|
818
|
+
* @public
|
|
819
|
+
*/
|
|
820
|
+
domainId: string | undefined;
|
|
821
|
+
/**
|
|
822
|
+
* The ID of the space to scope the grant to.
|
|
823
|
+
* @public
|
|
824
|
+
*/
|
|
825
|
+
spaceId: string | undefined;
|
|
826
|
+
/**
|
|
827
|
+
* A name that identifies the access grant.
|
|
828
|
+
* @public
|
|
829
|
+
*/
|
|
830
|
+
name: string | undefined;
|
|
831
|
+
/**
|
|
832
|
+
* The principal receiving the grant.
|
|
833
|
+
* @public
|
|
834
|
+
*/
|
|
835
|
+
principal: AccessGrantPrincipal | undefined;
|
|
836
|
+
/**
|
|
837
|
+
* The permission to grant. Exactly one permission is granted per request.
|
|
838
|
+
* @public
|
|
839
|
+
*/
|
|
840
|
+
permission: AccessGrantPermission | undefined;
|
|
841
|
+
/**
|
|
842
|
+
* Groups of actions to allow, each with the resource scopes and conditions
|
|
843
|
+
* that limit those actions.
|
|
844
|
+
* @public
|
|
845
|
+
*/
|
|
846
|
+
scopedActions?: ScopedActions[] | undefined;
|
|
847
|
+
/**
|
|
848
|
+
* The tags to associate with the access grant.
|
|
849
|
+
* @public
|
|
850
|
+
*/
|
|
851
|
+
tags?: Record<string, string> | undefined;
|
|
852
|
+
/**
|
|
853
|
+
* Idempotency token for safe retries. Repeated requests with the same
|
|
854
|
+
* token return the original result instead of creating a duplicate.
|
|
855
|
+
* @public
|
|
856
|
+
*/
|
|
857
|
+
clientToken?: string | undefined;
|
|
858
|
+
}
|
|
859
|
+
/**
|
|
860
|
+
* @public
|
|
861
|
+
*/
|
|
862
|
+
export interface CreateAccessGrantOutput {
|
|
863
|
+
/**
|
|
864
|
+
* The details of the created access grant.
|
|
865
|
+
* @public
|
|
866
|
+
*/
|
|
867
|
+
accessGrant: AccessGrant | undefined;
|
|
868
|
+
}
|
|
869
|
+
/**
|
|
870
|
+
* @public
|
|
871
|
+
*/
|
|
872
|
+
export interface CreateAccessProfileInput {
|
|
873
|
+
/**
|
|
874
|
+
* The unique ID of the space to create the profile in.
|
|
875
|
+
* @public
|
|
876
|
+
*/
|
|
877
|
+
spaceId: string | undefined;
|
|
878
|
+
/**
|
|
879
|
+
* A name that identifies the access profile.
|
|
880
|
+
* @public
|
|
881
|
+
*/
|
|
882
|
+
name: string | undefined;
|
|
883
|
+
/**
|
|
884
|
+
* An optional description of the access profile.
|
|
885
|
+
* @public
|
|
886
|
+
*/
|
|
887
|
+
description?: string | undefined;
|
|
888
|
+
/**
|
|
889
|
+
* The tags to associate with the access profile.
|
|
890
|
+
* @public
|
|
891
|
+
*/
|
|
892
|
+
tags?: Record<string, string> | undefined;
|
|
893
|
+
/**
|
|
894
|
+
* Idempotency token for safe retries. Repeated requests with the same
|
|
895
|
+
* token return the original result instead of creating a duplicate.
|
|
896
|
+
* @public
|
|
897
|
+
*/
|
|
898
|
+
clientToken?: string | undefined;
|
|
899
|
+
}
|
|
900
|
+
/**
|
|
901
|
+
* @public
|
|
902
|
+
*/
|
|
903
|
+
export interface CreateAccessProfileOutput {
|
|
904
|
+
/**
|
|
905
|
+
* The access profile.
|
|
906
|
+
* @public
|
|
907
|
+
*/
|
|
908
|
+
accessProfile: AccessProfile | undefined;
|
|
909
|
+
}
|
|
910
|
+
/**
|
|
911
|
+
* @public
|
|
912
|
+
*/
|
|
913
|
+
export interface CreateAlertInput {
|
|
914
|
+
/**
|
|
915
|
+
* The unique ID of the space to create the alert in.
|
|
916
|
+
* @public
|
|
917
|
+
*/
|
|
918
|
+
spaceId: string | undefined;
|
|
919
|
+
/**
|
|
920
|
+
* The ID of the access profile the alert uses to evaluate its query and
|
|
921
|
+
* execute notifications. The caller supplies it: there is no managed
|
|
922
|
+
* alert profile, and the service does not pick one on the caller's behalf.
|
|
923
|
+
* @public
|
|
924
|
+
*/
|
|
925
|
+
profileId: string | undefined;
|
|
926
|
+
/**
|
|
927
|
+
* Alert name, for display. Max 256 (the AlarmName budget). Not the alert's
|
|
928
|
+
* identity: the backend mints a separate uuid as the \{@link AlertId\}, so the
|
|
929
|
+
* name need not be unique within a space and addressing an alert never
|
|
930
|
+
* depends on it. UpdateAlert accepts a new name to rename the alert.
|
|
931
|
+
* @public
|
|
932
|
+
*/
|
|
933
|
+
name: string | undefined;
|
|
934
|
+
/**
|
|
935
|
+
* An optional description of the alert.
|
|
936
|
+
* @public
|
|
937
|
+
*/
|
|
938
|
+
description?: string | undefined;
|
|
939
|
+
/**
|
|
940
|
+
* The rule that defines how the alert is evaluated.
|
|
941
|
+
* @public
|
|
942
|
+
*/
|
|
943
|
+
rule: Rule | undefined;
|
|
944
|
+
/**
|
|
945
|
+
* Whether actions (notifications) are enabled for this alert.
|
|
946
|
+
* Defaults to true when omitted.
|
|
947
|
+
* @public
|
|
948
|
+
*/
|
|
949
|
+
notificationsEnabled?: boolean | undefined;
|
|
950
|
+
/**
|
|
951
|
+
* The tags to associate with the alert.
|
|
952
|
+
* @public
|
|
953
|
+
*/
|
|
954
|
+
tags?: Record<string, string> | undefined;
|
|
955
|
+
/**
|
|
956
|
+
* The notification rules that determine when and where notifications are sent.
|
|
957
|
+
* @public
|
|
958
|
+
*/
|
|
959
|
+
notificationRules?: NotificationRule[] | undefined;
|
|
960
|
+
/**
|
|
961
|
+
* Idempotency token for safe retries. Retrying with the same token
|
|
962
|
+
* within the idempotency window returns the original alert instead
|
|
963
|
+
* of creating a duplicate.
|
|
964
|
+
* @public
|
|
965
|
+
*/
|
|
966
|
+
clientToken?: string | undefined;
|
|
967
|
+
}
|
|
968
|
+
/**
|
|
969
|
+
* @public
|
|
970
|
+
*/
|
|
971
|
+
export interface CreateAlertOutput {
|
|
972
|
+
/**
|
|
973
|
+
* Deprecated. Use `alert.alertArn`, which carries the same value. Kept so an existing
|
|
974
|
+
* caller keeps working while it moves to `alert`.
|
|
975
|
+
* @public
|
|
976
|
+
*/
|
|
977
|
+
alertArn?: string | undefined;
|
|
978
|
+
/**
|
|
979
|
+
* The alert that was created. The same `Alert` shape GetAlert returns, so a caller need
|
|
980
|
+
* not read the alert back to learn its timestamps or its minted alert id.
|
|
981
|
+
*
|
|
982
|
+
* \{@code alert.state\} is absent here — see the `state` member of `Alert`. Every other
|
|
983
|
+
* member is populated exactly as GetAlert populates it.
|
|
984
|
+
* @public
|
|
985
|
+
*/
|
|
986
|
+
alert: Alert | undefined;
|
|
987
|
+
}
|
|
988
|
+
/**
|
|
989
|
+
* Identity Center specific configuration.
|
|
990
|
+
* @public
|
|
991
|
+
*/
|
|
992
|
+
export interface IdentityCenterConfiguration {
|
|
993
|
+
/**
|
|
994
|
+
* Identity Center instance ARN
|
|
995
|
+
* @public
|
|
996
|
+
*/
|
|
997
|
+
identityCenterInstanceArn?: string | undefined;
|
|
998
|
+
}
|
|
999
|
+
/**
|
|
1000
|
+
* Identity provider configuration for domain authentication.
|
|
1001
|
+
* Contains provider-specific configuration blocks.
|
|
1002
|
+
* @public
|
|
1003
|
+
*/
|
|
1004
|
+
export interface IdentityProviderConfiguration {
|
|
1005
|
+
/**
|
|
1006
|
+
* Identity Center configuration. Required when identityProviders includes IDC.
|
|
1007
|
+
* @public
|
|
1008
|
+
*/
|
|
1009
|
+
identityCenterConfiguration?: IdentityCenterConfiguration | undefined;
|
|
1010
|
+
}
|
|
1011
|
+
/**
|
|
1012
|
+
* @public
|
|
1013
|
+
*/
|
|
1014
|
+
export interface CreateDomainInput {
|
|
1015
|
+
/**
|
|
1016
|
+
* A name that identifies the domain. Must be 3-63 characters: lowercase letters,
|
|
1017
|
+
* numbers, and hyphens. It must begin and end with a letter or number and cannot
|
|
1018
|
+
* contain consecutive hyphens.
|
|
1019
|
+
* @public
|
|
1020
|
+
*/
|
|
1021
|
+
name: string | undefined;
|
|
1022
|
+
/**
|
|
1023
|
+
* The identity providers to configure for the domain.
|
|
1024
|
+
* @public
|
|
1025
|
+
*/
|
|
1026
|
+
identityProviders: IdentityProvider[] | undefined;
|
|
1027
|
+
/**
|
|
1028
|
+
* Identity provider configuration for the domain.
|
|
1029
|
+
* @public
|
|
1030
|
+
*/
|
|
1031
|
+
identityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
1032
|
+
/**
|
|
1033
|
+
* The tags to associate with the domain.
|
|
1034
|
+
* @public
|
|
1035
|
+
*/
|
|
1036
|
+
tags?: Record<string, string> | undefined;
|
|
1037
|
+
/**
|
|
1038
|
+
* Idempotency token for safe retries. Repeated requests with the same
|
|
1039
|
+
* token return the original result instead of creating a duplicate.
|
|
1040
|
+
* @public
|
|
1041
|
+
*/
|
|
1042
|
+
clientToken?: string | undefined;
|
|
1043
|
+
}
|
|
1044
|
+
/**
|
|
1045
|
+
* Detailed information about a domain.
|
|
1046
|
+
* @public
|
|
1047
|
+
*/
|
|
1048
|
+
export interface Domain {
|
|
1049
|
+
/**
|
|
1050
|
+
* The unique ID of the domain.
|
|
1051
|
+
* @public
|
|
1052
|
+
*/
|
|
1053
|
+
domainId: string | undefined;
|
|
1054
|
+
/**
|
|
1055
|
+
* The Amazon Resource Name (ARN) of the domain.
|
|
1056
|
+
* @public
|
|
1057
|
+
*/
|
|
1058
|
+
domainArn: string | undefined;
|
|
1059
|
+
/**
|
|
1060
|
+
* A name that identifies the domain.
|
|
1061
|
+
* @public
|
|
1062
|
+
*/
|
|
1063
|
+
name?: string | undefined;
|
|
1064
|
+
/**
|
|
1065
|
+
* The identity providers configured for the domain.
|
|
1066
|
+
* @public
|
|
1067
|
+
*/
|
|
1068
|
+
identityProviders: IdentityProvider[] | undefined;
|
|
1069
|
+
/**
|
|
1070
|
+
* Identity provider configuration for the domain.
|
|
1071
|
+
* @public
|
|
1072
|
+
*/
|
|
1073
|
+
identityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
1074
|
+
/**
|
|
1075
|
+
* The HTTPS endpoint URL for accessing the domain.
|
|
1076
|
+
* @public
|
|
1077
|
+
*/
|
|
1078
|
+
domainEndpointUrl: string | undefined;
|
|
1079
|
+
/**
|
|
1080
|
+
* Additional endpoint URLs derived from the domain name.
|
|
1081
|
+
* @public
|
|
1082
|
+
*/
|
|
1083
|
+
customEndpointUrls?: string[] | undefined;
|
|
1084
|
+
/**
|
|
1085
|
+
* The ARN of the Identity Center application. Absent for IAM-only domains.
|
|
1086
|
+
* @public
|
|
1087
|
+
*/
|
|
1088
|
+
identityCenterApplicationArn?: string | undefined;
|
|
1089
|
+
/**
|
|
1090
|
+
* The Region where this domain was created.
|
|
1091
|
+
* @public
|
|
1092
|
+
*/
|
|
1093
|
+
region: string | undefined;
|
|
1094
|
+
/**
|
|
1095
|
+
* The timestamp when the domain was created.
|
|
1096
|
+
* @public
|
|
1097
|
+
*/
|
|
1098
|
+
createdAt: Date | undefined;
|
|
1099
|
+
/**
|
|
1100
|
+
* The timestamp when the domain was last updated.
|
|
1101
|
+
* @public
|
|
1102
|
+
*/
|
|
1103
|
+
updatedAt: Date | undefined;
|
|
1104
|
+
/**
|
|
1105
|
+
* Current status of the domain.
|
|
1106
|
+
* @public
|
|
1107
|
+
*/
|
|
1108
|
+
status: DomainStatus | undefined;
|
|
1109
|
+
}
|
|
1110
|
+
/**
|
|
1111
|
+
* @public
|
|
1112
|
+
*/
|
|
1113
|
+
export interface CreateDomainOutput {
|
|
1114
|
+
/**
|
|
1115
|
+
* The details of the created domain.
|
|
1116
|
+
* @public
|
|
1117
|
+
*/
|
|
1118
|
+
domain: Domain | undefined;
|
|
1119
|
+
}
|
|
1120
|
+
/**
|
|
1121
|
+
* The principal receiving an organization-level domain access grant. Specify
|
|
1122
|
+
* principalId, principalAttributes, or both.
|
|
1123
|
+
* @public
|
|
1124
|
+
*/
|
|
1125
|
+
export interface OrganizationAccessGrantPrincipal {
|
|
1126
|
+
/**
|
|
1127
|
+
* The type of principal receiving the grant.
|
|
1128
|
+
* @public
|
|
1129
|
+
*/
|
|
1130
|
+
principalType: OrganizationGrantPrincipalType | undefined;
|
|
1131
|
+
/**
|
|
1132
|
+
* The ID of the principal receiving the grant.
|
|
1133
|
+
* @public
|
|
1134
|
+
*/
|
|
1135
|
+
principalId?: string | undefined;
|
|
1136
|
+
/**
|
|
1137
|
+
* Attribute conditions for attribute-based access. When provided, the grant
|
|
1138
|
+
* targets any principal matching all specified conditions. Supported only for
|
|
1139
|
+
* IDC_USER principals.
|
|
1140
|
+
* @public
|
|
1141
|
+
*/
|
|
1142
|
+
principalAttributes?: AccessGrantPrincipalAttribute[] | undefined;
|
|
1143
|
+
}
|
|
1144
|
+
/**
|
|
1145
|
+
* @public
|
|
1146
|
+
*/
|
|
1147
|
+
export interface CreateDomainAccessGrantForOrganizationInput {
|
|
1148
|
+
/**
|
|
1149
|
+
* The ID of the organization domain to create the grant on.
|
|
1150
|
+
* @public
|
|
1151
|
+
*/
|
|
1152
|
+
domainId: string | undefined;
|
|
1153
|
+
/**
|
|
1154
|
+
* A name that identifies the access grant.
|
|
1155
|
+
* @public
|
|
1156
|
+
*/
|
|
1157
|
+
name: string | undefined;
|
|
1158
|
+
/**
|
|
1159
|
+
* The principal receiving the grant.
|
|
1160
|
+
* @public
|
|
1161
|
+
*/
|
|
1162
|
+
principal: OrganizationAccessGrantPrincipal | undefined;
|
|
1163
|
+
/**
|
|
1164
|
+
* The permission to grant.
|
|
1165
|
+
* @public
|
|
1166
|
+
*/
|
|
1167
|
+
permission: OrganizationGrantPermission | undefined;
|
|
1168
|
+
/**
|
|
1169
|
+
* The tags to associate with the access grant.
|
|
1170
|
+
* @public
|
|
1171
|
+
*/
|
|
1172
|
+
tags?: Record<string, string> | undefined;
|
|
1173
|
+
/**
|
|
1174
|
+
* Idempotency token for safe retries. Repeated requests with the same
|
|
1175
|
+
* token return the original result instead of creating a duplicate.
|
|
1176
|
+
* @public
|
|
1177
|
+
*/
|
|
1178
|
+
clientToken?: string | undefined;
|
|
1179
|
+
}
|
|
1180
|
+
/**
|
|
1181
|
+
* An organization-scoped access grant.
|
|
1182
|
+
* @public
|
|
1183
|
+
*/
|
|
1184
|
+
export interface OrganizationAccessGrant {
|
|
1185
|
+
/**
|
|
1186
|
+
* The unique ID of the access grant.
|
|
1187
|
+
* @public
|
|
1188
|
+
*/
|
|
1189
|
+
grantId: string | undefined;
|
|
1190
|
+
/**
|
|
1191
|
+
* The Amazon Resource Name (ARN) of the access grant.
|
|
1192
|
+
* @public
|
|
1193
|
+
*/
|
|
1194
|
+
grantArn: string | undefined;
|
|
1195
|
+
/**
|
|
1196
|
+
* A name that identifies the access grant.
|
|
1197
|
+
* @public
|
|
1198
|
+
*/
|
|
1199
|
+
name?: string | undefined;
|
|
1200
|
+
/**
|
|
1201
|
+
* The ID of the organization domain the grant belongs to.
|
|
1202
|
+
* @public
|
|
1203
|
+
*/
|
|
1204
|
+
domainId: string | undefined;
|
|
1205
|
+
/**
|
|
1206
|
+
* The principal receiving the grant.
|
|
1207
|
+
* @public
|
|
1208
|
+
*/
|
|
1209
|
+
principal: OrganizationAccessGrantPrincipal | undefined;
|
|
1210
|
+
/**
|
|
1211
|
+
* The permission granted.
|
|
1212
|
+
* @public
|
|
1213
|
+
*/
|
|
1214
|
+
permission: OrganizationGrantPermission | undefined;
|
|
1215
|
+
/**
|
|
1216
|
+
* Who manages the grant.
|
|
1217
|
+
* @public
|
|
1218
|
+
*/
|
|
1219
|
+
grantType: AccessGrantType | undefined;
|
|
1220
|
+
/**
|
|
1221
|
+
* The principal that created the grant.
|
|
1222
|
+
* @public
|
|
1223
|
+
*/
|
|
1224
|
+
createdBy: string | undefined;
|
|
1225
|
+
/**
|
|
1226
|
+
* The timestamp when the grant was created.
|
|
1227
|
+
* @public
|
|
1228
|
+
*/
|
|
1229
|
+
createdAt: Date | undefined;
|
|
1230
|
+
/**
|
|
1231
|
+
* The timestamp when the grant was last updated.
|
|
1232
|
+
* @public
|
|
1233
|
+
*/
|
|
1234
|
+
updatedAt: Date | undefined;
|
|
1235
|
+
}
|
|
1236
|
+
/**
|
|
1237
|
+
* @public
|
|
1238
|
+
*/
|
|
1239
|
+
export interface CreateDomainAccessGrantForOrganizationOutput {
|
|
1240
|
+
/**
|
|
1241
|
+
* The details of the created organization access grant.
|
|
1242
|
+
* @public
|
|
1243
|
+
*/
|
|
1244
|
+
accessGrant: OrganizationAccessGrant | undefined;
|
|
1245
|
+
}
|
|
1246
|
+
/**
|
|
1247
|
+
* @public
|
|
1248
|
+
*/
|
|
1249
|
+
export interface CreateDomainForOrganizationInput {
|
|
1250
|
+
/**
|
|
1251
|
+
* A name that identifies the organization domain. Must be 3-63 characters:
|
|
1252
|
+
* lowercase letters, numbers, and hyphens. It must begin and end with a letter or
|
|
1253
|
+
* number and cannot contain consecutive hyphens.
|
|
1254
|
+
* @public
|
|
1255
|
+
*/
|
|
1256
|
+
name: string | undefined;
|
|
1257
|
+
/**
|
|
1258
|
+
* The identity providers to configure for the domain.
|
|
1259
|
+
* @public
|
|
1260
|
+
*/
|
|
1261
|
+
identityProviders: IdentityProvider[] | undefined;
|
|
1262
|
+
/**
|
|
1263
|
+
* Identity provider configuration for the domain.
|
|
1264
|
+
* @public
|
|
1265
|
+
*/
|
|
1266
|
+
identityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
1267
|
+
/**
|
|
1268
|
+
* The ARN of an IAM role in the management account used for domain access. You must
|
|
1269
|
+
* create this role, and its trust policy must allow the service principal to assume it.
|
|
1270
|
+
* @public
|
|
1271
|
+
*/
|
|
1272
|
+
domainAccessRoleArn: string | undefined;
|
|
1273
|
+
/**
|
|
1274
|
+
* The tags to associate with the domain.
|
|
1275
|
+
* @public
|
|
1276
|
+
*/
|
|
1277
|
+
tags?: Record<string, string> | undefined;
|
|
1278
|
+
/**
|
|
1279
|
+
* Idempotency token for safe retries. Repeated requests with the same
|
|
1280
|
+
* token return the original result instead of creating a duplicate.
|
|
1281
|
+
* @public
|
|
1282
|
+
*/
|
|
1283
|
+
clientToken?: string | undefined;
|
|
1284
|
+
}
|
|
1285
|
+
/**
|
|
1286
|
+
* Detailed information about an organization domain.
|
|
1287
|
+
* @public
|
|
1288
|
+
*/
|
|
1289
|
+
export interface OrganizationDomain {
|
|
1290
|
+
/**
|
|
1291
|
+
* The unique ID of the organization domain.
|
|
1292
|
+
* @public
|
|
1293
|
+
*/
|
|
1294
|
+
domainId: string | undefined;
|
|
1295
|
+
/**
|
|
1296
|
+
* The Amazon Resource Name (ARN) of the organization domain.
|
|
1297
|
+
* @public
|
|
1298
|
+
*/
|
|
1299
|
+
domainArn: string | undefined;
|
|
1300
|
+
/**
|
|
1301
|
+
* A name that identifies the organization domain.
|
|
1302
|
+
* @public
|
|
1303
|
+
*/
|
|
1304
|
+
name?: string | undefined;
|
|
1305
|
+
/**
|
|
1306
|
+
* The HTTPS endpoint URL for accessing the organization domain.
|
|
1307
|
+
* @public
|
|
1308
|
+
*/
|
|
1309
|
+
domainEndpointUrl: string | undefined;
|
|
1310
|
+
/**
|
|
1311
|
+
* Additional endpoint URLs derived from the domain name.
|
|
1312
|
+
* @public
|
|
1313
|
+
*/
|
|
1314
|
+
customEndpointUrls?: string[] | undefined;
|
|
1315
|
+
/**
|
|
1316
|
+
* The ID of the AWS Organization that owns the domain.
|
|
1317
|
+
* @public
|
|
1318
|
+
*/
|
|
1319
|
+
organizationId: string | undefined;
|
|
1320
|
+
/**
|
|
1321
|
+
* The AWS account ID that owns the organization domain.
|
|
1322
|
+
* @public
|
|
1323
|
+
*/
|
|
1324
|
+
ownerAccountId: string | undefined;
|
|
1325
|
+
/**
|
|
1326
|
+
* The identity providers configured for the organization domain.
|
|
1327
|
+
* @public
|
|
1328
|
+
*/
|
|
1329
|
+
identityProviders: IdentityProvider[] | undefined;
|
|
1330
|
+
/**
|
|
1331
|
+
* Identity provider configuration for the organization domain.
|
|
1332
|
+
* @public
|
|
1333
|
+
*/
|
|
1334
|
+
identityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
1335
|
+
/**
|
|
1336
|
+
* The ARN of the Identity Center application. Absent for IAM-only domains.
|
|
1337
|
+
* @public
|
|
1338
|
+
*/
|
|
1339
|
+
identityCenterApplicationArn?: string | undefined;
|
|
1340
|
+
/**
|
|
1341
|
+
* The Region where this organization domain was created.
|
|
1342
|
+
* @public
|
|
1343
|
+
*/
|
|
1344
|
+
region: string | undefined;
|
|
1345
|
+
/**
|
|
1346
|
+
* Current status of the organization domain.
|
|
1347
|
+
* @public
|
|
1348
|
+
*/
|
|
1349
|
+
status: DomainStatus | undefined;
|
|
1350
|
+
/**
|
|
1351
|
+
* The ARN of the customer-provided IAM role in the management account used for
|
|
1352
|
+
* domain access.
|
|
1353
|
+
* @public
|
|
1354
|
+
*/
|
|
1355
|
+
domainAccessRoleArn?: string | undefined;
|
|
1356
|
+
/**
|
|
1357
|
+
* The timestamp when the organization domain was created.
|
|
1358
|
+
* @public
|
|
1359
|
+
*/
|
|
1360
|
+
createdAt: Date | undefined;
|
|
1361
|
+
/**
|
|
1362
|
+
* The timestamp when the organization domain was last updated.
|
|
1363
|
+
* @public
|
|
1364
|
+
*/
|
|
1365
|
+
updatedAt: Date | undefined;
|
|
1366
|
+
}
|
|
1367
|
+
/**
|
|
1368
|
+
* @public
|
|
1369
|
+
*/
|
|
1370
|
+
export interface CreateDomainForOrganizationOutput {
|
|
1371
|
+
/**
|
|
1372
|
+
* The details of the created organization domain.
|
|
1373
|
+
* @public
|
|
1374
|
+
*/
|
|
1375
|
+
organizationDomain: OrganizationDomain | undefined;
|
|
1376
|
+
}
|
|
1377
|
+
/**
|
|
1378
|
+
* Credentials for an OAuth 2.0 client-credentials grant used to authenticate
|
|
1379
|
+
* an integration with its external system.
|
|
1380
|
+
* @public
|
|
1381
|
+
*/
|
|
1382
|
+
export interface OAuthClientCredential {
|
|
1383
|
+
/**
|
|
1384
|
+
* The OAuth 2.0 client identifier registered with the external system.
|
|
1385
|
+
* @public
|
|
1386
|
+
*/
|
|
1387
|
+
clientId: string | undefined;
|
|
1388
|
+
/**
|
|
1389
|
+
* The OAuth 2.0 client secret that pairs with the client identifier.
|
|
1390
|
+
* @public
|
|
1391
|
+
*/
|
|
1392
|
+
clientSecret: string | undefined;
|
|
1393
|
+
/**
|
|
1394
|
+
* The identifier of the OAuth provider that issued the client credentials.
|
|
1395
|
+
* @public
|
|
1396
|
+
*/
|
|
1397
|
+
providerId?: string | undefined;
|
|
1398
|
+
}
|
|
1399
|
+
/**
|
|
1400
|
+
* Credentials for an OAuth 2.0 authorization-code grant, supplied when
|
|
1401
|
+
* completing the authorization of an integration.
|
|
1402
|
+
* @public
|
|
1403
|
+
*/
|
|
1404
|
+
export interface OAuthCodeCredential {
|
|
1405
|
+
/**
|
|
1406
|
+
* The OAuth 2.0 authorization code returned by the external system's
|
|
1407
|
+
* authorization endpoint.
|
|
1408
|
+
* @public
|
|
1409
|
+
*/
|
|
1410
|
+
authCode: string | undefined;
|
|
1411
|
+
}
|
|
1412
|
+
/**
|
|
1413
|
+
* The credential that an integration uses to authenticate with its external
|
|
1414
|
+
* system. Exactly one member is set, matching the integration's authentication type.
|
|
1415
|
+
* @public
|
|
1416
|
+
*/
|
|
1417
|
+
export type IntegrationCredential = IntegrationCredential.ApiKeyCredentialMember | IntegrationCredential.OauthClientCredentialMember | IntegrationCredential.OauthCodeCredentialMember | IntegrationCredential.$UnknownMember;
|
|
1418
|
+
/**
|
|
1419
|
+
* @public
|
|
1420
|
+
*/
|
|
1421
|
+
export declare namespace IntegrationCredential {
|
|
1422
|
+
/**
|
|
1423
|
+
* Credentials for an OAuth 2.0 authorization-code grant.
|
|
1424
|
+
* @public
|
|
1425
|
+
*/
|
|
1426
|
+
interface OauthCodeCredentialMember {
|
|
1427
|
+
oauthCodeCredential: OAuthCodeCredential;
|
|
1428
|
+
oauthClientCredential?: never;
|
|
1429
|
+
apiKeyCredential?: never;
|
|
1430
|
+
$unknown?: never;
|
|
1431
|
+
}
|
|
1432
|
+
/**
|
|
1433
|
+
* Credentials for an OAuth 2.0 client-credentials grant.
|
|
1434
|
+
* @public
|
|
1435
|
+
*/
|
|
1436
|
+
interface OauthClientCredentialMember {
|
|
1437
|
+
oauthCodeCredential?: never;
|
|
1438
|
+
oauthClientCredential: OAuthClientCredential;
|
|
1439
|
+
apiKeyCredential?: never;
|
|
1440
|
+
$unknown?: never;
|
|
1441
|
+
}
|
|
1442
|
+
/**
|
|
1443
|
+
* An API key credential.
|
|
1444
|
+
* @public
|
|
1445
|
+
*/
|
|
1446
|
+
interface ApiKeyCredentialMember {
|
|
1447
|
+
oauthCodeCredential?: never;
|
|
1448
|
+
oauthClientCredential?: never;
|
|
1449
|
+
apiKeyCredential: ApiKeyCredential;
|
|
1450
|
+
$unknown?: never;
|
|
1451
|
+
}
|
|
1452
|
+
/**
|
|
1453
|
+
* @public
|
|
1454
|
+
*/
|
|
1455
|
+
interface $UnknownMember {
|
|
1456
|
+
oauthCodeCredential?: never;
|
|
1457
|
+
oauthClientCredential?: never;
|
|
1458
|
+
apiKeyCredential?: never;
|
|
1459
|
+
$unknown: [string, any];
|
|
1460
|
+
}
|
|
1461
|
+
/**
|
|
1462
|
+
* @deprecated unused in schema-serde mode.
|
|
1463
|
+
*
|
|
1464
|
+
*/
|
|
1465
|
+
interface Visitor<T> {
|
|
1466
|
+
oauthCodeCredential: (value: OAuthCodeCredential) => T;
|
|
1467
|
+
oauthClientCredential: (value: OAuthClientCredential) => T;
|
|
1468
|
+
apiKeyCredential: (value: ApiKeyCredential) => T;
|
|
1469
|
+
_: (name: string, value: any) => T;
|
|
1470
|
+
}
|
|
1471
|
+
}
|
|
1472
|
+
/**
|
|
1473
|
+
* The request for creating an integration with a third-party provider.
|
|
1474
|
+
* @public
|
|
1475
|
+
*/
|
|
1476
|
+
export interface CreateIntegrationInput {
|
|
1477
|
+
/**
|
|
1478
|
+
* The type of third-party provider to integrate with.
|
|
1479
|
+
* @public
|
|
1480
|
+
*/
|
|
1481
|
+
integrationType: IntegrationType | undefined;
|
|
1482
|
+
/**
|
|
1483
|
+
* The name for the new integration; unique within the account.
|
|
1484
|
+
* @public
|
|
1485
|
+
*/
|
|
1486
|
+
name: string | undefined;
|
|
1487
|
+
/**
|
|
1488
|
+
* The credential used to authenticate with the third-party provider.
|
|
1489
|
+
* @public
|
|
1490
|
+
*/
|
|
1491
|
+
credential?: IntegrationCredential | undefined;
|
|
1492
|
+
/**
|
|
1493
|
+
* Provider-specific attributes to associate with the integration.
|
|
1494
|
+
* @public
|
|
1495
|
+
*/
|
|
1496
|
+
integrationAttributes?: Record<string, string> | undefined;
|
|
1497
|
+
/**
|
|
1498
|
+
* The Amazon Resource Name of the IAM role assumed to access the integration.
|
|
1499
|
+
* @public
|
|
1500
|
+
*/
|
|
1501
|
+
roleArn?: string | undefined;
|
|
1502
|
+
/**
|
|
1503
|
+
* Tags to apply to the integration at creation time (Tagris tag-on-create).
|
|
1504
|
+
* @public
|
|
1505
|
+
*/
|
|
1506
|
+
tags?: Record<string, string> | undefined;
|
|
1507
|
+
/**
|
|
1508
|
+
* Idempotency token for safe retries. Retrying with the same token
|
|
1509
|
+
* returns the original integration instead of creating a duplicate.
|
|
1510
|
+
* @public
|
|
1511
|
+
*/
|
|
1512
|
+
clientToken?: string | undefined;
|
|
1513
|
+
}
|
|
1514
|
+
/**
|
|
1515
|
+
* A connection between CloudWatch and an external system — such as a source of
|
|
1516
|
+
* telemetry or configuration data, a messaging destination, or a model provider.
|
|
1517
|
+
* @public
|
|
1518
|
+
*/
|
|
1519
|
+
export interface Integration {
|
|
1520
|
+
/**
|
|
1521
|
+
* The unique identifier of the integration.
|
|
1522
|
+
* @public
|
|
1523
|
+
*/
|
|
1524
|
+
integrationId: string | undefined;
|
|
1525
|
+
/**
|
|
1526
|
+
* The Amazon Resource Name (ARN) of the integration.
|
|
1527
|
+
* @public
|
|
1528
|
+
*/
|
|
1529
|
+
integrationArn?: string | undefined;
|
|
1530
|
+
/**
|
|
1531
|
+
* The type of external system that an integration connects to, such as a
|
|
1532
|
+
* source of configuration data, a messaging destination, or a model provider.
|
|
1533
|
+
* @public
|
|
1534
|
+
*/
|
|
1535
|
+
integrationType: IntegrationType | undefined;
|
|
1536
|
+
/**
|
|
1537
|
+
* The customer-provided name of the integration.
|
|
1538
|
+
* @public
|
|
1539
|
+
*/
|
|
1540
|
+
name: string | undefined;
|
|
1541
|
+
/**
|
|
1542
|
+
* The current lifecycle state of an integration.
|
|
1543
|
+
* @public
|
|
1544
|
+
*/
|
|
1545
|
+
status: IntegrationStatus | undefined;
|
|
1546
|
+
/**
|
|
1547
|
+
* The authentication method that an integration uses to connect to its
|
|
1548
|
+
* external system.
|
|
1549
|
+
* @public
|
|
1550
|
+
*/
|
|
1551
|
+
authType?: AuthType | undefined;
|
|
1552
|
+
/**
|
|
1553
|
+
* The Amazon Resource Name (ARN) of the secret that stores the integration's
|
|
1554
|
+
* credentials.
|
|
1555
|
+
* @public
|
|
1556
|
+
*/
|
|
1557
|
+
credentialArn?: string | undefined;
|
|
1558
|
+
/**
|
|
1559
|
+
* The Amazon Resource Name (ARN) of the IAM role that CloudWatch assumes to
|
|
1560
|
+
* access the external system.
|
|
1561
|
+
* @public
|
|
1562
|
+
*/
|
|
1563
|
+
roleArn?: string | undefined;
|
|
1564
|
+
/**
|
|
1565
|
+
* Provider-specific key/value attributes that configure the integration.
|
|
1566
|
+
* @public
|
|
1567
|
+
*/
|
|
1568
|
+
integrationAttributes?: Record<string, string> | undefined;
|
|
1569
|
+
/**
|
|
1570
|
+
* The URL the customer visits to authorize the integration. Present while an
|
|
1571
|
+
* OAuth authorization is pending.
|
|
1572
|
+
* @public
|
|
1573
|
+
*/
|
|
1574
|
+
authorizationUrl?: string | undefined;
|
|
1575
|
+
/**
|
|
1576
|
+
* A human-readable description of why the integration is in an ERROR or FAILED
|
|
1577
|
+
* state. Present only when the integration has failed.
|
|
1578
|
+
* @public
|
|
1579
|
+
*/
|
|
1580
|
+
errorMessage?: string | undefined;
|
|
1581
|
+
/**
|
|
1582
|
+
* The time at which the integration was created.
|
|
1583
|
+
* @public
|
|
1584
|
+
*/
|
|
1585
|
+
createdAt?: Date | undefined;
|
|
1586
|
+
/**
|
|
1587
|
+
* The time at which the integration was last updated.
|
|
1588
|
+
* @public
|
|
1589
|
+
*/
|
|
1590
|
+
updatedAt?: Date | undefined;
|
|
1591
|
+
/**
|
|
1592
|
+
* Whether this integration is account-scoped (ACCOUNT, customer-created) or organization-scoped
|
|
1593
|
+
* (ORGANIZATION, created by an org-enablement rule). Absent on legacy records is treated as ACCOUNT.
|
|
1594
|
+
* @public
|
|
1595
|
+
*/
|
|
1596
|
+
scope?: Scope | undefined;
|
|
1597
|
+
}
|
|
1598
|
+
/**
|
|
1599
|
+
* The response from creating an integration.
|
|
1600
|
+
* @public
|
|
1601
|
+
*/
|
|
1602
|
+
export interface CreateIntegrationOutput {
|
|
1603
|
+
/**
|
|
1604
|
+
* The details of the created integration. This is the same object returned by
|
|
1605
|
+
* GetIntegration and UpdateIntegration.
|
|
1606
|
+
* @public
|
|
1607
|
+
*/
|
|
1608
|
+
integration: Integration | undefined;
|
|
1609
|
+
}
|
|
1610
|
+
/**
|
|
1611
|
+
* @public
|
|
1612
|
+
*/
|
|
1613
|
+
export interface CreateOmniDashboardInput {
|
|
1614
|
+
/**
|
|
1615
|
+
* The unique ID of the space to create the dashboard in.
|
|
1616
|
+
* @public
|
|
1617
|
+
*/
|
|
1618
|
+
spaceId: string | undefined;
|
|
1619
|
+
/**
|
|
1620
|
+
* A name that identifies the dashboard.
|
|
1621
|
+
* @public
|
|
1622
|
+
*/
|
|
1623
|
+
name: string | undefined;
|
|
1624
|
+
/**
|
|
1625
|
+
* The dashboard definition, as a JSON document. Maximum 1 MiB.
|
|
1626
|
+
* @public
|
|
1627
|
+
*/
|
|
1628
|
+
body: string | undefined;
|
|
1629
|
+
/**
|
|
1630
|
+
* An optional description of the dashboard.
|
|
1631
|
+
* @public
|
|
1632
|
+
*/
|
|
1633
|
+
description?: string | undefined;
|
|
1634
|
+
/**
|
|
1635
|
+
* The tags to associate with the dashboard.
|
|
1636
|
+
* @public
|
|
1637
|
+
*/
|
|
1638
|
+
tags?: Record<string, string> | undefined;
|
|
1639
|
+
/**
|
|
1640
|
+
* Idempotency token for safe retries. Repeated requests with the same
|
|
1641
|
+
* token return the original result instead of creating a duplicate.
|
|
1642
|
+
* @public
|
|
1643
|
+
*/
|
|
1644
|
+
clientToken?: string | undefined;
|
|
1645
|
+
}
|
|
1646
|
+
/**
|
|
1647
|
+
* A dashboard within a space, including its body.
|
|
1648
|
+
* @public
|
|
1649
|
+
*/
|
|
1650
|
+
export interface OmniDashboard {
|
|
1651
|
+
/**
|
|
1652
|
+
* The unique ID of the dashboard.
|
|
1653
|
+
* @public
|
|
1654
|
+
*/
|
|
1655
|
+
dashboardId: string | undefined;
|
|
1656
|
+
/**
|
|
1657
|
+
* The Amazon Resource Name (ARN) of the dashboard.
|
|
1658
|
+
* @public
|
|
1659
|
+
*/
|
|
1660
|
+
arn: string | undefined;
|
|
1661
|
+
/**
|
|
1662
|
+
* A name that identifies the dashboard.
|
|
1663
|
+
* @public
|
|
1664
|
+
*/
|
|
1665
|
+
name: string | undefined;
|
|
1666
|
+
/**
|
|
1667
|
+
* The dashboard definition.
|
|
1668
|
+
* @public
|
|
1669
|
+
*/
|
|
1670
|
+
body: string | undefined;
|
|
1671
|
+
/**
|
|
1672
|
+
* The principal that created the dashboard.
|
|
1673
|
+
* @public
|
|
1674
|
+
*/
|
|
1675
|
+
createdBy: string | undefined;
|
|
1676
|
+
/**
|
|
1677
|
+
* An optional description of the dashboard.
|
|
1678
|
+
* @public
|
|
1679
|
+
*/
|
|
1680
|
+
description?: string | undefined;
|
|
1681
|
+
/**
|
|
1682
|
+
* The tags associated with the dashboard.
|
|
1683
|
+
* @public
|
|
1684
|
+
*/
|
|
1685
|
+
tags?: Record<string, string> | undefined;
|
|
1686
|
+
/**
|
|
1687
|
+
* The timestamp when the dashboard was created.
|
|
1688
|
+
* @public
|
|
1689
|
+
*/
|
|
1690
|
+
createdAt: Date | undefined;
|
|
1691
|
+
/**
|
|
1692
|
+
* The timestamp when the dashboard was last updated.
|
|
1693
|
+
* @public
|
|
1694
|
+
*/
|
|
1695
|
+
updatedAt: Date | undefined;
|
|
1696
|
+
}
|
|
1697
|
+
/**
|
|
1698
|
+
* @public
|
|
1699
|
+
*/
|
|
1700
|
+
export interface CreateOmniDashboardOutput {
|
|
1701
|
+
/**
|
|
1702
|
+
* The dashboard.
|
|
1703
|
+
* @public
|
|
1704
|
+
*/
|
|
1705
|
+
omniDashboard: OmniDashboard | undefined;
|
|
1706
|
+
}
|
|
1707
|
+
/**
|
|
1708
|
+
* @public
|
|
1709
|
+
*/
|
|
1710
|
+
export interface CreateOneTimeDeepLinkCodeInput {
|
|
1711
|
+
/**
|
|
1712
|
+
* The ID of the domain to generate the code for.
|
|
1713
|
+
* @public
|
|
1714
|
+
*/
|
|
1715
|
+
domainId: string | undefined;
|
|
1716
|
+
/**
|
|
1717
|
+
* How long the code remains valid, in seconds. Defaults to 300.
|
|
1718
|
+
* @public
|
|
1719
|
+
*/
|
|
1720
|
+
ttlSeconds?: number | undefined;
|
|
1721
|
+
/**
|
|
1722
|
+
* The URL to redirect to after the deep-link code is used. Must be an HTTPS URL in the
|
|
1723
|
+
* domain with a path of /auth/callback, and cannot include a query
|
|
1724
|
+
* string or fragment. If omitted, no redirect is applied.
|
|
1725
|
+
* @public
|
|
1726
|
+
*/
|
|
1727
|
+
redirectUrl?: string | undefined;
|
|
1728
|
+
}
|
|
1729
|
+
/**
|
|
1730
|
+
* @public
|
|
1731
|
+
*/
|
|
1732
|
+
export interface CreateOneTimeDeepLinkCodeOutput {
|
|
1733
|
+
/**
|
|
1734
|
+
* The one-time deep-link code.
|
|
1735
|
+
* @public
|
|
1736
|
+
*/
|
|
1737
|
+
code: string | undefined;
|
|
1738
|
+
/**
|
|
1739
|
+
* The deep-link URL containing the one-time code.
|
|
1740
|
+
* @public
|
|
1741
|
+
*/
|
|
1742
|
+
deepLinkUrl: string | undefined;
|
|
1743
|
+
/**
|
|
1744
|
+
* The timestamp when the code expires.
|
|
1745
|
+
* @public
|
|
1746
|
+
*/
|
|
1747
|
+
expiresAt: Date | undefined;
|
|
1748
|
+
}
|
|
1749
|
+
/**
|
|
1750
|
+
* How a resource's data at rest is encrypted.
|
|
1751
|
+
*
|
|
1752
|
+
* `kmsKeyArn` is required when `encryptionStrategy` is CUSTOMER_MANAGED and must be
|
|
1753
|
+
* absent when it is AWS_OWNED; a mismatch is a ValidationException rather than a
|
|
1754
|
+
* silently ignored field, so a caller that selects AWS_OWNED while still passing a key
|
|
1755
|
+
* learns that the key was not applied.
|
|
1756
|
+
* @public
|
|
1757
|
+
*/
|
|
1758
|
+
export interface EncryptionConfiguration {
|
|
1759
|
+
/**
|
|
1760
|
+
* Which kind of key to use. Required.
|
|
1761
|
+
* @public
|
|
1762
|
+
*/
|
|
1763
|
+
encryptionStrategy: EncryptionStrategy | undefined;
|
|
1764
|
+
/**
|
|
1765
|
+
* Customer managed KMS key ARN. Required when `encryptionStrategy` is
|
|
1766
|
+
* CUSTOMER_MANAGED, and must be omitted when it is AWS_OWNED. Must be a symmetric
|
|
1767
|
+
* ENCRYPT_DECRYPT key in the caller's account and region.
|
|
1768
|
+
* @public
|
|
1769
|
+
*/
|
|
1770
|
+
kmsKeyArn?: string | undefined;
|
|
1771
|
+
}
|
|
1772
|
+
/**
|
|
1773
|
+
* @public
|
|
1774
|
+
*/
|
|
1775
|
+
export interface CreateSpaceInput {
|
|
1776
|
+
/**
|
|
1777
|
+
* A name that identifies the space. Must be 3-64 characters: lowercase letters,
|
|
1778
|
+
* numbers, and hyphens. It must begin and end with a letter or number and cannot
|
|
1779
|
+
* contain consecutive hyphens.
|
|
1780
|
+
* @public
|
|
1781
|
+
*/
|
|
1782
|
+
name: string | undefined;
|
|
1783
|
+
/**
|
|
1784
|
+
* The ID of the domain to create the space in.
|
|
1785
|
+
* @public
|
|
1786
|
+
*/
|
|
1787
|
+
domainId: string | undefined;
|
|
1788
|
+
/**
|
|
1789
|
+
* The ARN of the IAM role used for data access. The role must be in the caller's
|
|
1790
|
+
* account.
|
|
1791
|
+
* @public
|
|
1792
|
+
*/
|
|
1793
|
+
dataAccessRoleArn: string | undefined;
|
|
1794
|
+
/**
|
|
1795
|
+
* The ARN of the IAM role used by AgentCore online evaluation. Must be in the
|
|
1796
|
+
* caller's account. Omit if the space does not use AgentCore online evaluation.
|
|
1797
|
+
* @public
|
|
1798
|
+
*/
|
|
1799
|
+
agentCoreEvaluationRoleArn?: string | undefined;
|
|
1800
|
+
/**
|
|
1801
|
+
* How to encrypt the space's data at rest. Omit for service owned encryption,
|
|
1802
|
+
* which is equivalent to passing `encryptionStrategy` AWS_OWNED.
|
|
1803
|
+
* @public
|
|
1804
|
+
*/
|
|
1805
|
+
encryptionConfiguration?: EncryptionConfiguration | undefined;
|
|
1806
|
+
/**
|
|
1807
|
+
* The tags to associate with the space.
|
|
1808
|
+
* @public
|
|
1809
|
+
*/
|
|
1810
|
+
tags?: Record<string, string> | undefined;
|
|
1811
|
+
/**
|
|
1812
|
+
* Idempotency token for safe retries. Repeated requests with the same
|
|
1813
|
+
* token return the original result instead of creating a duplicate.
|
|
1814
|
+
* @public
|
|
1815
|
+
*/
|
|
1816
|
+
clientToken?: string | undefined;
|
|
1817
|
+
}
|
|
1818
|
+
/**
|
|
1819
|
+
* Detailed information about a space.
|
|
1820
|
+
* @public
|
|
1821
|
+
*/
|
|
1822
|
+
export interface Space {
|
|
1823
|
+
/**
|
|
1824
|
+
* The unique ID of the space.
|
|
1825
|
+
* @public
|
|
1826
|
+
*/
|
|
1827
|
+
spaceId: string | undefined;
|
|
1828
|
+
/**
|
|
1829
|
+
* A name that identifies the space.
|
|
1830
|
+
* @public
|
|
1831
|
+
*/
|
|
1832
|
+
name: string | undefined;
|
|
1833
|
+
/**
|
|
1834
|
+
* The Amazon Resource Name (ARN) of the space.
|
|
1835
|
+
* @public
|
|
1836
|
+
*/
|
|
1837
|
+
spaceArn: string | undefined;
|
|
1838
|
+
/**
|
|
1839
|
+
* The Amazon Resource Name (ARN) of the domain the space belongs to. Absent when
|
|
1840
|
+
* the space is not associated with a domain, so callers must tolerate its absence.
|
|
1841
|
+
* @public
|
|
1842
|
+
*/
|
|
1843
|
+
domainArn?: string | undefined;
|
|
1844
|
+
/**
|
|
1845
|
+
* The region where this space was created.
|
|
1846
|
+
* @public
|
|
1847
|
+
*/
|
|
1848
|
+
region: string | undefined;
|
|
1849
|
+
/**
|
|
1850
|
+
* AWS account ID that owns this space.
|
|
1851
|
+
* @public
|
|
1852
|
+
*/
|
|
1853
|
+
ownerAccountId: string | undefined;
|
|
1854
|
+
/**
|
|
1855
|
+
* The ARN of the IAM role used for data access.
|
|
1856
|
+
* @public
|
|
1857
|
+
*/
|
|
1858
|
+
dataAccessRoleArn: string | undefined;
|
|
1859
|
+
/**
|
|
1860
|
+
* The timestamp when the space was created.
|
|
1861
|
+
* @public
|
|
1862
|
+
*/
|
|
1863
|
+
createdAt: Date | undefined;
|
|
1864
|
+
/**
|
|
1865
|
+
* The timestamp when the space was last updated.
|
|
1866
|
+
* @public
|
|
1867
|
+
*/
|
|
1868
|
+
updatedAt: Date | undefined;
|
|
1869
|
+
/**
|
|
1870
|
+
* The ARN of the IAM role used by AgentCore online evaluation. Absent when the space
|
|
1871
|
+
* was created without one.
|
|
1872
|
+
* @public
|
|
1873
|
+
*/
|
|
1874
|
+
agentCoreEvaluationRoleArn?: string | undefined;
|
|
1875
|
+
/**
|
|
1876
|
+
* The status of the space.
|
|
1877
|
+
* @public
|
|
1878
|
+
*/
|
|
1879
|
+
status: SpaceStatus | undefined;
|
|
1880
|
+
/**
|
|
1881
|
+
* Reason for the current space status.
|
|
1882
|
+
* @public
|
|
1883
|
+
*/
|
|
1884
|
+
statusReason?: string | undefined;
|
|
1885
|
+
/**
|
|
1886
|
+
* How the space's data at rest is encrypted. Always populated: a space with no
|
|
1887
|
+
* customer managed key reports `encryptionStrategy` AWS_OWNED and no `kmsKeyArn`.
|
|
1888
|
+
* @public
|
|
1889
|
+
*/
|
|
1890
|
+
encryptionConfiguration?: EncryptionConfiguration | undefined;
|
|
1891
|
+
}
|
|
1892
|
+
/**
|
|
1893
|
+
* @public
|
|
1894
|
+
*/
|
|
1895
|
+
export interface CreateSpaceOutput {
|
|
1896
|
+
/**
|
|
1897
|
+
* The details of the created space.
|
|
1898
|
+
* @public
|
|
1899
|
+
*/
|
|
1900
|
+
space: Space | undefined;
|
|
1901
|
+
}
|
|
1902
|
+
/**
|
|
1903
|
+
* @public
|
|
1904
|
+
*/
|
|
1905
|
+
export interface CreateViewRequest {
|
|
1906
|
+
/**
|
|
1907
|
+
* The name of the view. Must begin with the "view." prefix. View names
|
|
1908
|
+
* must be unique within the account and region.
|
|
1909
|
+
* @public
|
|
1910
|
+
*/
|
|
1911
|
+
name: string | undefined;
|
|
1912
|
+
/**
|
|
1913
|
+
* The SQL query that defines the view.
|
|
1914
|
+
* @public
|
|
1915
|
+
*/
|
|
1916
|
+
definition: string | undefined;
|
|
1917
|
+
/**
|
|
1918
|
+
* A description of the view.
|
|
1919
|
+
* @public
|
|
1920
|
+
*/
|
|
1921
|
+
description?: string | undefined;
|
|
1922
|
+
/**
|
|
1923
|
+
* Resource tags.
|
|
1924
|
+
* @public
|
|
1925
|
+
*/
|
|
1926
|
+
tags?: Record<string, string> | undefined;
|
|
1927
|
+
/**
|
|
1928
|
+
* Idempotency token for safe retries. Retrying with the same token
|
|
1929
|
+
* returns the original view instead of creating a duplicate.
|
|
1930
|
+
* @public
|
|
1931
|
+
*/
|
|
1932
|
+
clientToken?: string | undefined;
|
|
1933
|
+
}
|
|
1934
|
+
/**
|
|
1935
|
+
* @public
|
|
1936
|
+
*/
|
|
1937
|
+
export interface CreateViewResponse {
|
|
1938
|
+
/**
|
|
1939
|
+
* The name of the view.
|
|
1940
|
+
* @public
|
|
1941
|
+
*/
|
|
1942
|
+
name: string | undefined;
|
|
1943
|
+
/**
|
|
1944
|
+
* The ownership category of the view.
|
|
1945
|
+
* @public
|
|
1946
|
+
*/
|
|
1947
|
+
type: ViewType | undefined;
|
|
1948
|
+
/**
|
|
1949
|
+
* The description of the view.
|
|
1950
|
+
* @public
|
|
1951
|
+
*/
|
|
1952
|
+
description?: string | undefined;
|
|
1953
|
+
/**
|
|
1954
|
+
* The SQL query that defines the view.
|
|
1955
|
+
* @public
|
|
1956
|
+
*/
|
|
1957
|
+
definition: string | undefined;
|
|
1958
|
+
/**
|
|
1959
|
+
* The timestamp when the view was created.
|
|
1960
|
+
* @public
|
|
1961
|
+
*/
|
|
1962
|
+
createdAt: Date | undefined;
|
|
1963
|
+
/**
|
|
1964
|
+
* The timestamp when the view was last updated.
|
|
1965
|
+
* @public
|
|
1966
|
+
*/
|
|
1967
|
+
updatedAt: Date | undefined;
|
|
1968
|
+
/**
|
|
1969
|
+
* The ARN of the view.
|
|
1970
|
+
* @public
|
|
1971
|
+
*/
|
|
1972
|
+
arn: string | undefined;
|
|
1973
|
+
}
|
|
1974
|
+
/**
|
|
1975
|
+
* @public
|
|
1976
|
+
*/
|
|
1977
|
+
export interface DeleteAccessGrantInput {
|
|
1978
|
+
/**
|
|
1979
|
+
* The ID of the access grant to delete.
|
|
1980
|
+
* @public
|
|
1981
|
+
*/
|
|
1982
|
+
grantId: string | undefined;
|
|
1983
|
+
}
|
|
1984
|
+
/**
|
|
1985
|
+
* @public
|
|
1986
|
+
*/
|
|
1987
|
+
export interface DeleteAccessGrantOutput {
|
|
1988
|
+
}
|
|
1989
|
+
/**
|
|
1990
|
+
* @public
|
|
1991
|
+
*/
|
|
1992
|
+
export interface DeleteAccessProfileInput {
|
|
1993
|
+
/**
|
|
1994
|
+
* The unique ID of the space.
|
|
1995
|
+
* @public
|
|
1996
|
+
*/
|
|
1997
|
+
spaceId: string | undefined;
|
|
1998
|
+
/**
|
|
1999
|
+
* The unique ID of the access profile to delete.
|
|
2000
|
+
* @public
|
|
2001
|
+
*/
|
|
2002
|
+
profileId: string | undefined;
|
|
2003
|
+
}
|
|
2004
|
+
/**
|
|
2005
|
+
* @public
|
|
2006
|
+
*/
|
|
2007
|
+
export interface DeleteAccessProfileOutput {
|
|
2008
|
+
}
|
|
2009
|
+
/**
|
|
2010
|
+
* @public
|
|
2011
|
+
*/
|
|
2012
|
+
export interface DeleteAlertInput {
|
|
2013
|
+
/**
|
|
2014
|
+
* The unique ID of the space.
|
|
2015
|
+
* @public
|
|
2016
|
+
*/
|
|
2017
|
+
spaceId: string | undefined;
|
|
2018
|
+
/**
|
|
2019
|
+
* The alert to delete.
|
|
2020
|
+
* @public
|
|
2021
|
+
*/
|
|
2022
|
+
alertId: string | undefined;
|
|
2023
|
+
}
|
|
2024
|
+
/**
|
|
2025
|
+
* @public
|
|
2026
|
+
*/
|
|
2027
|
+
export interface DeleteAlertOutput {
|
|
2028
|
+
}
|
|
2029
|
+
/**
|
|
2030
|
+
* @public
|
|
2031
|
+
*/
|
|
2032
|
+
export interface DeleteDomainInput {
|
|
2033
|
+
/**
|
|
2034
|
+
* The unique ID of the domain to delete.
|
|
2035
|
+
* @public
|
|
2036
|
+
*/
|
|
2037
|
+
domainId: string | undefined;
|
|
2038
|
+
}
|
|
2039
|
+
/**
|
|
2040
|
+
* @public
|
|
2041
|
+
*/
|
|
2042
|
+
export interface DeleteDomainOutput {
|
|
2043
|
+
}
|
|
2044
|
+
/**
|
|
2045
|
+
* @public
|
|
2046
|
+
*/
|
|
2047
|
+
export interface DeleteDomainAccessGrantForOrganizationInput {
|
|
2048
|
+
/**
|
|
2049
|
+
* The ID of the access grant to delete.
|
|
2050
|
+
* @public
|
|
2051
|
+
*/
|
|
2052
|
+
grantId: string | undefined;
|
|
2053
|
+
}
|
|
2054
|
+
/**
|
|
2055
|
+
* @public
|
|
2056
|
+
*/
|
|
2057
|
+
export interface DeleteDomainAccessGrantForOrganizationOutput {
|
|
2058
|
+
}
|
|
2059
|
+
/**
|
|
2060
|
+
* @public
|
|
2061
|
+
*/
|
|
2062
|
+
export interface DeleteDomainForOrganizationInput {
|
|
2063
|
+
/**
|
|
2064
|
+
* The ID of the organization domain to delete.
|
|
2065
|
+
* @public
|
|
2066
|
+
*/
|
|
2067
|
+
domainId: string | undefined;
|
|
2068
|
+
}
|
|
2069
|
+
/**
|
|
2070
|
+
* @public
|
|
2071
|
+
*/
|
|
2072
|
+
export interface DeleteDomainForOrganizationOutput {
|
|
2073
|
+
}
|
|
2074
|
+
/**
|
|
2075
|
+
* Identifies a single integration by exactly one of its unique keys: the
|
|
2076
|
+
* integration id, the integration ARN, or the integration name.
|
|
2077
|
+
* @public
|
|
2078
|
+
*/
|
|
2079
|
+
export type IntegrationIdentifier = IntegrationIdentifier.IntegrationArnMember | IntegrationIdentifier.IntegrationIdMember | IntegrationIdentifier.IntegrationNameMember | IntegrationIdentifier.$UnknownMember;
|
|
2080
|
+
/**
|
|
2081
|
+
* @public
|
|
2082
|
+
*/
|
|
2083
|
+
export declare namespace IntegrationIdentifier {
|
|
2084
|
+
/**
|
|
2085
|
+
* The unique identifier of the integration.
|
|
2086
|
+
* @public
|
|
2087
|
+
*/
|
|
2088
|
+
interface IntegrationIdMember {
|
|
2089
|
+
integrationId: string;
|
|
2090
|
+
integrationArn?: never;
|
|
2091
|
+
integrationName?: never;
|
|
2092
|
+
$unknown?: never;
|
|
2093
|
+
}
|
|
2094
|
+
/**
|
|
2095
|
+
* The Amazon Resource Name of the integration.
|
|
2096
|
+
* @public
|
|
2097
|
+
*/
|
|
2098
|
+
interface IntegrationArnMember {
|
|
2099
|
+
integrationId?: never;
|
|
2100
|
+
integrationArn: string;
|
|
2101
|
+
integrationName?: never;
|
|
2102
|
+
$unknown?: never;
|
|
2103
|
+
}
|
|
2104
|
+
/**
|
|
2105
|
+
* The name of the integration; unique within the account.
|
|
2106
|
+
* @public
|
|
2107
|
+
*/
|
|
2108
|
+
interface IntegrationNameMember {
|
|
2109
|
+
integrationId?: never;
|
|
2110
|
+
integrationArn?: never;
|
|
2111
|
+
integrationName: string;
|
|
2112
|
+
$unknown?: never;
|
|
2113
|
+
}
|
|
2114
|
+
/**
|
|
2115
|
+
* @public
|
|
2116
|
+
*/
|
|
2117
|
+
interface $UnknownMember {
|
|
2118
|
+
integrationId?: never;
|
|
2119
|
+
integrationArn?: never;
|
|
2120
|
+
integrationName?: never;
|
|
2121
|
+
$unknown: [string, any];
|
|
2122
|
+
}
|
|
2123
|
+
/**
|
|
2124
|
+
* @deprecated unused in schema-serde mode.
|
|
2125
|
+
*
|
|
2126
|
+
*/
|
|
2127
|
+
interface Visitor<T> {
|
|
2128
|
+
integrationId: (value: string) => T;
|
|
2129
|
+
integrationArn: (value: string) => T;
|
|
2130
|
+
integrationName: (value: string) => T;
|
|
2131
|
+
_: (name: string, value: any) => T;
|
|
2132
|
+
}
|
|
2133
|
+
}
|
|
2134
|
+
/**
|
|
2135
|
+
* The request for deleting an integration.
|
|
2136
|
+
* @public
|
|
2137
|
+
*/
|
|
2138
|
+
export interface DeleteIntegrationInput {
|
|
2139
|
+
/**
|
|
2140
|
+
* Identifies the integration to delete — exactly one of integrationId,
|
|
2141
|
+
* integrationArn, or integrationName.
|
|
2142
|
+
* @public
|
|
2143
|
+
*/
|
|
2144
|
+
identifier: IntegrationIdentifier | undefined;
|
|
2145
|
+
}
|
|
2146
|
+
/**
|
|
2147
|
+
* The response from deleting an integration. Empty by contract — a successful
|
|
2148
|
+
* call indicates the deletion was accepted (DeleteIntegration is idempotent).
|
|
2149
|
+
* @public
|
|
2150
|
+
*/
|
|
2151
|
+
export interface DeleteIntegrationOutput {
|
|
2152
|
+
}
|
|
2153
|
+
/**
|
|
2154
|
+
* @public
|
|
2155
|
+
*/
|
|
2156
|
+
export interface DeleteOmniDashboardInput {
|
|
2157
|
+
/**
|
|
2158
|
+
* The unique ID of the space.
|
|
2159
|
+
* @public
|
|
2160
|
+
*/
|
|
2161
|
+
spaceId: string | undefined;
|
|
2162
|
+
/**
|
|
2163
|
+
* The unique ID of the dashboard.
|
|
2164
|
+
* @public
|
|
2165
|
+
*/
|
|
2166
|
+
dashboardId: string | undefined;
|
|
2167
|
+
}
|
|
2168
|
+
/**
|
|
2169
|
+
* @public
|
|
2170
|
+
*/
|
|
2171
|
+
export interface DeleteOmniDashboardOutput {
|
|
2172
|
+
}
|
|
2173
|
+
/**
|
|
2174
|
+
* @public
|
|
2175
|
+
*/
|
|
2176
|
+
export interface DeleteSpaceInput {
|
|
2177
|
+
/**
|
|
2178
|
+
* The unique ID of the space to delete.
|
|
2179
|
+
* @public
|
|
2180
|
+
*/
|
|
2181
|
+
spaceId: string | undefined;
|
|
2182
|
+
}
|
|
2183
|
+
/**
|
|
2184
|
+
* @public
|
|
2185
|
+
*/
|
|
2186
|
+
export interface DeleteSpaceOutput {
|
|
2187
|
+
}
|
|
2188
|
+
/**
|
|
2189
|
+
* @public
|
|
2190
|
+
*/
|
|
2191
|
+
export interface DeleteViewRequest {
|
|
2192
|
+
/**
|
|
2193
|
+
* The name of the view to delete.
|
|
2194
|
+
* @public
|
|
2195
|
+
*/
|
|
2196
|
+
name: string | undefined;
|
|
2197
|
+
}
|
|
2198
|
+
/**
|
|
2199
|
+
* @public
|
|
2200
|
+
*/
|
|
2201
|
+
export interface DeleteViewResponse {
|
|
2202
|
+
}
|
|
2203
|
+
/**
|
|
2204
|
+
* @public
|
|
2205
|
+
*/
|
|
2206
|
+
export interface GetAccessGrantInput {
|
|
2207
|
+
/**
|
|
2208
|
+
* The ID of the access grant to retrieve.
|
|
2209
|
+
* @public
|
|
2210
|
+
*/
|
|
2211
|
+
grantId: string | undefined;
|
|
2212
|
+
}
|
|
2213
|
+
/**
|
|
2214
|
+
* @public
|
|
2215
|
+
*/
|
|
2216
|
+
export interface GetAccessGrantOutput {
|
|
2217
|
+
/**
|
|
2218
|
+
* The full details of the access grant.
|
|
2219
|
+
* @public
|
|
2220
|
+
*/
|
|
2221
|
+
accessGrant: AccessGrant | undefined;
|
|
2222
|
+
}
|
|
2223
|
+
/**
|
|
2224
|
+
* @public
|
|
2225
|
+
*/
|
|
2226
|
+
export interface GetAccessProfileInput {
|
|
2227
|
+
/**
|
|
2228
|
+
* The unique ID of the space.
|
|
2229
|
+
* @public
|
|
2230
|
+
*/
|
|
2231
|
+
spaceId: string | undefined;
|
|
2232
|
+
/**
|
|
2233
|
+
* The unique ID of the access profile.
|
|
2234
|
+
* @public
|
|
2235
|
+
*/
|
|
2236
|
+
profileId: string | undefined;
|
|
2237
|
+
}
|
|
2238
|
+
/**
|
|
2239
|
+
* @public
|
|
2240
|
+
*/
|
|
2241
|
+
export interface GetAccessProfileOutput {
|
|
2242
|
+
/**
|
|
2243
|
+
* The access profile.
|
|
2244
|
+
* @public
|
|
2245
|
+
*/
|
|
2246
|
+
accessProfile: AccessProfile | undefined;
|
|
2247
|
+
}
|
|
2248
|
+
/**
|
|
2249
|
+
* @public
|
|
2250
|
+
*/
|
|
2251
|
+
export interface GetAlertInput {
|
|
2252
|
+
/**
|
|
2253
|
+
* The unique ID of the space.
|
|
2254
|
+
* @public
|
|
2255
|
+
*/
|
|
2256
|
+
spaceId: string | undefined;
|
|
2257
|
+
/**
|
|
2258
|
+
* The alert to retrieve.
|
|
2259
|
+
* @public
|
|
2260
|
+
*/
|
|
2261
|
+
alertId: string | undefined;
|
|
2262
|
+
}
|
|
2263
|
+
/**
|
|
2264
|
+
* @public
|
|
2265
|
+
*/
|
|
2266
|
+
export interface GetAlertOutput {
|
|
2267
|
+
/**
|
|
2268
|
+
* The full alert entity.
|
|
2269
|
+
* @public
|
|
2270
|
+
*/
|
|
2271
|
+
alert: Alert | undefined;
|
|
2272
|
+
}
|
|
2273
|
+
/**
|
|
2274
|
+
* Key-value filter used for tags and attributes filtering.
|
|
2275
|
+
* Multiple KeyFilters are AND'ed. Multiple values within a single KeyFilter are OR'ed.
|
|
2276
|
+
* Values support pattern syntax: exact, negation (!value), wildcard (*value*, value*, *value).
|
|
2277
|
+
* @public
|
|
2278
|
+
*/
|
|
2279
|
+
export interface KeyFilter {
|
|
2280
|
+
/**
|
|
2281
|
+
* The tag or attribute key to filter on.
|
|
2282
|
+
* @public
|
|
2283
|
+
*/
|
|
2284
|
+
key: string | undefined;
|
|
2285
|
+
/**
|
|
2286
|
+
* The values to match for this key, OR'ed together. Each supports exact,
|
|
2287
|
+
* negation (!value), and wildcard (*value*, value*, *value) syntax.
|
|
2288
|
+
* @public
|
|
2289
|
+
*/
|
|
2290
|
+
values?: string[] | undefined;
|
|
2291
|
+
}
|
|
2292
|
+
/**
|
|
2293
|
+
* Criteria for filtering edges in a context graph query.
|
|
2294
|
+
* @public
|
|
2295
|
+
*/
|
|
2296
|
+
export interface EdgeFilters {
|
|
2297
|
+
/**
|
|
2298
|
+
* Match only the edge with this identifier.
|
|
2299
|
+
* @public
|
|
2300
|
+
*/
|
|
2301
|
+
edgeId?: string | undefined;
|
|
2302
|
+
/**
|
|
2303
|
+
* Match only edges originating from this node identifier.
|
|
2304
|
+
* @public
|
|
2305
|
+
*/
|
|
2306
|
+
from?: string | undefined;
|
|
2307
|
+
/**
|
|
2308
|
+
* Match only edges pointing to this node identifier.
|
|
2309
|
+
* @public
|
|
2310
|
+
*/
|
|
2311
|
+
to?: string | undefined;
|
|
2312
|
+
/**
|
|
2313
|
+
* Match only edges of this relationship kind.
|
|
2314
|
+
* @public
|
|
2315
|
+
*/
|
|
2316
|
+
edgeType?: EdgeType | undefined;
|
|
2317
|
+
/**
|
|
2318
|
+
* Match edges carrying any of these operations.
|
|
2319
|
+
* @public
|
|
2320
|
+
*/
|
|
2321
|
+
operations?: string[] | undefined;
|
|
2322
|
+
/**
|
|
2323
|
+
* Match edges by their OpenTelemetry (OTel) telemetry attributes. Not yet enforced:
|
|
2324
|
+
* currently accepted but ignored (does not filter), matching
|
|
2325
|
+
* nodeFilters.telemetryAttributes.
|
|
2326
|
+
* @public
|
|
2327
|
+
*/
|
|
2328
|
+
telemetryAttributes?: KeyFilter[] | undefined;
|
|
2329
|
+
/**
|
|
2330
|
+
* Match edges contributed by any of these discovery sources.
|
|
2331
|
+
* @public
|
|
2332
|
+
*/
|
|
2333
|
+
sources?: Source[] | undefined;
|
|
2334
|
+
}
|
|
2335
|
+
/**
|
|
2336
|
+
* Criteria for selecting nodes in a context graph query.
|
|
2337
|
+
* @public
|
|
2338
|
+
*/
|
|
2339
|
+
export interface NodeFilters {
|
|
2340
|
+
/**
|
|
2341
|
+
* Match only the node with this identifier.
|
|
2342
|
+
* @public
|
|
2343
|
+
*/
|
|
2344
|
+
nodeId?: string | undefined;
|
|
2345
|
+
/**
|
|
2346
|
+
* Match only nodes of this type.
|
|
2347
|
+
* @public
|
|
2348
|
+
*/
|
|
2349
|
+
nodeType?: NodeType | undefined;
|
|
2350
|
+
/**
|
|
2351
|
+
* Match only nodes with this name.
|
|
2352
|
+
* @public
|
|
2353
|
+
*/
|
|
2354
|
+
name?: string | undefined;
|
|
2355
|
+
/**
|
|
2356
|
+
* Match nodes by the tags on the underlying resource.
|
|
2357
|
+
* @public
|
|
2358
|
+
*/
|
|
2359
|
+
tags?: KeyFilter[] | undefined;
|
|
2360
|
+
/**
|
|
2361
|
+
* Match nodes by their OpenTelemetry (OTel) telemetry attributes.
|
|
2362
|
+
* @public
|
|
2363
|
+
*/
|
|
2364
|
+
telemetryAttributes?: KeyFilter[] | undefined;
|
|
2365
|
+
/**
|
|
2366
|
+
* Match nodes in any of these regions.
|
|
2367
|
+
* @public
|
|
2368
|
+
*/
|
|
2369
|
+
region?: string[] | undefined;
|
|
2370
|
+
/**
|
|
2371
|
+
* Match nodes on any of these cloud providers.
|
|
2372
|
+
* @public
|
|
2373
|
+
*/
|
|
2374
|
+
cloudProvider?: string[] | undefined;
|
|
2375
|
+
/**
|
|
2376
|
+
* Match nodes discovered from telemetry produced by any of these accounts.
|
|
2377
|
+
* @public
|
|
2378
|
+
*/
|
|
2379
|
+
sourceAccountId?: string[] | undefined;
|
|
2380
|
+
/**
|
|
2381
|
+
* Match nodes in any of these logical service groupings.
|
|
2382
|
+
* @public
|
|
2383
|
+
*/
|
|
2384
|
+
namespace?: string[] | undefined;
|
|
2385
|
+
/**
|
|
2386
|
+
* Match nodes of any of these categories.
|
|
2387
|
+
* @public
|
|
2388
|
+
*/
|
|
2389
|
+
category?: NodeCategory[] | undefined;
|
|
2390
|
+
/**
|
|
2391
|
+
* Match nodes observed in any of these deployment environments.
|
|
2392
|
+
* @public
|
|
2393
|
+
*/
|
|
2394
|
+
stage?: string[] | undefined;
|
|
2395
|
+
/**
|
|
2396
|
+
* Match nodes contributed by any of these discovery sources.
|
|
2397
|
+
* @public
|
|
2398
|
+
*/
|
|
2399
|
+
sources?: Source[] | undefined;
|
|
2400
|
+
}
|
|
2401
|
+
/**
|
|
2402
|
+
* The request for retrieving a slice of the context graph.
|
|
2403
|
+
* @public
|
|
2404
|
+
*/
|
|
2405
|
+
export interface GetContextGraphInput {
|
|
2406
|
+
/**
|
|
2407
|
+
* Criteria restricting which nodes are returned.
|
|
2408
|
+
* @public
|
|
2409
|
+
*/
|
|
2410
|
+
nodeFilters?: NodeFilters | undefined;
|
|
2411
|
+
/**
|
|
2412
|
+
* Criteria restricting which edges are returned.
|
|
2413
|
+
* @public
|
|
2414
|
+
*/
|
|
2415
|
+
edgeFilters?: EdgeFilters | undefined;
|
|
2416
|
+
/**
|
|
2417
|
+
* Start of the time range (UTC), inclusive.
|
|
2418
|
+
* @public
|
|
2419
|
+
*/
|
|
2420
|
+
startTime: Date | undefined;
|
|
2421
|
+
/**
|
|
2422
|
+
* End of the time range (UTC), inclusive.
|
|
2423
|
+
* @public
|
|
2424
|
+
*/
|
|
2425
|
+
endTime: Date | undefined;
|
|
2426
|
+
/**
|
|
2427
|
+
* How many hops to traverse out from the nodes matched by nodeFilters. 0 returns
|
|
2428
|
+
* only the matched nodes themselves.
|
|
2429
|
+
* @public
|
|
2430
|
+
*/
|
|
2431
|
+
depth?: number | undefined;
|
|
2432
|
+
/**
|
|
2433
|
+
* The maximum number of nodes to return in a single page.
|
|
2434
|
+
* @public
|
|
2435
|
+
*/
|
|
2436
|
+
maxResults?: number | undefined;
|
|
2437
|
+
/**
|
|
2438
|
+
* The maximum number of edges to return per node, bounding the fan-out of a
|
|
2439
|
+
* densely connected node.
|
|
2440
|
+
* @public
|
|
2441
|
+
*/
|
|
2442
|
+
maxEdgesPerNode?: number | undefined;
|
|
2443
|
+
/**
|
|
2444
|
+
* Whether to return the metadata block, semantics included, on each node and
|
|
2445
|
+
* edge. Off by default because it costs an extra lookup per returned node.
|
|
2446
|
+
* @public
|
|
2447
|
+
*/
|
|
2448
|
+
includeMetadata?: boolean | undefined;
|
|
2449
|
+
/**
|
|
2450
|
+
* Pagination token from a previous response, to retrieve the next page.
|
|
2451
|
+
* @public
|
|
2452
|
+
*/
|
|
2453
|
+
nextToken?: string | undefined;
|
|
2454
|
+
}
|
|
2455
|
+
/**
|
|
2456
|
+
* Additive traffic counters accumulated over an edge's observation window. Which
|
|
2457
|
+
* counters are populated depends on what produced the edge.
|
|
2458
|
+
* @public
|
|
2459
|
+
*/
|
|
2460
|
+
export interface EdgeTrafficStats {
|
|
2461
|
+
/**
|
|
2462
|
+
* Total bytes observed across the edge.
|
|
2463
|
+
* @public
|
|
2464
|
+
*/
|
|
2465
|
+
bytes?: number | undefined;
|
|
2466
|
+
/**
|
|
2467
|
+
* Total packets observed across the edge.
|
|
2468
|
+
* @public
|
|
2469
|
+
*/
|
|
2470
|
+
packets?: number | undefined;
|
|
2471
|
+
/**
|
|
2472
|
+
* Total network flows observed across the edge.
|
|
2473
|
+
* @public
|
|
2474
|
+
*/
|
|
2475
|
+
flows?: number | undefined;
|
|
2476
|
+
/**
|
|
2477
|
+
* Total bytes sent to the destination.
|
|
2478
|
+
* @public
|
|
2479
|
+
*/
|
|
2480
|
+
sentBytes?: number | undefined;
|
|
2481
|
+
/**
|
|
2482
|
+
* Total bytes received from the destination.
|
|
2483
|
+
* @public
|
|
2484
|
+
*/
|
|
2485
|
+
receivedBytes?: number | undefined;
|
|
2486
|
+
}
|
|
2487
|
+
/**
|
|
2488
|
+
* Edge attributes promoted out of the flat attribute map onto typed members.
|
|
2489
|
+
* Which members are present depends entirely on what produced the edge, so most
|
|
2490
|
+
* edges carry only a few of them.
|
|
2491
|
+
* @public
|
|
2492
|
+
*/
|
|
2493
|
+
export interface EdgeProperties {
|
|
2494
|
+
/**
|
|
2495
|
+
* The IANA protocol name for the observed network traffic, such as "tcp".
|
|
2496
|
+
* @public
|
|
2497
|
+
*/
|
|
2498
|
+
protocol?: string | undefined;
|
|
2499
|
+
/**
|
|
2500
|
+
* The source port of the observed traffic. May be a placeholder when the
|
|
2501
|
+
* port is unknown.
|
|
2502
|
+
* @public
|
|
2503
|
+
*/
|
|
2504
|
+
sourcePort?: string | undefined;
|
|
2505
|
+
/**
|
|
2506
|
+
* The destination port of the observed traffic. May be a placeholder when
|
|
2507
|
+
* the port is unknown.
|
|
2508
|
+
* @public
|
|
2509
|
+
*/
|
|
2510
|
+
destinationPort?: string | undefined;
|
|
2511
|
+
/**
|
|
2512
|
+
* Whether the observed network flow was denied. Absent means the edge was
|
|
2513
|
+
* not derived from network flow data, which is not the same as allowed.
|
|
2514
|
+
* @public
|
|
2515
|
+
*/
|
|
2516
|
+
blocked?: boolean | undefined;
|
|
2517
|
+
/**
|
|
2518
|
+
* The error code returned when the call was attempted and refused. Its
|
|
2519
|
+
* presence means the edge exists but the dependency is failing.
|
|
2520
|
+
* @public
|
|
2521
|
+
*/
|
|
2522
|
+
errorCode?: string | undefined;
|
|
2523
|
+
/**
|
|
2524
|
+
* The HTTP status code observed on the request. Distinct from errorCode.
|
|
2525
|
+
* @public
|
|
2526
|
+
*/
|
|
2527
|
+
httpStatusCode?: string | undefined;
|
|
2528
|
+
/**
|
|
2529
|
+
* The HTTP method observed on the request.
|
|
2530
|
+
* @public
|
|
2531
|
+
*/
|
|
2532
|
+
httpMethod?: string | undefined;
|
|
2533
|
+
/**
|
|
2534
|
+
* Whether the caller was an AWS service principal rather than a user or
|
|
2535
|
+
* role. Absent means the edge was not derived from a source that reports it.
|
|
2536
|
+
* @public
|
|
2537
|
+
*/
|
|
2538
|
+
serviceInitiated?: boolean | undefined;
|
|
2539
|
+
/**
|
|
2540
|
+
* Traffic counters accumulated over the edge's observation window.
|
|
2541
|
+
* @public
|
|
2542
|
+
*/
|
|
2543
|
+
trafficStats?: EdgeTrafficStats | undefined;
|
|
2544
|
+
}
|
|
2545
|
+
/**
|
|
2546
|
+
* One LOGS query selector block on a node. The `attributes` map's keys are AND'd; each selects with
|
|
2547
|
+
* `col = value`. Deliberately RAW/un-normalized so the selector matches the store, not the node's
|
|
2548
|
+
* merged identity.
|
|
2549
|
+
* @public
|
|
2550
|
+
*/
|
|
2551
|
+
export interface LogMetadata {
|
|
2552
|
+
/**
|
|
2553
|
+
* One LOGS query-selector block: EXACT store column -> raw SCALAR value (mirroring the scalar
|
|
2554
|
+
* MetadataAttributeMap). Keyed by the store column that carries the value (e.g.
|
|
2555
|
+
* `resource.attributes['service.name']`, `attributes['aws.local.service']`, `@logGroupName`) so the
|
|
2556
|
+
* selector matches the emitted signal. A dimension seen under several values (a service under two
|
|
2557
|
+
* namespaces, several log groups) becomes several blocks with the same columns and different
|
|
2558
|
+
* values, which the console ORs. Dedicated to the LOGS selector so its cap evolves independently of
|
|
2559
|
+
* the metric attribute map and the TRACES map. Selector caps are deliberately DISTINCT from the metric caps.
|
|
2560
|
+
* @public
|
|
2561
|
+
*/
|
|
2562
|
+
attributes?: Record<string, string> | undefined;
|
|
2563
|
+
}
|
|
2564
|
+
/**
|
|
2565
|
+
* The meaning and unit of a single metric.
|
|
2566
|
+
* @public
|
|
2567
|
+
*/
|
|
2568
|
+
export interface MetricSemantics {
|
|
2569
|
+
/**
|
|
2570
|
+
* Human-readable description of what the metric measures.
|
|
2571
|
+
* @public
|
|
2572
|
+
*/
|
|
2573
|
+
description?: string | undefined;
|
|
2574
|
+
/**
|
|
2575
|
+
* The unit the metric is reported in.
|
|
2576
|
+
* @public
|
|
2577
|
+
*/
|
|
2578
|
+
unit?: string | undefined;
|
|
2579
|
+
}
|
|
2580
|
+
/**
|
|
2581
|
+
* A single metric observed on a context graph node.
|
|
2582
|
+
* @public
|
|
2583
|
+
*/
|
|
2584
|
+
export interface MetricMetadata {
|
|
2585
|
+
/**
|
|
2586
|
+
* The metric name as emitted, such as "Duration".
|
|
2587
|
+
* @public
|
|
2588
|
+
*/
|
|
2589
|
+
name?: string | undefined;
|
|
2590
|
+
/**
|
|
2591
|
+
* DEPRECATED: read attributes["service.namespace"] instead. Retained (deprecated) for
|
|
2592
|
+
* backward compatibility with existing consumers; will be removed once they migrate. The
|
|
2593
|
+
* logical service grouping the metric belongs to.
|
|
2594
|
+
*
|
|
2595
|
+
* @deprecated (since 2026-08-19) Use attributes['service.namespace']; retained for backward compatibility.
|
|
2596
|
+
* @public
|
|
2597
|
+
*/
|
|
2598
|
+
namespace?: string | undefined;
|
|
2599
|
+
/**
|
|
2600
|
+
* The statistic to chart or alarm on, such as "p99" or "Sum". Free-form and
|
|
2601
|
+
* frequently absent.
|
|
2602
|
+
* @public
|
|
2603
|
+
*/
|
|
2604
|
+
preferredStat?: string | undefined;
|
|
2605
|
+
/**
|
|
2606
|
+
* OTel metric kind: "gauge", "sum", "histogram", "exponential_histogram", or "summary"
|
|
2607
|
+
* (CloudWatch-vended metrics carry the same kinds). Absent when the producer did not
|
|
2608
|
+
* report one.
|
|
2609
|
+
* @public
|
|
2610
|
+
*/
|
|
2611
|
+
metricType?: string | undefined;
|
|
2612
|
+
/**
|
|
2613
|
+
* Per-metric qualifying attributes the console uses to query this metric's telemetry.
|
|
2614
|
+
* These are the RAW, store-matching values keyed by their OTel names ("service.name",
|
|
2615
|
+
* "service.namespace", "cloud.provider", "cloud.account.id", "cloud.region",
|
|
2616
|
+
* "instrumentation_scope") — deliberately NOT the node's normalized/merged identity, so
|
|
2617
|
+
* the query selectors match the emitted series. A merged node can carry different values
|
|
2618
|
+
* per metric, which is why they live here rather than on the node.
|
|
2619
|
+
* @public
|
|
2620
|
+
*/
|
|
2621
|
+
attributes?: Record<string, string> | undefined;
|
|
2622
|
+
/**
|
|
2623
|
+
* What the metric means and the unit it is reported in.
|
|
2624
|
+
* @public
|
|
2625
|
+
*/
|
|
2626
|
+
semantics?: MetricSemantics | undefined;
|
|
2627
|
+
}
|
|
2628
|
+
/**
|
|
2629
|
+
* Semantic description of the service a context graph node represents.
|
|
2630
|
+
* @public
|
|
2631
|
+
*/
|
|
2632
|
+
export interface NodeSemantics {
|
|
2633
|
+
/**
|
|
2634
|
+
* What the service does.
|
|
2635
|
+
* @public
|
|
2636
|
+
*/
|
|
2637
|
+
purpose?: string | undefined;
|
|
2638
|
+
/**
|
|
2639
|
+
* The primary programming language the service is written in.
|
|
2640
|
+
* @public
|
|
2641
|
+
*/
|
|
2642
|
+
language?: string | undefined;
|
|
2643
|
+
/**
|
|
2644
|
+
* The application framework the service is built on.
|
|
2645
|
+
* @public
|
|
2646
|
+
*/
|
|
2647
|
+
framework?: string | undefined;
|
|
2648
|
+
/**
|
|
2649
|
+
* The kind of workload the service is.
|
|
2650
|
+
* @public
|
|
2651
|
+
*/
|
|
2652
|
+
kind?: string | undefined;
|
|
2653
|
+
/**
|
|
2654
|
+
* The source repository the service is built from.
|
|
2655
|
+
* @public
|
|
2656
|
+
*/
|
|
2657
|
+
repository?: string | undefined;
|
|
2658
|
+
}
|
|
2659
|
+
/**
|
|
2660
|
+
* One TRACES query selector block on a node/edge (see LogMetadata).
|
|
2661
|
+
* @public
|
|
2662
|
+
*/
|
|
2663
|
+
export interface TraceMetadata {
|
|
2664
|
+
/**
|
|
2665
|
+
* TRACES counterpart of LogMetadataAttributeMap — a dedicated per-signal map so the two evolve
|
|
2666
|
+
* independently (same scalar shape and cap today).
|
|
2667
|
+
* @public
|
|
2668
|
+
*/
|
|
2669
|
+
attributes?: Record<string, string> | undefined;
|
|
2670
|
+
}
|
|
2671
|
+
/**
|
|
2672
|
+
* Descriptive information about a context graph node or edge, as opposed to its
|
|
2673
|
+
* identity and structure. Returned only when the request sets includeMetadata.
|
|
2674
|
+
* @public
|
|
2675
|
+
*/
|
|
2676
|
+
export interface Metadata {
|
|
2677
|
+
/**
|
|
2678
|
+
* The metrics observed on the element.
|
|
2679
|
+
* @public
|
|
2680
|
+
*/
|
|
2681
|
+
metrics?: MetricMetadata[] | undefined;
|
|
2682
|
+
/**
|
|
2683
|
+
* Semantic description of the node. Absent on an edge, because semantics
|
|
2684
|
+
* describe a service rather than a relationship.
|
|
2685
|
+
* @public
|
|
2686
|
+
*/
|
|
2687
|
+
semantics?: NodeSemantics | undefined;
|
|
2688
|
+
/**
|
|
2689
|
+
* Per-signal LOGS query selectors: a LIST of blocks the console ORs, each an AND of exact
|
|
2690
|
+
* store column -> raw values. Node-level (edges carry only traces). Populated when the request
|
|
2691
|
+
* sets includeMetadata; derived labels (logSourceType) are added by the service projection, not
|
|
2692
|
+
* stored here.
|
|
2693
|
+
* @public
|
|
2694
|
+
*/
|
|
2695
|
+
logs?: LogMetadata[] | undefined;
|
|
2696
|
+
/**
|
|
2697
|
+
* Per-signal TRACES query selectors (same block shape as logs). Present on both node and edge
|
|
2698
|
+
* metadata. serviceName is derived at the service projection, not stored here.
|
|
2699
|
+
* @public
|
|
2700
|
+
*/
|
|
2701
|
+
traces?: TraceMetadata[] | undefined;
|
|
2702
|
+
}
|
|
2703
|
+
/**
|
|
2704
|
+
* A directed edge in the context graph connecting two nodes.
|
|
2705
|
+
* @public
|
|
2706
|
+
*/
|
|
2707
|
+
export interface Edge {
|
|
2708
|
+
/**
|
|
2709
|
+
* The unique identifier of the edge within the context graph.
|
|
2710
|
+
* @public
|
|
2711
|
+
*/
|
|
2712
|
+
edgeId?: string | undefined;
|
|
2713
|
+
/**
|
|
2714
|
+
* The node identifier the edge originates from.
|
|
2715
|
+
* @public
|
|
2716
|
+
*/
|
|
2717
|
+
from?: string | undefined;
|
|
2718
|
+
/**
|
|
2719
|
+
* The node identifier the edge points to.
|
|
2720
|
+
* @public
|
|
2721
|
+
*/
|
|
2722
|
+
to?: string | undefined;
|
|
2723
|
+
/**
|
|
2724
|
+
* The kind of relationship the edge represents.
|
|
2725
|
+
* @public
|
|
2726
|
+
*/
|
|
2727
|
+
edgeType?: EdgeType | undefined;
|
|
2728
|
+
/**
|
|
2729
|
+
* The operations observed on this edge.
|
|
2730
|
+
* @public
|
|
2731
|
+
*/
|
|
2732
|
+
operations?: string[] | undefined;
|
|
2733
|
+
/**
|
|
2734
|
+
* Attributes promoted out of the flat attribute map onto typed members. Which
|
|
2735
|
+
* members are present depends on what produced the edge.
|
|
2736
|
+
* @public
|
|
2737
|
+
*/
|
|
2738
|
+
edgeProperties?: EdgeProperties | undefined;
|
|
2739
|
+
/**
|
|
2740
|
+
* The edge's OpenTelemetry (OTel) attributes, as emitted by telemetry. A key
|
|
2741
|
+
* promoted onto an `edgeProperties` member is removed here, so no value appears twice.
|
|
2742
|
+
* @public
|
|
2743
|
+
*/
|
|
2744
|
+
telemetryAttributes?: Record<string, string> | undefined;
|
|
2745
|
+
/**
|
|
2746
|
+
* The kinds of telemetry signal observed on this edge.
|
|
2747
|
+
* @public
|
|
2748
|
+
*/
|
|
2749
|
+
signalTypes?: Signal[] | undefined;
|
|
2750
|
+
/**
|
|
2751
|
+
* The discovery sources that contributed this edge.
|
|
2752
|
+
* @public
|
|
2753
|
+
*/
|
|
2754
|
+
sources?: Source[] | undefined;
|
|
2755
|
+
/**
|
|
2756
|
+
* Descriptive metadata about the edge. Present only when the request sets
|
|
2757
|
+
* includeMetadata.
|
|
2758
|
+
* @public
|
|
2759
|
+
*/
|
|
2760
|
+
metadata?: Metadata | undefined;
|
|
2761
|
+
/**
|
|
2762
|
+
* When this edge was first observed (UTC), at minute granularity. For an edge
|
|
2763
|
+
* that merged across sources, this is the earliest value any source reported.
|
|
2764
|
+
* @public
|
|
2765
|
+
*/
|
|
2766
|
+
firstObservedAt?: Date | undefined;
|
|
2767
|
+
/**
|
|
2768
|
+
* When this edge was most recently observed (UTC), at minute granularity. For an
|
|
2769
|
+
* edge that merged across sources, this is the latest value any source reported.
|
|
2770
|
+
* @public
|
|
2771
|
+
*/
|
|
2772
|
+
lastObservedAt?: Date | undefined;
|
|
2773
|
+
}
|
|
2774
|
+
/**
|
|
2775
|
+
* Node identity attributes promoted out of the flat attribute map onto typed
|
|
2776
|
+
* members. The first four are part of the node's merge key, so a node that merged
|
|
2777
|
+
* across sources reports one resolved value for each.
|
|
2778
|
+
* @public
|
|
2779
|
+
*/
|
|
2780
|
+
export interface NodeProperties {
|
|
2781
|
+
/**
|
|
2782
|
+
* The region the node runs in. Falls back to the region the telemetry was
|
|
2783
|
+
* ingested from when the node does not report one.
|
|
2784
|
+
* @public
|
|
2785
|
+
*/
|
|
2786
|
+
region?: string | undefined;
|
|
2787
|
+
/**
|
|
2788
|
+
* The cloud provider hosting the node, resolved from the reported provider,
|
|
2789
|
+
* platform, or vendor namespace, and defaulting to "aws".
|
|
2790
|
+
* @public
|
|
2791
|
+
*/
|
|
2792
|
+
cloudProvider?: string | undefined;
|
|
2793
|
+
/**
|
|
2794
|
+
* The account that produced the telemetry this node was discovered from.
|
|
2795
|
+
* @public
|
|
2796
|
+
*/
|
|
2797
|
+
sourceAccountId?: string | undefined;
|
|
2798
|
+
/**
|
|
2799
|
+
* The logical service grouping the node belongs to. This is not a metric
|
|
2800
|
+
* namespace.
|
|
2801
|
+
* @public
|
|
2802
|
+
*/
|
|
2803
|
+
namespace?: string | undefined;
|
|
2804
|
+
/**
|
|
2805
|
+
* What kind of thing the node is, coarser than nodeType.
|
|
2806
|
+
* @public
|
|
2807
|
+
*/
|
|
2808
|
+
category?: NodeCategory | undefined;
|
|
2809
|
+
/**
|
|
2810
|
+
* The node's deployment environment. A node may be observed in several; this is
|
|
2811
|
+
* the highest-precedence one. Match any of them with NodeFilters.stage.
|
|
2812
|
+
* @public
|
|
2813
|
+
*/
|
|
2814
|
+
stage?: string | undefined;
|
|
2815
|
+
}
|
|
2816
|
+
/**
|
|
2817
|
+
* A node in the context graph representing a service, resource, or remote service.
|
|
2818
|
+
* @public
|
|
2819
|
+
*/
|
|
2820
|
+
export interface Node {
|
|
2821
|
+
/**
|
|
2822
|
+
* The unique identifier of the node within the context graph.
|
|
2823
|
+
* @public
|
|
2824
|
+
*/
|
|
2825
|
+
nodeId?: string | undefined;
|
|
2826
|
+
/**
|
|
2827
|
+
* Whether the node is a service, a resource, or a remote service.
|
|
2828
|
+
* @public
|
|
2829
|
+
*/
|
|
2830
|
+
nodeType?: NodeType | undefined;
|
|
2831
|
+
/**
|
|
2832
|
+
* The primary display name of the node.
|
|
2833
|
+
* @public
|
|
2834
|
+
*/
|
|
2835
|
+
name?: string | undefined;
|
|
2836
|
+
/**
|
|
2837
|
+
* Other names this node was observed under. A node that merged across sources
|
|
2838
|
+
* reports one resolved name, and the names it was merged away from appear here.
|
|
2839
|
+
* @public
|
|
2840
|
+
*/
|
|
2841
|
+
alternateNames?: string[] | undefined;
|
|
2842
|
+
/**
|
|
2843
|
+
* The tags observed on the underlying resource.
|
|
2844
|
+
* @public
|
|
2845
|
+
*/
|
|
2846
|
+
tags?: Record<string, string> | undefined;
|
|
2847
|
+
/**
|
|
2848
|
+
* Identity attributes promoted out of the flat attribute map onto typed members.
|
|
2849
|
+
* @public
|
|
2850
|
+
*/
|
|
2851
|
+
nodeProperties?: NodeProperties | undefined;
|
|
2852
|
+
/**
|
|
2853
|
+
* The node's OpenTelemetry (OTel) attributes, as emitted by telemetry — the raw
|
|
2854
|
+
* values, as opposed to the normalized `nodeProperties`. A key promoted onto a
|
|
2855
|
+
* `nodeProperties` member is removed here, so no value appears twice.
|
|
2856
|
+
* @public
|
|
2857
|
+
*/
|
|
2858
|
+
telemetryAttributes?: Record<string, string> | undefined;
|
|
2859
|
+
/**
|
|
2860
|
+
* The operations observed on this node, keyed by operation name. Each value
|
|
2861
|
+
* lists the dimension sets that identify the metric series for that operation.
|
|
2862
|
+
* @public
|
|
2863
|
+
*/
|
|
2864
|
+
operationDetails?: Record<string, Record<string, string>[]> | undefined;
|
|
2865
|
+
/**
|
|
2866
|
+
* The kinds of telemetry signal observed on this node.
|
|
2867
|
+
* @public
|
|
2868
|
+
*/
|
|
2869
|
+
signalTypes?: Signal[] | undefined;
|
|
2870
|
+
/**
|
|
2871
|
+
* The discovery sources that contributed this node.
|
|
2872
|
+
* @public
|
|
2873
|
+
*/
|
|
2874
|
+
sources?: Source[] | undefined;
|
|
2875
|
+
/**
|
|
2876
|
+
* Descriptive metadata about the node. Present only when the request sets
|
|
2877
|
+
* includeMetadata.
|
|
2878
|
+
* @public
|
|
2879
|
+
*/
|
|
2880
|
+
metadata?: Metadata | undefined;
|
|
2881
|
+
/**
|
|
2882
|
+
* When this node was first observed (UTC), at minute granularity. For a node
|
|
2883
|
+
* that merged across sources, this is the earliest value any source reported.
|
|
2884
|
+
* @public
|
|
2885
|
+
*/
|
|
2886
|
+
firstObservedAt?: Date | undefined;
|
|
2887
|
+
/**
|
|
2888
|
+
* When this node was most recently observed (UTC), at minute granularity. For a
|
|
2889
|
+
* node that merged across sources, this is the latest value any source reported.
|
|
2890
|
+
* @public
|
|
2891
|
+
*/
|
|
2892
|
+
lastObservedAt?: Date | undefined;
|
|
2893
|
+
/**
|
|
2894
|
+
* Outbound edges originating from this node. Each edge carries its `from`.
|
|
2895
|
+
* @public
|
|
2896
|
+
*/
|
|
2897
|
+
edges?: Edge[] | undefined;
|
|
2898
|
+
}
|
|
2899
|
+
/**
|
|
2900
|
+
* The response containing the requested slice of the context graph.
|
|
2901
|
+
* @public
|
|
2902
|
+
*/
|
|
2903
|
+
export interface GetContextGraphOutput {
|
|
2904
|
+
/**
|
|
2905
|
+
* The page of nodes matching the request. This is the paginated collection.
|
|
2906
|
+
* @public
|
|
2907
|
+
*/
|
|
2908
|
+
nodes: Node[] | undefined;
|
|
2909
|
+
/**
|
|
2910
|
+
* Pagination token for the next page; absent when there are no more results.
|
|
2911
|
+
* @public
|
|
2912
|
+
*/
|
|
2913
|
+
nextToken?: string | undefined;
|
|
2914
|
+
}
|
|
2915
|
+
/**
|
|
2916
|
+
* @public
|
|
2917
|
+
*/
|
|
2918
|
+
export interface GetDomainInput {
|
|
2919
|
+
/**
|
|
2920
|
+
* The unique ID of the domain.
|
|
2921
|
+
* @public
|
|
2922
|
+
*/
|
|
2923
|
+
domainId: string | undefined;
|
|
2924
|
+
}
|
|
2925
|
+
/**
|
|
2926
|
+
* @public
|
|
2927
|
+
*/
|
|
2928
|
+
export interface GetDomainOutput {
|
|
2929
|
+
/**
|
|
2930
|
+
* The details of the domain.
|
|
2931
|
+
* @public
|
|
2932
|
+
*/
|
|
2933
|
+
domain: Domain | undefined;
|
|
2934
|
+
}
|
|
2935
|
+
/**
|
|
2936
|
+
* @public
|
|
2937
|
+
*/
|
|
2938
|
+
export interface GetDomainAccessGrantForOrganizationInput {
|
|
2939
|
+
/**
|
|
2940
|
+
* The ID of the access grant to retrieve.
|
|
2941
|
+
* @public
|
|
2942
|
+
*/
|
|
2943
|
+
grantId: string | undefined;
|
|
2944
|
+
}
|
|
2945
|
+
/**
|
|
2946
|
+
* @public
|
|
2947
|
+
*/
|
|
2948
|
+
export interface GetDomainAccessGrantForOrganizationOutput {
|
|
2949
|
+
/**
|
|
2950
|
+
* The retrieved organization access grant.
|
|
2951
|
+
* @public
|
|
2952
|
+
*/
|
|
2953
|
+
accessGrant: OrganizationAccessGrant | undefined;
|
|
2954
|
+
}
|
|
2955
|
+
/**
|
|
2956
|
+
* @public
|
|
2957
|
+
*/
|
|
2958
|
+
export interface GetDomainForOrganizationInput {
|
|
2959
|
+
/**
|
|
2960
|
+
* The ID of the organization domain.
|
|
2961
|
+
* @public
|
|
2962
|
+
*/
|
|
2963
|
+
domainId: string | undefined;
|
|
2964
|
+
}
|
|
2965
|
+
/**
|
|
2966
|
+
* @public
|
|
2967
|
+
*/
|
|
2968
|
+
export interface GetDomainForOrganizationOutput {
|
|
2969
|
+
/**
|
|
2970
|
+
* The details of the organization domain.
|
|
2971
|
+
* @public
|
|
2972
|
+
*/
|
|
2973
|
+
organizationDomain: OrganizationDomain | undefined;
|
|
2974
|
+
}
|
|
2975
|
+
/**
|
|
2976
|
+
* The request for retrieving a single integration.
|
|
2977
|
+
* @public
|
|
2978
|
+
*/
|
|
2979
|
+
export interface GetIntegrationInput {
|
|
2980
|
+
/**
|
|
2981
|
+
* Identifies the integration to return — exactly one of integrationId,
|
|
2982
|
+
* integrationArn, or integrationName.
|
|
2983
|
+
* @public
|
|
2984
|
+
*/
|
|
2985
|
+
identifier: IntegrationIdentifier | undefined;
|
|
2986
|
+
}
|
|
2987
|
+
/**
|
|
2988
|
+
* The response containing the requested integration.
|
|
2989
|
+
* @public
|
|
2990
|
+
*/
|
|
2991
|
+
export interface GetIntegrationOutput {
|
|
2992
|
+
/**
|
|
2993
|
+
* The details of the requested integration.
|
|
2994
|
+
* @public
|
|
2995
|
+
*/
|
|
2996
|
+
integration: Integration | undefined;
|
|
2997
|
+
}
|
|
2998
|
+
/**
|
|
2999
|
+
* The request for retrieving the intelligence configuration of the calling account.
|
|
3000
|
+
* @public
|
|
3001
|
+
*/
|
|
3002
|
+
export interface GetIntelligenceConfigurationInput {
|
|
3003
|
+
}
|
|
3004
|
+
/**
|
|
3005
|
+
* The intelligence configuration for the calling account.
|
|
3006
|
+
* @public
|
|
3007
|
+
*/
|
|
3008
|
+
export interface GetIntelligenceConfigurationOutput {
|
|
3009
|
+
/**
|
|
3010
|
+
* The AWS account ID this configuration applies to.
|
|
3011
|
+
* @public
|
|
3012
|
+
*/
|
|
3013
|
+
accountId: string | undefined;
|
|
3014
|
+
/**
|
|
3015
|
+
* The currently active KMS key ARN for customer-managed encryption, if configured.
|
|
3016
|
+
* @public
|
|
3017
|
+
*/
|
|
3018
|
+
kmsKeyArn?: string | undefined;
|
|
3019
|
+
/**
|
|
3020
|
+
* ISO-8601 timestamp of the last update.
|
|
3021
|
+
* @public
|
|
3022
|
+
*/
|
|
3023
|
+
updatedAt: Date | undefined;
|
|
3024
|
+
/**
|
|
3025
|
+
* ISO-8601 timestamp of initial creation.
|
|
3026
|
+
* @public
|
|
3027
|
+
*/
|
|
3028
|
+
createdAt: Date | undefined;
|
|
3029
|
+
}
|
|
3030
|
+
/**
|
|
3031
|
+
* @public
|
|
3032
|
+
*/
|
|
3033
|
+
export interface GetOmniDashboardInput {
|
|
3034
|
+
/**
|
|
3035
|
+
* The unique ID of the space.
|
|
3036
|
+
* @public
|
|
3037
|
+
*/
|
|
3038
|
+
spaceId: string | undefined;
|
|
3039
|
+
/**
|
|
3040
|
+
* The unique ID of the dashboard.
|
|
3041
|
+
* @public
|
|
3042
|
+
*/
|
|
3043
|
+
dashboardId: string | undefined;
|
|
3044
|
+
}
|
|
3045
|
+
/**
|
|
3046
|
+
* @public
|
|
3047
|
+
*/
|
|
3048
|
+
export interface GetOmniDashboardOutput {
|
|
3049
|
+
/**
|
|
3050
|
+
* The dashboard.
|
|
3051
|
+
* @public
|
|
3052
|
+
*/
|
|
3053
|
+
omniDashboard: OmniDashboard | undefined;
|
|
3054
|
+
}
|
|
3055
|
+
/**
|
|
3056
|
+
* @public
|
|
3057
|
+
*/
|
|
3058
|
+
export interface GetSpaceInput {
|
|
3059
|
+
/**
|
|
3060
|
+
* The unique ID of the space.
|
|
3061
|
+
* @public
|
|
3062
|
+
*/
|
|
3063
|
+
spaceId: string | undefined;
|
|
3064
|
+
}
|
|
3065
|
+
/**
|
|
3066
|
+
* @public
|
|
3067
|
+
*/
|
|
3068
|
+
export interface GetSpaceOutput {
|
|
3069
|
+
/**
|
|
3070
|
+
* The details of the space.
|
|
3071
|
+
* @public
|
|
3072
|
+
*/
|
|
3073
|
+
space: Space | undefined;
|
|
3074
|
+
}
|
|
3075
|
+
/**
|
|
3076
|
+
* Identifies what the credentials are for: either an existing space, or a target
|
|
3077
|
+
* account in a domain. Specify spaceId, or both domainId and targetAccountId.
|
|
3078
|
+
* @public
|
|
3079
|
+
*/
|
|
3080
|
+
export interface SpaceCredentialRequestContext {
|
|
3081
|
+
/**
|
|
3082
|
+
* The ID of an existing space to return credentials for.
|
|
3083
|
+
* @public
|
|
3084
|
+
*/
|
|
3085
|
+
spaceId?: string | undefined;
|
|
3086
|
+
/**
|
|
3087
|
+
* The ID of the domain, when returning credentials for a target account that
|
|
3088
|
+
* does not yet have a space.
|
|
3089
|
+
* @public
|
|
3090
|
+
*/
|
|
3091
|
+
domainId?: string | undefined;
|
|
3092
|
+
/**
|
|
3093
|
+
* The ID of the target member account. Required when domainId is set.
|
|
3094
|
+
* @public
|
|
3095
|
+
*/
|
|
3096
|
+
targetAccountId?: string | undefined;
|
|
3097
|
+
}
|
|
3098
|
+
/**
|
|
3099
|
+
* @public
|
|
3100
|
+
*/
|
|
3101
|
+
export interface GetSpaceCredentialsForOrganizationInput {
|
|
3102
|
+
/**
|
|
3103
|
+
* Context for credential resolution.
|
|
3104
|
+
* @public
|
|
3105
|
+
*/
|
|
3106
|
+
context: SpaceCredentialRequestContext | undefined;
|
|
3107
|
+
/**
|
|
3108
|
+
* Selects which member-account credential to return. Set this to SPACE_OPERATION.
|
|
3109
|
+
* @public
|
|
3110
|
+
*/
|
|
3111
|
+
credentialType: OrganizationCredentialType | undefined;
|
|
3112
|
+
}
|
|
3113
|
+
/**
|
|
3114
|
+
* @public
|
|
3115
|
+
*/
|
|
3116
|
+
export interface GetSpaceCredentialsForOrganizationOutput {
|
|
3117
|
+
/**
|
|
3118
|
+
* The temporary AWS credentials for the space.
|
|
3119
|
+
* @public
|
|
3120
|
+
*/
|
|
3121
|
+
credentials: AwsCredentials | undefined;
|
|
3122
|
+
}
|
|
3123
|
+
/**
|
|
3124
|
+
* @public
|
|
3125
|
+
*/
|
|
3126
|
+
export interface GetTelemetryQueryResultsRequest {
|
|
3127
|
+
/**
|
|
3128
|
+
* The unique ID of the query.
|
|
3129
|
+
* @public
|
|
3130
|
+
*/
|
|
3131
|
+
queryId: string | undefined;
|
|
3132
|
+
/**
|
|
3133
|
+
* A token to retrieve the next page of results.
|
|
3134
|
+
* @public
|
|
3135
|
+
*/
|
|
3136
|
+
nextToken?: string | undefined;
|
|
3137
|
+
/**
|
|
3138
|
+
* The maximum number of result rows to return per page.
|
|
3139
|
+
* @public
|
|
3140
|
+
*/
|
|
3141
|
+
maxResults?: number | undefined;
|
|
3142
|
+
}
|
|
3143
|
+
/**
|
|
3144
|
+
* Indicates whether a query returned partial results.
|
|
3145
|
+
* @public
|
|
3146
|
+
*/
|
|
3147
|
+
export interface PartialResults {
|
|
3148
|
+
/**
|
|
3149
|
+
* True when the query returned partial results (some data could not be read).
|
|
3150
|
+
* @public
|
|
3151
|
+
*/
|
|
3152
|
+
partialResultsDetected?: boolean | undefined;
|
|
3153
|
+
}
|
|
3154
|
+
/**
|
|
3155
|
+
* Statistics about a telemetry query execution.
|
|
3156
|
+
* @public
|
|
3157
|
+
*/
|
|
3158
|
+
export interface QueryStatistics {
|
|
3159
|
+
/**
|
|
3160
|
+
* The number of bytes scanned by the query.
|
|
3161
|
+
* @public
|
|
3162
|
+
*/
|
|
3163
|
+
bytesScanned?: number | undefined;
|
|
3164
|
+
/**
|
|
3165
|
+
* The percentage of the query that has completed.
|
|
3166
|
+
* @public
|
|
3167
|
+
*/
|
|
3168
|
+
percentComplete?: number | undefined;
|
|
3169
|
+
/**
|
|
3170
|
+
* The total number of records scanned.
|
|
3171
|
+
* @public
|
|
3172
|
+
*/
|
|
3173
|
+
recordsScanned?: number | undefined;
|
|
3174
|
+
/**
|
|
3175
|
+
* The number of records that matched the query criteria.
|
|
3176
|
+
* @public
|
|
3177
|
+
*/
|
|
3178
|
+
recordsMatched?: number | undefined;
|
|
3179
|
+
/**
|
|
3180
|
+
* Information about whether the query returned partial results.
|
|
3181
|
+
* @public
|
|
3182
|
+
*/
|
|
3183
|
+
partialResults?: PartialResults | undefined;
|
|
3184
|
+
}
|
|
3185
|
+
/**
|
|
3186
|
+
* @public
|
|
3187
|
+
*/
|
|
3188
|
+
export interface GetTelemetryQueryResultsResponse {
|
|
3189
|
+
/**
|
|
3190
|
+
* The current execution status of the query.
|
|
3191
|
+
* @public
|
|
3192
|
+
*/
|
|
3193
|
+
status: QueryStatus | undefined;
|
|
3194
|
+
/**
|
|
3195
|
+
* The result rows returned by the query.
|
|
3196
|
+
* @public
|
|
3197
|
+
*/
|
|
3198
|
+
rows?: Record<string, string>[] | undefined;
|
|
3199
|
+
/**
|
|
3200
|
+
* A token to retrieve the next page of results, or null if there are no more results.
|
|
3201
|
+
* @public
|
|
3202
|
+
*/
|
|
3203
|
+
nextToken?: string | undefined;
|
|
3204
|
+
/**
|
|
3205
|
+
* Statistics about the query execution.
|
|
3206
|
+
* @public
|
|
3207
|
+
*/
|
|
3208
|
+
statistics?: QueryStatistics | undefined;
|
|
3209
|
+
}
|
|
3210
|
+
/**
|
|
3211
|
+
* @public
|
|
3212
|
+
*/
|
|
3213
|
+
export interface GetViewRequest {
|
|
3214
|
+
/**
|
|
3215
|
+
* The name of the view.
|
|
3216
|
+
* @public
|
|
3217
|
+
*/
|
|
3218
|
+
name: string | undefined;
|
|
3219
|
+
}
|
|
3220
|
+
/**
|
|
3221
|
+
* @public
|
|
3222
|
+
*/
|
|
3223
|
+
export interface GetViewResponse {
|
|
3224
|
+
/**
|
|
3225
|
+
* The name of the view.
|
|
3226
|
+
* @public
|
|
3227
|
+
*/
|
|
3228
|
+
name: string | undefined;
|
|
3229
|
+
/**
|
|
3230
|
+
* The ownership category of the view.
|
|
3231
|
+
* @public
|
|
3232
|
+
*/
|
|
3233
|
+
type: ViewType | undefined;
|
|
3234
|
+
/**
|
|
3235
|
+
* The description of the view.
|
|
3236
|
+
* @public
|
|
3237
|
+
*/
|
|
3238
|
+
description?: string | undefined;
|
|
3239
|
+
/**
|
|
3240
|
+
* The SQL query that defines the view.
|
|
3241
|
+
* @public
|
|
3242
|
+
*/
|
|
3243
|
+
definition: string | undefined;
|
|
3244
|
+
/**
|
|
3245
|
+
* The timestamp when the view was created.
|
|
3246
|
+
* @public
|
|
3247
|
+
*/
|
|
3248
|
+
createdAt: Date | undefined;
|
|
3249
|
+
/**
|
|
3250
|
+
* The timestamp when the view was last updated.
|
|
3251
|
+
* @public
|
|
3252
|
+
*/
|
|
3253
|
+
updatedAt: Date | undefined;
|
|
3254
|
+
/**
|
|
3255
|
+
* The ARN of the view.
|
|
3256
|
+
* @public
|
|
3257
|
+
*/
|
|
3258
|
+
arn: string | undefined;
|
|
3259
|
+
}
|
|
3260
|
+
/**
|
|
3261
|
+
* @public
|
|
3262
|
+
*/
|
|
3263
|
+
export interface ListAccessGrantsInput {
|
|
3264
|
+
/**
|
|
3265
|
+
* Filter by domain ID.
|
|
3266
|
+
* @public
|
|
3267
|
+
*/
|
|
3268
|
+
domainId?: string | undefined;
|
|
3269
|
+
/**
|
|
3270
|
+
* Filter by space ID.
|
|
3271
|
+
* @public
|
|
3272
|
+
*/
|
|
3273
|
+
spaceId?: string | undefined;
|
|
3274
|
+
/**
|
|
3275
|
+
* Filter by principal ID.
|
|
3276
|
+
* @public
|
|
3277
|
+
*/
|
|
3278
|
+
principalId?: string | undefined;
|
|
3279
|
+
/**
|
|
3280
|
+
* Filter by principal type.
|
|
3281
|
+
* @public
|
|
3282
|
+
*/
|
|
3283
|
+
principalType?: AccessGrantPrincipalType | undefined;
|
|
3284
|
+
/**
|
|
3285
|
+
* Filter by permission level.
|
|
3286
|
+
* @public
|
|
3287
|
+
*/
|
|
3288
|
+
permission?: AccessGrantPermission | undefined;
|
|
3289
|
+
/**
|
|
3290
|
+
* A token to retrieve the next page of results. Supply the same filters used
|
|
3291
|
+
* on the request that returned it. Tokens expire after 24 hours.
|
|
3292
|
+
* @public
|
|
3293
|
+
*/
|
|
3294
|
+
nextToken?: string | undefined;
|
|
3295
|
+
/**
|
|
3296
|
+
* The maximum number of access grants to return per page. Defaults to 100.
|
|
3297
|
+
* A page can contain fewer results than this value even when more results
|
|
3298
|
+
* remain; continue while nextToken is present.
|
|
3299
|
+
* @public
|
|
3300
|
+
*/
|
|
3301
|
+
maxResults?: number | undefined;
|
|
3302
|
+
}
|
|
3303
|
+
/**
|
|
3304
|
+
* @public
|
|
3305
|
+
*/
|
|
3306
|
+
export interface ListAccessGrantsOutput {
|
|
3307
|
+
/**
|
|
3308
|
+
* The list of access grant summaries.
|
|
3309
|
+
* @public
|
|
3310
|
+
*/
|
|
3311
|
+
items: AccessGrantSummary[] | undefined;
|
|
3312
|
+
/**
|
|
3313
|
+
* A token to retrieve the next page of results, or null if there are no more results.
|
|
3314
|
+
* @public
|
|
3315
|
+
*/
|
|
3316
|
+
nextToken?: string | undefined;
|
|
3317
|
+
}
|
|
3318
|
+
/**
|
|
3319
|
+
* @public
|
|
3320
|
+
*/
|
|
3321
|
+
export interface ListAccessProfilesInput {
|
|
3322
|
+
/**
|
|
3323
|
+
* The unique ID of the space.
|
|
3324
|
+
* @public
|
|
3325
|
+
*/
|
|
3326
|
+
spaceId: string | undefined;
|
|
3327
|
+
/**
|
|
3328
|
+
* A token to retrieve the next page of results.
|
|
3329
|
+
* @public
|
|
3330
|
+
*/
|
|
3331
|
+
nextToken?: string | undefined;
|
|
3332
|
+
/**
|
|
3333
|
+
* The maximum number of access profiles to return per page. Defaults to 100.
|
|
3334
|
+
* @public
|
|
3335
|
+
*/
|
|
3336
|
+
maxResults?: number | undefined;
|
|
3337
|
+
}
|
|
3338
|
+
/**
|
|
3339
|
+
* @public
|
|
3340
|
+
*/
|
|
3341
|
+
export interface ListAccessProfilesOutput {
|
|
3342
|
+
/**
|
|
3343
|
+
* The list of access profile summaries.
|
|
3344
|
+
* @public
|
|
3345
|
+
*/
|
|
3346
|
+
items: AccessProfileSummary[] | undefined;
|
|
3347
|
+
/**
|
|
3348
|
+
* A token to retrieve the next page of results, or null if there are no more results.
|
|
3349
|
+
* @public
|
|
3350
|
+
*/
|
|
3351
|
+
nextToken?: string | undefined;
|
|
3352
|
+
}
|
|
3353
|
+
/**
|
|
3354
|
+
* @public
|
|
3355
|
+
*/
|
|
3356
|
+
export interface ListAlertsInput {
|
|
3357
|
+
/**
|
|
3358
|
+
* The unique ID of the space.
|
|
3359
|
+
* @public
|
|
3360
|
+
*/
|
|
3361
|
+
spaceId: string | undefined;
|
|
3362
|
+
/**
|
|
3363
|
+
* Filter criteria narrowing which alerts are returned. All members are
|
|
3364
|
+
* optional; the three name/id filters are mutually exclusive.
|
|
3365
|
+
* @public
|
|
3366
|
+
*/
|
|
3367
|
+
filterCriteria?: AlertFilterCriteria | undefined;
|
|
3368
|
+
/**
|
|
3369
|
+
* The field to sort results by.
|
|
3370
|
+
* @public
|
|
3371
|
+
*/
|
|
3372
|
+
sortBy?: AlertSortField | undefined;
|
|
3373
|
+
/**
|
|
3374
|
+
* The order in which to sort results.
|
|
3375
|
+
* @public
|
|
3376
|
+
*/
|
|
3377
|
+
sortOrder?: AlertSortOrder | undefined;
|
|
3378
|
+
/**
|
|
3379
|
+
* A token to retrieve the next page of results.
|
|
3380
|
+
* @public
|
|
3381
|
+
*/
|
|
3382
|
+
nextToken?: string | undefined;
|
|
3383
|
+
/**
|
|
3384
|
+
* The maximum number of alerts to return per page.
|
|
3385
|
+
* @public
|
|
3386
|
+
*/
|
|
3387
|
+
maxResults?: number | undefined;
|
|
3388
|
+
}
|
|
3389
|
+
/**
|
|
3390
|
+
* @public
|
|
3391
|
+
*/
|
|
3392
|
+
export interface ListAlertsOutput {
|
|
3393
|
+
/**
|
|
3394
|
+
* The list of alert summaries.
|
|
3395
|
+
* @public
|
|
3396
|
+
*/
|
|
3397
|
+
items: AlertSummary[] | undefined;
|
|
3398
|
+
/**
|
|
3399
|
+
* A token to retrieve the next page of results, or null if there are no more results.
|
|
3400
|
+
* @public
|
|
3401
|
+
*/
|
|
3402
|
+
nextToken?: string | undefined;
|
|
3403
|
+
}
|
|
3404
|
+
/**
|
|
3405
|
+
* @public
|
|
3406
|
+
*/
|
|
3407
|
+
export interface ListDomainAccessGrantsForOrganizationInput {
|
|
3408
|
+
/**
|
|
3409
|
+
* Filter by domain ID.
|
|
3410
|
+
* @public
|
|
3411
|
+
*/
|
|
3412
|
+
domainId?: string | undefined;
|
|
3413
|
+
/**
|
|
3414
|
+
* Filter by principal ID.
|
|
3415
|
+
* @public
|
|
3416
|
+
*/
|
|
3417
|
+
principalId?: string | undefined;
|
|
3418
|
+
/**
|
|
3419
|
+
* Filter by principal type.
|
|
3420
|
+
* @public
|
|
3421
|
+
*/
|
|
3422
|
+
principalType?: OrganizationGrantPrincipalType | undefined;
|
|
3423
|
+
/**
|
|
3424
|
+
* Filter by permission level.
|
|
3425
|
+
* @public
|
|
3426
|
+
*/
|
|
3427
|
+
permission?: OrganizationGrantPermission | undefined;
|
|
3428
|
+
/**
|
|
3429
|
+
* A token to retrieve the next page of results. Supply the same filters used
|
|
3430
|
+
* on the request that returned it. Tokens expire after 24 hours.
|
|
3431
|
+
* @public
|
|
3432
|
+
*/
|
|
3433
|
+
nextToken?: string | undefined;
|
|
3434
|
+
/**
|
|
3435
|
+
* The maximum number of access grants to return per page. Defaults to 100.
|
|
3436
|
+
* A page can contain fewer results than this value even when more results
|
|
3437
|
+
* remain; continue while nextToken is present.
|
|
3438
|
+
* @public
|
|
3439
|
+
*/
|
|
3440
|
+
maxResults?: number | undefined;
|
|
3441
|
+
}
|
|
3442
|
+
/**
|
|
3443
|
+
* Summary of an organization access grant. Call
|
|
3444
|
+
* GetDomainAccessGrantForOrganization for the full grant.
|
|
3445
|
+
* @public
|
|
3446
|
+
*/
|
|
3447
|
+
export interface OrganizationAccessGrantSummary {
|
|
3448
|
+
/**
|
|
3449
|
+
* The unique ID of the access grant.
|
|
3450
|
+
* @public
|
|
3451
|
+
*/
|
|
3452
|
+
grantId: string | undefined;
|
|
3453
|
+
/**
|
|
3454
|
+
* The Amazon Resource Name (ARN) of the access grant.
|
|
3455
|
+
* @public
|
|
3456
|
+
*/
|
|
3457
|
+
grantArn: string | undefined;
|
|
3458
|
+
/**
|
|
3459
|
+
* A name that identifies the access grant.
|
|
3460
|
+
* @public
|
|
3461
|
+
*/
|
|
3462
|
+
name?: string | undefined;
|
|
3463
|
+
/**
|
|
3464
|
+
* The ID of the organization domain the grant belongs to.
|
|
3465
|
+
* @public
|
|
3466
|
+
*/
|
|
3467
|
+
domainId: string | undefined;
|
|
3468
|
+
/**
|
|
3469
|
+
* The principal receiving the grant.
|
|
3470
|
+
* @public
|
|
3471
|
+
*/
|
|
3472
|
+
principal: OrganizationAccessGrantPrincipal | undefined;
|
|
3473
|
+
/**
|
|
3474
|
+
* The permission granted.
|
|
3475
|
+
* @public
|
|
3476
|
+
*/
|
|
3477
|
+
permission: OrganizationGrantPermission | undefined;
|
|
3478
|
+
/**
|
|
3479
|
+
* Who manages the grant.
|
|
3480
|
+
* @public
|
|
3481
|
+
*/
|
|
3482
|
+
grantType: AccessGrantType | undefined;
|
|
3483
|
+
/**
|
|
3484
|
+
* The timestamp when the access grant was created.
|
|
3485
|
+
* @public
|
|
3486
|
+
*/
|
|
3487
|
+
createdAt: Date | undefined;
|
|
3488
|
+
/**
|
|
3489
|
+
* The timestamp when the access grant was last updated.
|
|
3490
|
+
* @public
|
|
3491
|
+
*/
|
|
3492
|
+
updatedAt: Date | undefined;
|
|
3493
|
+
}
|
|
3494
|
+
/**
|
|
3495
|
+
* @public
|
|
3496
|
+
*/
|
|
3497
|
+
export interface ListDomainAccessGrantsForOrganizationOutput {
|
|
3498
|
+
/**
|
|
3499
|
+
* The list of organization access grant summaries.
|
|
3500
|
+
* @public
|
|
3501
|
+
*/
|
|
3502
|
+
items: OrganizationAccessGrantSummary[] | undefined;
|
|
3503
|
+
/**
|
|
3504
|
+
* A token to retrieve the next page of results, or null if there are no more results.
|
|
3505
|
+
* @public
|
|
3506
|
+
*/
|
|
3507
|
+
nextToken?: string | undefined;
|
|
3508
|
+
}
|
|
3509
|
+
/**
|
|
3510
|
+
* @public
|
|
3511
|
+
*/
|
|
3512
|
+
export interface ListDomainsInput {
|
|
3513
|
+
/**
|
|
3514
|
+
* A token to retrieve the next page of results. Tokens expire after 24 hours.
|
|
3515
|
+
* @public
|
|
3516
|
+
*/
|
|
3517
|
+
nextToken?: string | undefined;
|
|
3518
|
+
/**
|
|
3519
|
+
* The maximum number of domains to return per page. Defaults to 100.
|
|
3520
|
+
* @public
|
|
3521
|
+
*/
|
|
3522
|
+
maxResults?: number | undefined;
|
|
3523
|
+
}
|
|
3524
|
+
/**
|
|
3525
|
+
* Summary of a domain. Call GetDomain for the full domain.
|
|
3526
|
+
* @public
|
|
3527
|
+
*/
|
|
3528
|
+
export interface DomainSummary {
|
|
3529
|
+
/**
|
|
3530
|
+
* The unique ID of the domain.
|
|
3531
|
+
* @public
|
|
3532
|
+
*/
|
|
3533
|
+
domainId: string | undefined;
|
|
3534
|
+
/**
|
|
3535
|
+
* The Amazon Resource Name (ARN) of the domain.
|
|
3536
|
+
* @public
|
|
3537
|
+
*/
|
|
3538
|
+
domainArn?: string | undefined;
|
|
3539
|
+
/**
|
|
3540
|
+
* A name that identifies the domain.
|
|
3541
|
+
* @public
|
|
3542
|
+
*/
|
|
3543
|
+
name?: string | undefined;
|
|
3544
|
+
/**
|
|
3545
|
+
* Identity Center instance ARN configured for the domain.
|
|
3546
|
+
* Absent for IAM-only domains.
|
|
3547
|
+
* @public
|
|
3548
|
+
*/
|
|
3549
|
+
identityCenterInstanceArn?: string | undefined;
|
|
3550
|
+
/**
|
|
3551
|
+
* The Region where this domain was created.
|
|
3552
|
+
* @public
|
|
3553
|
+
*/
|
|
3554
|
+
region?: string | undefined;
|
|
3555
|
+
/**
|
|
3556
|
+
* The timestamp when the domain was created.
|
|
3557
|
+
* @public
|
|
3558
|
+
*/
|
|
3559
|
+
createdAt: Date | undefined;
|
|
3560
|
+
/**
|
|
3561
|
+
* The timestamp when the domain was last updated.
|
|
3562
|
+
* @public
|
|
3563
|
+
*/
|
|
3564
|
+
updatedAt: Date | undefined;
|
|
3565
|
+
/**
|
|
3566
|
+
* Current status of the domain.
|
|
3567
|
+
* @public
|
|
3568
|
+
*/
|
|
3569
|
+
status: DomainStatus | undefined;
|
|
3570
|
+
}
|
|
3571
|
+
/**
|
|
3572
|
+
* @public
|
|
3573
|
+
*/
|
|
3574
|
+
export interface ListDomainsOutput {
|
|
3575
|
+
/**
|
|
3576
|
+
* The list of domain summaries.
|
|
3577
|
+
* @public
|
|
3578
|
+
*/
|
|
3579
|
+
items: DomainSummary[] | undefined;
|
|
3580
|
+
/**
|
|
3581
|
+
* A token to retrieve the next page of results, or null if there are no more results.
|
|
3582
|
+
* @public
|
|
3583
|
+
*/
|
|
3584
|
+
nextToken?: string | undefined;
|
|
3585
|
+
}
|
|
3586
|
+
/**
|
|
3587
|
+
* The request for listing the integrations in an account.
|
|
3588
|
+
* @public
|
|
3589
|
+
*/
|
|
3590
|
+
export interface ListIntegrationsInput {
|
|
3591
|
+
/**
|
|
3592
|
+
* Returns only integrations of this provider type.
|
|
3593
|
+
* @public
|
|
3594
|
+
*/
|
|
3595
|
+
integrationType?: IntegrationType | undefined;
|
|
3596
|
+
/**
|
|
3597
|
+
* Returns only integrations in this status.
|
|
3598
|
+
* @public
|
|
3599
|
+
*/
|
|
3600
|
+
status?: IntegrationStatus | undefined;
|
|
3601
|
+
/**
|
|
3602
|
+
* Returns only the integration with this exact name.
|
|
3603
|
+
* @public
|
|
3604
|
+
*/
|
|
3605
|
+
name?: string | undefined;
|
|
3606
|
+
/**
|
|
3607
|
+
* Pagination token from a previous response; omit for the first page.
|
|
3608
|
+
* @public
|
|
3609
|
+
*/
|
|
3610
|
+
nextToken?: string | undefined;
|
|
3611
|
+
/**
|
|
3612
|
+
* Maximum number of integrations to return in one page.
|
|
3613
|
+
* @public
|
|
3614
|
+
*/
|
|
3615
|
+
maxResults?: number | undefined;
|
|
3616
|
+
}
|
|
3617
|
+
/**
|
|
3618
|
+
* The response containing a page of integrations.
|
|
3619
|
+
* @public
|
|
3620
|
+
*/
|
|
3621
|
+
export interface ListIntegrationsOutput {
|
|
3622
|
+
/**
|
|
3623
|
+
* The page of integrations.
|
|
3624
|
+
* @public
|
|
3625
|
+
*/
|
|
3626
|
+
items: Integration[] | undefined;
|
|
3627
|
+
/**
|
|
3628
|
+
* Pagination token for the next page; absent when there are no more results.
|
|
3629
|
+
* @public
|
|
3630
|
+
*/
|
|
3631
|
+
nextToken?: string | undefined;
|
|
3632
|
+
}
|
|
3633
|
+
/**
|
|
3634
|
+
* @public
|
|
3635
|
+
*/
|
|
3636
|
+
export interface ListOmniDashboardsInput {
|
|
3637
|
+
/**
|
|
3638
|
+
* The unique ID of the space.
|
|
3639
|
+
* @public
|
|
3640
|
+
*/
|
|
3641
|
+
spaceId: string | undefined;
|
|
3642
|
+
/**
|
|
3643
|
+
* Filter to dashboards whose name starts with this prefix.
|
|
3644
|
+
* @public
|
|
3645
|
+
*/
|
|
3646
|
+
namePrefix?: string | undefined;
|
|
3647
|
+
/**
|
|
3648
|
+
* A token to retrieve the next page of results.
|
|
3649
|
+
* @public
|
|
3650
|
+
*/
|
|
3651
|
+
nextToken?: string | undefined;
|
|
3652
|
+
/**
|
|
3653
|
+
* The maximum number of dashboards to return per page. Defaults to 100.
|
|
3654
|
+
* A page can contain fewer results than this value even when more results
|
|
3655
|
+
* remain; continue while nextToken is present.
|
|
3656
|
+
* @public
|
|
3657
|
+
*/
|
|
3658
|
+
maxResults?: number | undefined;
|
|
3659
|
+
}
|
|
3660
|
+
/**
|
|
3661
|
+
* Summary of a dashboard. Call GetOmniDashboard for the full dashboard.
|
|
3662
|
+
* @public
|
|
3663
|
+
*/
|
|
3664
|
+
export interface OmniDashboardSummary {
|
|
3665
|
+
/**
|
|
3666
|
+
* The unique ID of the dashboard.
|
|
3667
|
+
* @public
|
|
3668
|
+
*/
|
|
3669
|
+
dashboardId: string | undefined;
|
|
3670
|
+
/**
|
|
3671
|
+
* The Amazon Resource Name (ARN) of the dashboard.
|
|
3672
|
+
* @public
|
|
3673
|
+
*/
|
|
3674
|
+
arn: string | undefined;
|
|
3675
|
+
/**
|
|
3676
|
+
* A name that identifies the dashboard.
|
|
3677
|
+
* @public
|
|
3678
|
+
*/
|
|
3679
|
+
name: string | undefined;
|
|
3680
|
+
/**
|
|
3681
|
+
* The principal that created the dashboard.
|
|
3682
|
+
* @public
|
|
3683
|
+
*/
|
|
3684
|
+
createdBy: string | undefined;
|
|
3685
|
+
/**
|
|
3686
|
+
* An optional description of the dashboard.
|
|
3687
|
+
* @public
|
|
3688
|
+
*/
|
|
3689
|
+
description?: string | undefined;
|
|
3690
|
+
/**
|
|
3691
|
+
* The tags associated with the dashboard.
|
|
3692
|
+
* @public
|
|
3693
|
+
*/
|
|
3694
|
+
tags?: Record<string, string> | undefined;
|
|
3695
|
+
/**
|
|
3696
|
+
* The timestamp when the dashboard was created.
|
|
3697
|
+
* @public
|
|
3698
|
+
*/
|
|
3699
|
+
createdAt: Date | undefined;
|
|
3700
|
+
/**
|
|
3701
|
+
* The timestamp when the dashboard was last updated.
|
|
3702
|
+
* @public
|
|
3703
|
+
*/
|
|
3704
|
+
updatedAt: Date | undefined;
|
|
3705
|
+
}
|
|
3706
|
+
/**
|
|
3707
|
+
* @public
|
|
3708
|
+
*/
|
|
3709
|
+
export interface ListOmniDashboardsOutput {
|
|
3710
|
+
/**
|
|
3711
|
+
* The list of dashboard summaries.
|
|
3712
|
+
* @public
|
|
3713
|
+
*/
|
|
3714
|
+
items: OmniDashboardSummary[] | undefined;
|
|
3715
|
+
/**
|
|
3716
|
+
* A token to retrieve the next page of results, or null if there are no more results.
|
|
3717
|
+
* @public
|
|
3718
|
+
*/
|
|
3719
|
+
nextToken?: string | undefined;
|
|
3720
|
+
}
|
|
3721
|
+
/**
|
|
3722
|
+
* @public
|
|
3723
|
+
*/
|
|
3724
|
+
export interface ListSpacesInput {
|
|
3725
|
+
/**
|
|
3726
|
+
* Filter by domain ID.
|
|
3727
|
+
* @public
|
|
3728
|
+
*/
|
|
3729
|
+
domainId?: string | undefined;
|
|
3730
|
+
/**
|
|
3731
|
+
* A token to retrieve the next page of results. Supply the same filters used
|
|
3732
|
+
* on the request that returned it. Tokens expire after 24 hours.
|
|
3733
|
+
* @public
|
|
3734
|
+
*/
|
|
3735
|
+
nextToken?: string | undefined;
|
|
3736
|
+
/**
|
|
3737
|
+
* The maximum number of spaces to return per page. Defaults to 100.
|
|
3738
|
+
* A page can contain fewer results than this value even when more results
|
|
3739
|
+
* remain; continue while nextToken is present.
|
|
3740
|
+
* @public
|
|
3741
|
+
*/
|
|
3742
|
+
maxResults?: number | undefined;
|
|
3743
|
+
}
|
|
3744
|
+
/**
|
|
3745
|
+
* Summary of a space. Call GetSpace for the full space.
|
|
3746
|
+
* @public
|
|
3747
|
+
*/
|
|
3748
|
+
export interface SpaceSummary {
|
|
3749
|
+
/**
|
|
3750
|
+
* The unique ID of the space.
|
|
3751
|
+
* @public
|
|
3752
|
+
*/
|
|
3753
|
+
spaceId: string | undefined;
|
|
3754
|
+
/**
|
|
3755
|
+
* A name that identifies the space.
|
|
3756
|
+
* @public
|
|
3757
|
+
*/
|
|
3758
|
+
name: string | undefined;
|
|
3759
|
+
/**
|
|
3760
|
+
* The Amazon Resource Name (ARN) of the space.
|
|
3761
|
+
* @public
|
|
3762
|
+
*/
|
|
3763
|
+
spaceArn: string | undefined;
|
|
3764
|
+
/**
|
|
3765
|
+
* The Amazon Resource Name (ARN) of the domain the space belongs to. Absent when
|
|
3766
|
+
* the space is not associated with a domain, so callers must tolerate its absence.
|
|
3767
|
+
* @public
|
|
3768
|
+
*/
|
|
3769
|
+
domainArn?: string | undefined;
|
|
3770
|
+
/**
|
|
3771
|
+
* The region where this space was created.
|
|
3772
|
+
* @public
|
|
3773
|
+
*/
|
|
3774
|
+
region: string | undefined;
|
|
3775
|
+
/**
|
|
3776
|
+
* AWS account ID that owns this space.
|
|
3777
|
+
* @public
|
|
3778
|
+
*/
|
|
3779
|
+
ownerAccountId: string | undefined;
|
|
3780
|
+
/**
|
|
3781
|
+
* The status of the space.
|
|
3782
|
+
* @public
|
|
3783
|
+
*/
|
|
3784
|
+
status: SpaceStatus | undefined;
|
|
3785
|
+
/**
|
|
3786
|
+
* Reason for the current space status.
|
|
3787
|
+
* @public
|
|
3788
|
+
*/
|
|
3789
|
+
statusReason?: string | undefined;
|
|
3790
|
+
/**
|
|
3791
|
+
* The timestamp when the space was created.
|
|
3792
|
+
* @public
|
|
3793
|
+
*/
|
|
3794
|
+
createdAt: Date | undefined;
|
|
3795
|
+
/**
|
|
3796
|
+
* The timestamp when the space was last updated.
|
|
3797
|
+
* @public
|
|
3798
|
+
*/
|
|
3799
|
+
updatedAt: Date | undefined;
|
|
3800
|
+
}
|
|
3801
|
+
/**
|
|
3802
|
+
* @public
|
|
3803
|
+
*/
|
|
3804
|
+
export interface ListSpacesOutput {
|
|
3805
|
+
/**
|
|
3806
|
+
* The list of space summaries.
|
|
3807
|
+
* @public
|
|
3808
|
+
*/
|
|
3809
|
+
items: SpaceSummary[] | undefined;
|
|
3810
|
+
/**
|
|
3811
|
+
* A token to retrieve the next page of results, or null if there are no more results.
|
|
3812
|
+
* @public
|
|
3813
|
+
*/
|
|
3814
|
+
nextToken?: string | undefined;
|
|
3815
|
+
}
|
|
3816
|
+
/**
|
|
3817
|
+
* @public
|
|
3818
|
+
*/
|
|
3819
|
+
export interface ListSpacesForOrganizationInput {
|
|
3820
|
+
/**
|
|
3821
|
+
* A token to retrieve the next page of results. Tokens expire after 24 hours.
|
|
3822
|
+
* @public
|
|
3823
|
+
*/
|
|
3824
|
+
nextToken?: string | undefined;
|
|
3825
|
+
/**
|
|
3826
|
+
* The maximum number of spaces to return per page. Defaults to 100.
|
|
3827
|
+
* @public
|
|
3828
|
+
*/
|
|
3829
|
+
maxResults?: number | undefined;
|
|
3830
|
+
}
|
|
3831
|
+
/**
|
|
3832
|
+
* @public
|
|
3833
|
+
*/
|
|
3834
|
+
export interface ListSpacesForOrganizationOutput {
|
|
3835
|
+
/**
|
|
3836
|
+
* The list of space summaries.
|
|
3837
|
+
* @public
|
|
3838
|
+
*/
|
|
3839
|
+
items: SpaceSummary[] | undefined;
|
|
3840
|
+
/**
|
|
3841
|
+
* A token to retrieve the next page of results, or null if there are no more results.
|
|
3842
|
+
* @public
|
|
3843
|
+
*/
|
|
3844
|
+
nextToken?: string | undefined;
|
|
3845
|
+
}
|
|
3846
|
+
/**
|
|
3847
|
+
* @public
|
|
3848
|
+
*/
|
|
3849
|
+
export interface ListTelemetryFieldsRequest {
|
|
3850
|
+
/**
|
|
3851
|
+
* The name of the dataset to list fields for.
|
|
3852
|
+
* @public
|
|
3853
|
+
*/
|
|
3854
|
+
dataSetName: string | undefined;
|
|
3855
|
+
/**
|
|
3856
|
+
* The type of telemetry to filter fields by.
|
|
3857
|
+
* @public
|
|
3858
|
+
*/
|
|
3859
|
+
telemetryType?: TelemetryType | undefined;
|
|
3860
|
+
/**
|
|
3861
|
+
* Inclusive start of the lookback window. When omitted, the service
|
|
3862
|
+
* defaults to the configured lookback before endTime.
|
|
3863
|
+
* @public
|
|
3864
|
+
*/
|
|
3865
|
+
startTime?: Date | undefined;
|
|
3866
|
+
/**
|
|
3867
|
+
* Inclusive end of the lookback window. When omitted, the service
|
|
3868
|
+
* defaults to the current time.
|
|
3869
|
+
* @public
|
|
3870
|
+
*/
|
|
3871
|
+
endTime?: Date | undefined;
|
|
3872
|
+
/**
|
|
3873
|
+
* A token to retrieve the next page of results. Reserved for future
|
|
3874
|
+
* pagination; the service does not paginate at this time and returns null.
|
|
3875
|
+
* @public
|
|
3876
|
+
*/
|
|
3877
|
+
nextToken?: string | undefined;
|
|
3878
|
+
}
|
|
3879
|
+
/**
|
|
3880
|
+
* @public
|
|
3881
|
+
*/
|
|
3882
|
+
export interface ListTelemetryQuerySessionsRequest {
|
|
3883
|
+
/**
|
|
3884
|
+
* A token to retrieve the next page of results.
|
|
3885
|
+
* @public
|
|
3886
|
+
*/
|
|
3887
|
+
nextToken?: string | undefined;
|
|
3888
|
+
/**
|
|
3889
|
+
* The maximum number of sessions to return per page.
|
|
3890
|
+
* @public
|
|
3891
|
+
*/
|
|
3892
|
+
maxResults?: number | undefined;
|
|
3893
|
+
}
|
|
3894
|
+
/**
|
|
3895
|
+
* Summary information about a query session, including its identifier, name,
|
|
3896
|
+
* and activity timestamps.
|
|
3897
|
+
* @public
|
|
3898
|
+
*/
|
|
3899
|
+
export interface SessionSummary {
|
|
3900
|
+
/**
|
|
3901
|
+
* The unique ID of the session.
|
|
3902
|
+
* @public
|
|
3903
|
+
*/
|
|
3904
|
+
sessionId: string | undefined;
|
|
3905
|
+
/**
|
|
3906
|
+
* The timestamp when the session was created.
|
|
3907
|
+
* @public
|
|
3908
|
+
*/
|
|
3909
|
+
createdAt?: Date | undefined;
|
|
3910
|
+
/**
|
|
3911
|
+
* The timestamp of the most recent activity in the session.
|
|
3912
|
+
* @public
|
|
3913
|
+
*/
|
|
3914
|
+
lastActivityAt?: Date | undefined;
|
|
3915
|
+
/**
|
|
3916
|
+
* The human-readable name of the session. Names under `/aws/` are reserved
|
|
3917
|
+
* for service integrations.
|
|
3918
|
+
* @public
|
|
3919
|
+
*/
|
|
3920
|
+
sessionName?: string | undefined;
|
|
3921
|
+
}
|
|
3922
|
+
/**
|
|
3923
|
+
* @public
|
|
3924
|
+
*/
|
|
3925
|
+
export interface ListTelemetryQuerySessionsResponse {
|
|
3926
|
+
/**
|
|
3927
|
+
* The list of session summaries.
|
|
3928
|
+
* @public
|
|
3929
|
+
*/
|
|
3930
|
+
sessions: SessionSummary[] | undefined;
|
|
3931
|
+
/**
|
|
3932
|
+
* A token to retrieve the next page of results, or null if there are no more results.
|
|
3933
|
+
* @public
|
|
3934
|
+
*/
|
|
3935
|
+
nextToken?: string | undefined;
|
|
3936
|
+
}
|
|
3937
|
+
/**
|
|
3938
|
+
* @public
|
|
3939
|
+
*/
|
|
3940
|
+
export interface ListViewsRequest {
|
|
3941
|
+
/**
|
|
3942
|
+
* Return only views of this ownership category.
|
|
3943
|
+
* @public
|
|
3944
|
+
*/
|
|
3945
|
+
type?: ViewType | undefined;
|
|
3946
|
+
/**
|
|
3947
|
+
* The maximum number of views to return per page.
|
|
3948
|
+
* @public
|
|
3949
|
+
*/
|
|
3950
|
+
maxResults?: number | undefined;
|
|
3951
|
+
/**
|
|
3952
|
+
* A token to retrieve the next page of results.
|
|
3953
|
+
* @public
|
|
3954
|
+
*/
|
|
3955
|
+
nextToken?: string | undefined;
|
|
3956
|
+
}
|
|
3957
|
+
/**
|
|
3958
|
+
* Summary information about a view. Does not include the view definition.
|
|
3959
|
+
* @public
|
|
3960
|
+
*/
|
|
3961
|
+
export interface ViewSummary {
|
|
3962
|
+
/**
|
|
3963
|
+
* The name of the view.
|
|
3964
|
+
* @public
|
|
3965
|
+
*/
|
|
3966
|
+
name: string | undefined;
|
|
3967
|
+
/**
|
|
3968
|
+
* The ownership category of the view.
|
|
3969
|
+
* @public
|
|
3970
|
+
*/
|
|
3971
|
+
type: ViewType | undefined;
|
|
3972
|
+
/**
|
|
3973
|
+
* The description of the view.
|
|
3974
|
+
* @public
|
|
3975
|
+
*/
|
|
3976
|
+
description?: string | undefined;
|
|
3977
|
+
/**
|
|
3978
|
+
* The timestamp when the view was created.
|
|
3979
|
+
* @public
|
|
3980
|
+
*/
|
|
3981
|
+
createdAt: Date | undefined;
|
|
3982
|
+
/**
|
|
3983
|
+
* The timestamp when the view was last updated.
|
|
3984
|
+
* @public
|
|
3985
|
+
*/
|
|
3986
|
+
updatedAt: Date | undefined;
|
|
3987
|
+
}
|
|
3988
|
+
/**
|
|
3989
|
+
* @public
|
|
3990
|
+
*/
|
|
3991
|
+
export interface ListViewsResponse {
|
|
3992
|
+
/**
|
|
3993
|
+
* The list of view summaries.
|
|
3994
|
+
* @public
|
|
3995
|
+
*/
|
|
3996
|
+
items: ViewSummary[] | undefined;
|
|
3997
|
+
/**
|
|
3998
|
+
* A token to retrieve the next page of results, or null if there are no more results.
|
|
3999
|
+
* @public
|
|
4000
|
+
*/
|
|
4001
|
+
nextToken?: string | undefined;
|
|
4002
|
+
}
|
|
4003
|
+
/**
|
|
4004
|
+
* The request for updating the intelligence configuration of the calling account.
|
|
4005
|
+
* @public
|
|
4006
|
+
*/
|
|
4007
|
+
export interface PutIntelligenceConfigurationInput {
|
|
4008
|
+
/**
|
|
4009
|
+
* Optional KMS key ARN to configure customer-managed encryption for anomaly data.
|
|
4010
|
+
* @public
|
|
4011
|
+
*/
|
|
4012
|
+
kmsKeyArn?: string | undefined;
|
|
4013
|
+
/**
|
|
4014
|
+
* Set to true to disassociate the configured KMS key. Mutually exclusive with
|
|
4015
|
+
* kmsKeyArn; the service returns ValidationException if both are provided.
|
|
4016
|
+
* @public
|
|
4017
|
+
*/
|
|
4018
|
+
removeKmsKey?: boolean | undefined;
|
|
4019
|
+
/**
|
|
4020
|
+
* Idempotency token for safe retries. Repeating a request with the same token
|
|
4021
|
+
* applies the update at most once instead of reprocessing it.
|
|
4022
|
+
* @public
|
|
4023
|
+
*/
|
|
4024
|
+
clientToken?: string | undefined;
|
|
4025
|
+
}
|
|
4026
|
+
/**
|
|
4027
|
+
* The intelligence configuration for the calling account after the update.
|
|
4028
|
+
* @public
|
|
4029
|
+
*/
|
|
4030
|
+
export interface PutIntelligenceConfigurationOutput {
|
|
4031
|
+
/**
|
|
4032
|
+
* The AWS account ID this configuration applies to.
|
|
4033
|
+
* @public
|
|
4034
|
+
*/
|
|
4035
|
+
accountId: string | undefined;
|
|
4036
|
+
/**
|
|
4037
|
+
* The currently active KMS key ARN for customer-managed encryption, if configured.
|
|
4038
|
+
* @public
|
|
4039
|
+
*/
|
|
4040
|
+
kmsKeyArn?: string | undefined;
|
|
4041
|
+
/**
|
|
4042
|
+
* ISO-8601 timestamp of the last update.
|
|
4043
|
+
* @public
|
|
4044
|
+
*/
|
|
4045
|
+
updatedAt: Date | undefined;
|
|
4046
|
+
/**
|
|
4047
|
+
* ISO-8601 timestamp of initial creation.
|
|
4048
|
+
* @public
|
|
4049
|
+
*/
|
|
4050
|
+
createdAt: Date | undefined;
|
|
4051
|
+
}
|
|
4052
|
+
/**
|
|
4053
|
+
* @public
|
|
4054
|
+
*/
|
|
4055
|
+
export interface SearchPrincipalsInput {
|
|
4056
|
+
/**
|
|
4057
|
+
* The ID of the domain to search within.
|
|
4058
|
+
* @public
|
|
4059
|
+
*/
|
|
4060
|
+
domainId: string | undefined;
|
|
4061
|
+
/**
|
|
4062
|
+
* A search term to match against user names, display names, and IDs. Pass * to list
|
|
4063
|
+
* all principals. Maximum 128 characters.
|
|
4064
|
+
* @public
|
|
4065
|
+
*/
|
|
4066
|
+
searchQuery: string | undefined;
|
|
4067
|
+
/**
|
|
4068
|
+
* The maximum number of results to return. Defaults to 10. Valid only when searchQuery
|
|
4069
|
+
* is *; other searches reject this parameter and return at most 10 results.
|
|
4070
|
+
* @public
|
|
4071
|
+
*/
|
|
4072
|
+
maxResults?: number | undefined;
|
|
4073
|
+
/**
|
|
4074
|
+
* A token to retrieve the next page of results. Valid only when searchQuery is *;
|
|
4075
|
+
* other searches do not paginate and reject this parameter. Tokens expire after
|
|
4076
|
+
* 24 hours.
|
|
4077
|
+
* @public
|
|
4078
|
+
*/
|
|
4079
|
+
nextToken?: string | undefined;
|
|
4080
|
+
}
|
|
4081
|
+
/**
|
|
4082
|
+
* A user or group matched by SearchPrincipals.
|
|
4083
|
+
* @public
|
|
4084
|
+
*/
|
|
4085
|
+
export interface PrincipalSearchResult {
|
|
4086
|
+
/**
|
|
4087
|
+
* The unique ID of the principal.
|
|
4088
|
+
* @public
|
|
4089
|
+
*/
|
|
4090
|
+
principalId: string | undefined;
|
|
4091
|
+
/**
|
|
4092
|
+
* Whether the principal is a user or a group.
|
|
4093
|
+
* @public
|
|
4094
|
+
*/
|
|
4095
|
+
principalType: PrincipalType | undefined;
|
|
4096
|
+
/**
|
|
4097
|
+
* The display name of the principal.
|
|
4098
|
+
* @public
|
|
4099
|
+
*/
|
|
4100
|
+
displayName: string | undefined;
|
|
4101
|
+
/**
|
|
4102
|
+
* The user name of the principal. Present for users only.
|
|
4103
|
+
* @public
|
|
4104
|
+
*/
|
|
4105
|
+
userName?: string | undefined;
|
|
4106
|
+
/**
|
|
4107
|
+
* An optional description of the principal.
|
|
4108
|
+
* @public
|
|
4109
|
+
*/
|
|
4110
|
+
description?: string | undefined;
|
|
4111
|
+
}
|
|
4112
|
+
/**
|
|
4113
|
+
* @public
|
|
4114
|
+
*/
|
|
4115
|
+
export interface SearchPrincipalsOutput {
|
|
4116
|
+
/**
|
|
4117
|
+
* The list of matching principals.
|
|
4118
|
+
* @public
|
|
4119
|
+
*/
|
|
4120
|
+
results: PrincipalSearchResult[] | undefined;
|
|
4121
|
+
/**
|
|
4122
|
+
* A token to retrieve the next page of results, or null if there are no more results.
|
|
4123
|
+
* @public
|
|
4124
|
+
*/
|
|
4125
|
+
nextToken?: string | undefined;
|
|
4126
|
+
}
|
|
4127
|
+
/**
|
|
4128
|
+
* @public
|
|
4129
|
+
*/
|
|
4130
|
+
export interface StartTelemetryQueryRequest {
|
|
4131
|
+
/**
|
|
4132
|
+
* The query string to execute.
|
|
4133
|
+
* @public
|
|
4134
|
+
*/
|
|
4135
|
+
queryString: string | undefined;
|
|
4136
|
+
/**
|
|
4137
|
+
* The unique ID of the session.
|
|
4138
|
+
* @public
|
|
4139
|
+
*/
|
|
4140
|
+
sessionId: string | undefined;
|
|
4141
|
+
}
|
|
4142
|
+
/**
|
|
4143
|
+
* @public
|
|
4144
|
+
*/
|
|
4145
|
+
export interface StartTelemetryQueryResponse {
|
|
4146
|
+
/**
|
|
4147
|
+
* The unique ID of the query.
|
|
4148
|
+
* @public
|
|
4149
|
+
*/
|
|
4150
|
+
queryId: string | undefined;
|
|
4151
|
+
/**
|
|
4152
|
+
* The unique ID of the session.
|
|
4153
|
+
* @public
|
|
4154
|
+
*/
|
|
4155
|
+
sessionId: string | undefined;
|
|
4156
|
+
}
|
|
4157
|
+
/**
|
|
4158
|
+
* @public
|
|
4159
|
+
*/
|
|
4160
|
+
export interface StartTelemetryQuerySessionRequest {
|
|
4161
|
+
/**
|
|
4162
|
+
* A human-readable name for the session. Names under `/aws/` are reserved
|
|
4163
|
+
* for service integrations.
|
|
4164
|
+
* @public
|
|
4165
|
+
*/
|
|
4166
|
+
sessionName?: string | undefined;
|
|
4167
|
+
}
|
|
4168
|
+
/**
|
|
4169
|
+
* @public
|
|
4170
|
+
*/
|
|
4171
|
+
export interface StartTelemetryQuerySessionResponse {
|
|
4172
|
+
/**
|
|
4173
|
+
* The unique ID of the session.
|
|
4174
|
+
* @public
|
|
4175
|
+
*/
|
|
4176
|
+
sessionId: string | undefined;
|
|
4177
|
+
}
|
|
4178
|
+
/**
|
|
4179
|
+
* @public
|
|
4180
|
+
*/
|
|
4181
|
+
export interface StopTelemetryQueryRequest {
|
|
4182
|
+
/**
|
|
4183
|
+
* The unique ID of the query.
|
|
4184
|
+
* @public
|
|
4185
|
+
*/
|
|
4186
|
+
queryId: string | undefined;
|
|
4187
|
+
}
|
|
4188
|
+
/**
|
|
4189
|
+
* @public
|
|
4190
|
+
*/
|
|
4191
|
+
export interface StopTelemetryQueryResponse {
|
|
4192
|
+
}
|
|
4193
|
+
/**
|
|
4194
|
+
* @public
|
|
4195
|
+
*/
|
|
4196
|
+
export interface StopTelemetryQuerySessionRequest {
|
|
4197
|
+
/**
|
|
4198
|
+
* The unique ID of the session.
|
|
4199
|
+
* @public
|
|
4200
|
+
*/
|
|
4201
|
+
sessionId: string | undefined;
|
|
4202
|
+
}
|
|
4203
|
+
/**
|
|
4204
|
+
* @public
|
|
4205
|
+
*/
|
|
4206
|
+
export interface StopTelemetryQuerySessionResponse {
|
|
4207
|
+
}
|
|
4208
|
+
/**
|
|
4209
|
+
* @public
|
|
4210
|
+
*/
|
|
4211
|
+
export interface UpdateAccessProfileInput {
|
|
4212
|
+
/**
|
|
4213
|
+
* The unique ID of the space.
|
|
4214
|
+
* @public
|
|
4215
|
+
*/
|
|
4216
|
+
spaceId: string | undefined;
|
|
4217
|
+
/**
|
|
4218
|
+
* The unique ID of the access profile to update.
|
|
4219
|
+
* @public
|
|
4220
|
+
*/
|
|
4221
|
+
profileId: string | undefined;
|
|
4222
|
+
/**
|
|
4223
|
+
* A new name for the access profile. Omit to leave unchanged.
|
|
4224
|
+
* @public
|
|
4225
|
+
*/
|
|
4226
|
+
name?: string | undefined;
|
|
4227
|
+
/**
|
|
4228
|
+
* A new description of the access profile. Omit to leave unchanged.
|
|
4229
|
+
* @public
|
|
4230
|
+
*/
|
|
4231
|
+
description?: string | undefined;
|
|
4232
|
+
}
|
|
4233
|
+
/**
|
|
4234
|
+
* @public
|
|
4235
|
+
*/
|
|
4236
|
+
export interface UpdateAccessProfileOutput {
|
|
4237
|
+
/**
|
|
4238
|
+
* The access profile.
|
|
4239
|
+
* @public
|
|
4240
|
+
*/
|
|
4241
|
+
accessProfile: AccessProfile | undefined;
|
|
4242
|
+
}
|
|
4243
|
+
/**
|
|
4244
|
+
* @public
|
|
4245
|
+
*/
|
|
4246
|
+
export interface UpdateAlertInput {
|
|
4247
|
+
/**
|
|
4248
|
+
* The unique ID of the space.
|
|
4249
|
+
* @public
|
|
4250
|
+
*/
|
|
4251
|
+
spaceId: string | undefined;
|
|
4252
|
+
/**
|
|
4253
|
+
* The alert to update.
|
|
4254
|
+
* @public
|
|
4255
|
+
*/
|
|
4256
|
+
alertId: string | undefined;
|
|
4257
|
+
/**
|
|
4258
|
+
* The ID of the access profile associated with the alert.
|
|
4259
|
+
* @public
|
|
4260
|
+
*/
|
|
4261
|
+
profileId?: string | undefined;
|
|
4262
|
+
/**
|
|
4263
|
+
* A new display name for the alert. Omit to leave the name unchanged
|
|
4264
|
+
* (apply-if-present / PATCH). Same constraints as CreateAlert.name; the
|
|
4265
|
+
* name is not the alert's identity, so a rename never changes the alertId.
|
|
4266
|
+
* @public
|
|
4267
|
+
*/
|
|
4268
|
+
name?: string | undefined;
|
|
4269
|
+
/**
|
|
4270
|
+
* A new description of the alert. Omit to leave unchanged.
|
|
4271
|
+
* @public
|
|
4272
|
+
*/
|
|
4273
|
+
description?: string | undefined;
|
|
4274
|
+
/**
|
|
4275
|
+
* The rule that defines how the alert is evaluated. Omit to leave unchanged.
|
|
4276
|
+
* Each sub-block is replaced whole when present: \{@code query\}, \{@code condition\},
|
|
4277
|
+
* \{@code evaluation\} and \{@code noData\} are applied only when supplied, and within a
|
|
4278
|
+
* supplied block an omitted optional member is cleared to unset (null/absent) rather
|
|
4279
|
+
* than preserved from the stored alert or defaulted. See \{@link AlertCondition\} and
|
|
4280
|
+
* \{@link AlertEvaluation\}.
|
|
4281
|
+
* @public
|
|
4282
|
+
*/
|
|
4283
|
+
rule?: Rule | undefined;
|
|
4284
|
+
/**
|
|
4285
|
+
* Whether actions (notifications) are enabled for this alert.
|
|
4286
|
+
* Omitted = leave existing value unchanged.
|
|
4287
|
+
* @public
|
|
4288
|
+
*/
|
|
4289
|
+
notificationsEnabled?: boolean | undefined;
|
|
4290
|
+
/**
|
|
4291
|
+
* Replaces the entire notification rule list when present; full-replace,
|
|
4292
|
+
* not merge. Omitted = leave existing rules unchanged. An empty list
|
|
4293
|
+
* clears all rules (the alert keeps evaluating; only notifications stop).
|
|
4294
|
+
* @public
|
|
4295
|
+
*/
|
|
4296
|
+
notificationRules?: NotificationRule[] | undefined;
|
|
4297
|
+
}
|
|
4298
|
+
/**
|
|
4299
|
+
* @public
|
|
4300
|
+
*/
|
|
4301
|
+
export interface UpdateAlertOutput {
|
|
4302
|
+
}
|
|
4303
|
+
/**
|
|
4304
|
+
* @public
|
|
4305
|
+
*/
|
|
4306
|
+
export interface UpdateDomainInput {
|
|
4307
|
+
/**
|
|
4308
|
+
* The unique ID of the domain to update.
|
|
4309
|
+
* @public
|
|
4310
|
+
*/
|
|
4311
|
+
domainId: string | undefined;
|
|
4312
|
+
/**
|
|
4313
|
+
* A new name for the domain. Omit to leave unchanged. Must be 3-63 characters:
|
|
4314
|
+
* lowercase letters, numbers, and hyphens. It must begin and end with a letter or
|
|
4315
|
+
* number and cannot contain consecutive hyphens.
|
|
4316
|
+
* @public
|
|
4317
|
+
*/
|
|
4318
|
+
name?: string | undefined;
|
|
4319
|
+
/**
|
|
4320
|
+
* The identity providers to configure for the domain.
|
|
4321
|
+
* @public
|
|
4322
|
+
*/
|
|
4323
|
+
identityProviders?: IdentityProvider[] | undefined;
|
|
4324
|
+
/**
|
|
4325
|
+
* Identity provider configuration for the domain.
|
|
4326
|
+
* @public
|
|
4327
|
+
*/
|
|
4328
|
+
identityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
4329
|
+
}
|
|
4330
|
+
/**
|
|
4331
|
+
* @public
|
|
4332
|
+
*/
|
|
4333
|
+
export interface UpdateDomainOutput {
|
|
4334
|
+
/**
|
|
4335
|
+
* The details of the updated domain.
|
|
4336
|
+
* @public
|
|
4337
|
+
*/
|
|
4338
|
+
domain: Domain | undefined;
|
|
4339
|
+
}
|
|
4340
|
+
/**
|
|
4341
|
+
* @public
|
|
4342
|
+
*/
|
|
4343
|
+
export interface UpdateDomainForOrganizationInput {
|
|
4344
|
+
/**
|
|
4345
|
+
* The ID of the organization domain to update.
|
|
4346
|
+
* @public
|
|
4347
|
+
*/
|
|
4348
|
+
domainId: string | undefined;
|
|
4349
|
+
/**
|
|
4350
|
+
* A new name for the organization domain. Omit to leave unchanged. Must be 3-63
|
|
4351
|
+
* characters: lowercase letters, numbers, and hyphens. It must begin and end with a
|
|
4352
|
+
* letter or number and cannot contain consecutive hyphens.
|
|
4353
|
+
* @public
|
|
4354
|
+
*/
|
|
4355
|
+
name?: string | undefined;
|
|
4356
|
+
/**
|
|
4357
|
+
* The identity providers to configure for the domain. Omit to leave unchanged.
|
|
4358
|
+
* @public
|
|
4359
|
+
*/
|
|
4360
|
+
identityProviders?: IdentityProvider[] | undefined;
|
|
4361
|
+
/**
|
|
4362
|
+
* Identity provider configuration for the domain. Omit to leave unchanged.
|
|
4363
|
+
* @public
|
|
4364
|
+
*/
|
|
4365
|
+
identityProviderConfiguration?: IdentityProviderConfiguration | undefined;
|
|
4366
|
+
}
|
|
4367
|
+
/**
|
|
4368
|
+
* @public
|
|
4369
|
+
*/
|
|
4370
|
+
export interface UpdateDomainForOrganizationOutput {
|
|
4371
|
+
/**
|
|
4372
|
+
* The details of the updated organization domain.
|
|
4373
|
+
* @public
|
|
4374
|
+
*/
|
|
4375
|
+
organizationDomain: OrganizationDomain | undefined;
|
|
4376
|
+
}
|
|
4377
|
+
/**
|
|
4378
|
+
* The request for updating an existing integration.
|
|
4379
|
+
* @public
|
|
4380
|
+
*/
|
|
4381
|
+
export interface UpdateIntegrationInput {
|
|
4382
|
+
/**
|
|
4383
|
+
* Identifies the integration to update — exactly one of integrationId,
|
|
4384
|
+
* integrationArn, or integrationName.
|
|
4385
|
+
* @public
|
|
4386
|
+
*/
|
|
4387
|
+
identifier: IntegrationIdentifier | undefined;
|
|
4388
|
+
/**
|
|
4389
|
+
* The replacement credential used to authenticate with the provider.
|
|
4390
|
+
* @public
|
|
4391
|
+
*/
|
|
4392
|
+
credential?: IntegrationCredential | undefined;
|
|
4393
|
+
/**
|
|
4394
|
+
* The provider-specific attributes to associate with the integration.
|
|
4395
|
+
* @public
|
|
4396
|
+
*/
|
|
4397
|
+
integrationAttributes?: Record<string, string> | undefined;
|
|
4398
|
+
/**
|
|
4399
|
+
* The Amazon Resource Name of the IAM role assumed to access the integration.
|
|
4400
|
+
* @public
|
|
4401
|
+
*/
|
|
4402
|
+
roleArn?: string | undefined;
|
|
4403
|
+
}
|
|
4404
|
+
/**
|
|
4405
|
+
* The response from updating an integration.
|
|
4406
|
+
* @public
|
|
4407
|
+
*/
|
|
4408
|
+
export interface UpdateIntegrationOutput {
|
|
4409
|
+
/**
|
|
4410
|
+
* The details of the updated integration. This is the same object returned by
|
|
4411
|
+
* GetIntegration and CreateIntegration. Populated on a successful update; absent
|
|
4412
|
+
* only if the post-update read-back of the resource did not complete.
|
|
4413
|
+
* @public
|
|
4414
|
+
*/
|
|
4415
|
+
integration?: Integration | undefined;
|
|
4416
|
+
}
|
|
4417
|
+
/**
|
|
4418
|
+
* @public
|
|
4419
|
+
*/
|
|
4420
|
+
export interface UpdateOmniDashboardInput {
|
|
4421
|
+
/**
|
|
4422
|
+
* The unique ID of the space.
|
|
4423
|
+
* @public
|
|
4424
|
+
*/
|
|
4425
|
+
spaceId: string | undefined;
|
|
4426
|
+
/**
|
|
4427
|
+
* The unique ID of the dashboard.
|
|
4428
|
+
* @public
|
|
4429
|
+
*/
|
|
4430
|
+
dashboardId: string | undefined;
|
|
4431
|
+
/**
|
|
4432
|
+
* The new dashboard definition, as a JSON document. Maximum 1 MiB. Omit to
|
|
4433
|
+
* leave unchanged.
|
|
4434
|
+
* @public
|
|
4435
|
+
*/
|
|
4436
|
+
body?: string | undefined;
|
|
4437
|
+
/**
|
|
4438
|
+
* A new name for the dashboard. Omit to leave unchanged.
|
|
4439
|
+
* @public
|
|
4440
|
+
*/
|
|
4441
|
+
name?: string | undefined;
|
|
4442
|
+
/**
|
|
4443
|
+
* A new description of the dashboard. Omit to leave unchanged.
|
|
4444
|
+
* @public
|
|
4445
|
+
*/
|
|
4446
|
+
description?: string | undefined;
|
|
4447
|
+
}
|
|
4448
|
+
/**
|
|
4449
|
+
* @public
|
|
4450
|
+
*/
|
|
4451
|
+
export interface UpdateOmniDashboardOutput {
|
|
4452
|
+
/**
|
|
4453
|
+
* The dashboard.
|
|
4454
|
+
* @public
|
|
4455
|
+
*/
|
|
4456
|
+
omniDashboard: OmniDashboard | undefined;
|
|
4457
|
+
}
|
|
4458
|
+
/**
|
|
4459
|
+
* @public
|
|
4460
|
+
*/
|
|
4461
|
+
export interface UpdateSpaceInput {
|
|
4462
|
+
/**
|
|
4463
|
+
* The unique ID of the space to update.
|
|
4464
|
+
* @public
|
|
4465
|
+
*/
|
|
4466
|
+
spaceId: string | undefined;
|
|
4467
|
+
/**
|
|
4468
|
+
* A new name for the space. Omit to leave unchanged. Must be 3-64 characters:
|
|
4469
|
+
* lowercase letters, numbers, and hyphens. It must begin and end with a letter or
|
|
4470
|
+
* number and cannot contain consecutive hyphens.
|
|
4471
|
+
* @public
|
|
4472
|
+
*/
|
|
4473
|
+
name?: string | undefined;
|
|
4474
|
+
/**
|
|
4475
|
+
* How to encrypt the space's data at rest. Omit to leave encryption unchanged.
|
|
4476
|
+
* Pass `encryptionStrategy` AWS_OWNED to stop using a customer managed key and
|
|
4477
|
+
* revert to service owned encryption.
|
|
4478
|
+
* @public
|
|
4479
|
+
*/
|
|
4480
|
+
encryptionConfiguration?: EncryptionConfiguration | undefined;
|
|
4481
|
+
}
|
|
4482
|
+
/**
|
|
4483
|
+
* @public
|
|
4484
|
+
*/
|
|
4485
|
+
export interface UpdateSpaceOutput {
|
|
4486
|
+
/**
|
|
4487
|
+
* The updated details of the space.
|
|
4488
|
+
* @public
|
|
4489
|
+
*/
|
|
4490
|
+
space: Space | undefined;
|
|
4491
|
+
}
|
|
4492
|
+
/**
|
|
4493
|
+
* @public
|
|
4494
|
+
*/
|
|
4495
|
+
export interface UpdateViewRequest {
|
|
4496
|
+
/**
|
|
4497
|
+
* The name of the view to update.
|
|
4498
|
+
* @public
|
|
4499
|
+
*/
|
|
4500
|
+
name: string | undefined;
|
|
4501
|
+
/**
|
|
4502
|
+
* The new SQL query that defines the view. Omit to leave unchanged.
|
|
4503
|
+
* @public
|
|
4504
|
+
*/
|
|
4505
|
+
definition?: string | undefined;
|
|
4506
|
+
/**
|
|
4507
|
+
* The new description of the view. Omit to leave unchanged.
|
|
4508
|
+
* @public
|
|
4509
|
+
*/
|
|
4510
|
+
description?: string | undefined;
|
|
4511
|
+
}
|
|
4512
|
+
/**
|
|
4513
|
+
* @public
|
|
4514
|
+
*/
|
|
4515
|
+
export interface UpdateViewResponse {
|
|
4516
|
+
/**
|
|
4517
|
+
* The name of the view.
|
|
4518
|
+
* @public
|
|
4519
|
+
*/
|
|
4520
|
+
name: string | undefined;
|
|
4521
|
+
/**
|
|
4522
|
+
* The ownership category of the view.
|
|
4523
|
+
* @public
|
|
4524
|
+
*/
|
|
4525
|
+
type: ViewType | undefined;
|
|
4526
|
+
/**
|
|
4527
|
+
* The description of the view.
|
|
4528
|
+
* @public
|
|
4529
|
+
*/
|
|
4530
|
+
description?: string | undefined;
|
|
4531
|
+
/**
|
|
4532
|
+
* The SQL query that defines the view.
|
|
4533
|
+
* @public
|
|
4534
|
+
*/
|
|
4535
|
+
definition: string | undefined;
|
|
4536
|
+
/**
|
|
4537
|
+
* The timestamp when the view was created.
|
|
4538
|
+
* @public
|
|
4539
|
+
*/
|
|
4540
|
+
createdAt: Date | undefined;
|
|
4541
|
+
/**
|
|
4542
|
+
* The timestamp when the view was last updated.
|
|
4543
|
+
* @public
|
|
4544
|
+
*/
|
|
4545
|
+
updatedAt: Date | undefined;
|
|
4546
|
+
/**
|
|
4547
|
+
* The ARN of the view.
|
|
4548
|
+
* @public
|
|
4549
|
+
*/
|
|
4550
|
+
arn: string | undefined;
|
|
4551
|
+
}
|
|
4552
|
+
/**
|
|
4553
|
+
* A telemetry field available for use in query expressions.
|
|
4554
|
+
* @public
|
|
4555
|
+
*/
|
|
4556
|
+
export interface Field {
|
|
4557
|
+
/**
|
|
4558
|
+
* The name of the field. Field names are case-sensitive and must be used
|
|
4559
|
+
* exactly as returned when referencing them in query expressions.
|
|
4560
|
+
* @public
|
|
4561
|
+
*/
|
|
4562
|
+
name: string | undefined;
|
|
4563
|
+
/**
|
|
4564
|
+
* Child fields nested under this field.
|
|
4565
|
+
* @public
|
|
4566
|
+
*/
|
|
4567
|
+
children?: Field[] | undefined;
|
|
4568
|
+
}
|
|
4569
|
+
/**
|
|
4570
|
+
* @public
|
|
4571
|
+
*/
|
|
4572
|
+
export interface ListTelemetryFieldsResponse {
|
|
4573
|
+
/**
|
|
4574
|
+
* The list of fields available for queries.
|
|
4575
|
+
* @public
|
|
4576
|
+
*/
|
|
4577
|
+
fields: Field[] | undefined;
|
|
4578
|
+
/**
|
|
4579
|
+
* A token to retrieve the next page of results, or null if there are no more results.
|
|
4580
|
+
* @public
|
|
4581
|
+
*/
|
|
4582
|
+
nextToken?: string | undefined;
|
|
4583
|
+
}
|