@aws-sdk/client-grafana 3.50.0 → 3.53.0

package/dist-types/ts3.4/models/models_0.d.ts

@@ -0,0 +1,679 @@
+import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
+import { GrafanaServiceException as __BaseException } from "./GrafanaServiceException";
+
+export declare class AccessDeniedException extends __BaseException {
+    readonly name: "AccessDeniedException";
+    readonly $fault: "client";
+    
+    constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
+}
+export declare enum AccountAccessType {
+    
+    CURRENT_ACCOUNT = "CURRENT_ACCOUNT",
+    
+    ORGANIZATION = "ORGANIZATION"
+}
+
+export interface AssertionAttributes {
+    
+    name?: string;
+    
+    login?: string;
+    
+    email?: string;
+    
+    groups?: string;
+    
+    role?: string;
+    
+    org?: string;
+}
+export declare namespace AssertionAttributes {
+    
+    const filterSensitiveLog: (obj: AssertionAttributes) => any;
+}
+export declare enum LicenseType {
+    
+    ENTERPRISE = "ENTERPRISE",
+    
+    ENTERPRISE_FREE_TRIAL = "ENTERPRISE_FREE_TRIAL"
+}
+export interface AssociateLicenseRequest {
+    
+    workspaceId: string | undefined;
+    
+    licenseType: LicenseType | string | undefined;
+}
+export declare namespace AssociateLicenseRequest {
+    
+    const filterSensitiveLog: (obj: AssociateLicenseRequest) => any;
+}
+export declare enum AuthenticationProviderTypes {
+    
+    AWS_SSO = "AWS_SSO",
+    
+    SAML = "SAML"
+}
+export declare enum SamlConfigurationStatus {
+    
+    CONFIGURED = "CONFIGURED",
+    
+    NOT_CONFIGURED = "NOT_CONFIGURED"
+}
+
+export interface AuthenticationSummary {
+    
+    providers: (AuthenticationProviderTypes | string)[] | undefined;
+    
+    samlConfigurationStatus?: SamlConfigurationStatus | string;
+}
+export declare namespace AuthenticationSummary {
+    
+    const filterSensitiveLog: (obj: AuthenticationSummary) => any;
+}
+export declare enum DataSourceType {
+    
+    AMAZON_OPENSEARCH_SERVICE = "AMAZON_OPENSEARCH_SERVICE",
+    
+    CLOUDWATCH = "CLOUDWATCH",
+    
+    PROMETHEUS = "PROMETHEUS",
+    
+    SITEWISE = "SITEWISE",
+    
+    TIMESTREAM = "TIMESTREAM",
+    
+    XRAY = "XRAY"
+}
+export declare enum NotificationDestinationType {
+    
+    SNS = "SNS"
+}
+export declare enum PermissionType {
+    
+    CUSTOMER_MANAGED = "CUSTOMER_MANAGED",
+    
+    SERVICE_MANAGED = "SERVICE_MANAGED"
+}
+export declare enum WorkspaceStatus {
+    
+    ACTIVE = "ACTIVE",
+    
+    CREATING = "CREATING",
+    
+    CREATION_FAILED = "CREATION_FAILED",
+    
+    DELETING = "DELETING",
+    
+    DELETION_FAILED = "DELETION_FAILED",
+    
+    FAILED = "FAILED",
+    
+    LICENSE_REMOVAL_FAILED = "LICENSE_REMOVAL_FAILED",
+    
+    UPDATE_FAILED = "UPDATE_FAILED",
+    
+    UPDATING = "UPDATING",
+    
+    UPGRADE_FAILED = "UPGRADE_FAILED",
+    
+    UPGRADING = "UPGRADING"
+}
+
+export interface WorkspaceDescription {
+    
+    accountAccessType?: AccountAccessType | string;
+    
+    created: Date | undefined;
+    
+    dataSources: (DataSourceType | string)[] | undefined;
+    
+    description?: string;
+    
+    endpoint: string | undefined;
+    
+    grafanaVersion: string | undefined;
+    
+    id: string | undefined;
+    
+    modified: Date | undefined;
+    
+    name?: string;
+    
+    organizationRoleName?: string;
+    
+    notificationDestinations?: (NotificationDestinationType | string)[];
+    
+    organizationalUnits?: string[];
+    
+    permissionType?: PermissionType | string;
+    
+    stackSetName?: string;
+    
+    status: WorkspaceStatus | string | undefined;
+    
+    workspaceRoleArn?: string;
+    
+    licenseType?: LicenseType | string;
+    
+    freeTrialConsumed?: boolean;
+    
+    licenseExpiration?: Date;
+    
+    freeTrialExpiration?: Date;
+    
+    authentication: AuthenticationSummary | undefined;
+}
+export declare namespace WorkspaceDescription {
+    
+    const filterSensitiveLog: (obj: WorkspaceDescription) => any;
+}
+export interface AssociateLicenseResponse {
+    
+    workspace: WorkspaceDescription | undefined;
+}
+export declare namespace AssociateLicenseResponse {
+    
+    const filterSensitiveLog: (obj: AssociateLicenseResponse) => any;
+}
+
+export declare class InternalServerException extends __BaseException {
+    readonly name: "InternalServerException";
+    readonly $fault: "server";
+    $retryable: {};
+    
+    retryAfterSeconds?: number;
+    
+    constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
+}
+
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    
+    resourceId: string | undefined;
+    
+    resourceType: string | undefined;
+    
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}
+
+export declare class ThrottlingException extends __BaseException {
+    readonly name: "ThrottlingException";
+    readonly $fault: "client";
+    $retryable: {};
+    
+    serviceCode?: string;
+    
+    quotaCode?: string;
+    
+    retryAfterSeconds?: number;
+    
+    constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
+}
+
+export interface ValidationExceptionField {
+    
+    name: string | undefined;
+    
+    message: string | undefined;
+}
+export declare namespace ValidationExceptionField {
+    
+    const filterSensitiveLog: (obj: ValidationExceptionField) => any;
+}
+export declare enum ValidationExceptionReason {
+    CANNOT_PARSE = "CANNOT_PARSE",
+    FIELD_VALIDATION_FAILED = "FIELD_VALIDATION_FAILED",
+    OTHER = "OTHER",
+    UNKNOWN_OPERATION = "UNKNOWN_OPERATION"
+}
+
+export declare class ValidationException extends __BaseException {
+    readonly name: "ValidationException";
+    readonly $fault: "client";
+    
+    reason: ValidationExceptionReason | string | undefined;
+    
+    fieldList?: ValidationExceptionField[];
+    
+    constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
+}
+export interface DescribeWorkspaceAuthenticationRequest {
+    
+    workspaceId: string | undefined;
+}
+export declare namespace DescribeWorkspaceAuthenticationRequest {
+    
+    const filterSensitiveLog: (obj: DescribeWorkspaceAuthenticationRequest) => any;
+}
+
+export interface AwsSsoAuthentication {
+    
+    ssoClientId?: string;
+}
+export declare namespace AwsSsoAuthentication {
+    
+    const filterSensitiveLog: (obj: AwsSsoAuthentication) => any;
+}
+
+export declare type IdpMetadata = IdpMetadata.UrlMember | IdpMetadata.XmlMember | IdpMetadata.$UnknownMember;
+export declare namespace IdpMetadata {
+    
+    interface UrlMember {
+        url: string;
+        xml?: never;
+        $unknown?: never;
+    }
+    
+    interface XmlMember {
+        url?: never;
+        xml: string;
+        $unknown?: never;
+    }
+    interface $UnknownMember {
+        url?: never;
+        xml?: never;
+        $unknown: [
+            string,
+            any
+        ];
+    }
+    interface Visitor<T> {
+        url: (value: string) => T;
+        xml: (value: string) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: IdpMetadata, visitor: Visitor<T>) => T;
+    
+    const filterSensitiveLog: (obj: IdpMetadata) => any;
+}
+
+export interface RoleValues {
+    
+    editor?: string[];
+    
+    admin?: string[];
+}
+export declare namespace RoleValues {
+    
+    const filterSensitiveLog: (obj: RoleValues) => any;
+}
+
+export interface SamlConfiguration {
+    
+    idpMetadata: IdpMetadata | undefined;
+    
+    assertionAttributes?: AssertionAttributes;
+    
+    roleValues?: RoleValues;
+    
+    allowedOrganizations?: string[];
+    
+    loginValidityDuration?: number;
+}
+export declare namespace SamlConfiguration {
+    
+    const filterSensitiveLog: (obj: SamlConfiguration) => any;
+}
+
+export interface SamlAuthentication {
+    
+    status: SamlConfigurationStatus | string | undefined;
+    
+    configuration?: SamlConfiguration;
+}
+export declare namespace SamlAuthentication {
+    
+    const filterSensitiveLog: (obj: SamlAuthentication) => any;
+}
+
+export interface AuthenticationDescription {
+    
+    providers: (AuthenticationProviderTypes | string)[] | undefined;
+    
+    saml?: SamlAuthentication;
+    
+    awsSso?: AwsSsoAuthentication;
+}
+export declare namespace AuthenticationDescription {
+    
+    const filterSensitiveLog: (obj: AuthenticationDescription) => any;
+}
+export interface DescribeWorkspaceAuthenticationResponse {
+    
+    authentication: AuthenticationDescription | undefined;
+}
+export declare namespace DescribeWorkspaceAuthenticationResponse {
+    
+    const filterSensitiveLog: (obj: DescribeWorkspaceAuthenticationResponse) => any;
+}
+
+export declare class ConflictException extends __BaseException {
+    readonly name: "ConflictException";
+    readonly $fault: "client";
+    
+    resourceId: string | undefined;
+    
+    resourceType: string | undefined;
+    
+    constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
+export interface UpdateWorkspaceAuthenticationRequest {
+    
+    workspaceId: string | undefined;
+    
+    authenticationProviders: (AuthenticationProviderTypes | string)[] | undefined;
+    
+    samlConfiguration?: SamlConfiguration;
+}
+export declare namespace UpdateWorkspaceAuthenticationRequest {
+    
+    const filterSensitiveLog: (obj: UpdateWorkspaceAuthenticationRequest) => any;
+}
+export interface UpdateWorkspaceAuthenticationResponse {
+    
+    authentication: AuthenticationDescription | undefined;
+}
+export declare namespace UpdateWorkspaceAuthenticationResponse {
+    
+    const filterSensitiveLog: (obj: UpdateWorkspaceAuthenticationResponse) => any;
+}
+export interface DisassociateLicenseRequest {
+    
+    workspaceId: string | undefined;
+    
+    licenseType: LicenseType | string | undefined;
+}
+export declare namespace DisassociateLicenseRequest {
+    
+    const filterSensitiveLog: (obj: DisassociateLicenseRequest) => any;
+}
+export interface DisassociateLicenseResponse {
+    
+    workspace: WorkspaceDescription | undefined;
+}
+export declare namespace DisassociateLicenseResponse {
+    
+    const filterSensitiveLog: (obj: DisassociateLicenseResponse) => any;
+}
+export declare enum UserType {
+    
+    SSO_GROUP = "SSO_GROUP",
+    
+    SSO_USER = "SSO_USER"
+}
+export interface ListPermissionsRequest {
+    
+    maxResults?: number;
+    
+    nextToken?: string;
+    
+    userType?: UserType | string;
+    
+    userId?: string;
+    
+    groupId?: string;
+    
+    workspaceId: string | undefined;
+}
+export declare namespace ListPermissionsRequest {
+    
+    const filterSensitiveLog: (obj: ListPermissionsRequest) => any;
+}
+export declare enum Role {
+    
+    ADMIN = "ADMIN",
+    
+    EDITOR = "EDITOR"
+}
+
+export interface User {
+    
+    id: string | undefined;
+    
+    type: UserType | string | undefined;
+}
+export declare namespace User {
+    
+    const filterSensitiveLog: (obj: User) => any;
+}
+
+export interface PermissionEntry {
+    
+    user: User | undefined;
+    
+    role: Role | string | undefined;
+}
+export declare namespace PermissionEntry {
+    
+    const filterSensitiveLog: (obj: PermissionEntry) => any;
+}
+export interface ListPermissionsResponse {
+    
+    nextToken?: string;
+    
+    permissions: PermissionEntry[] | undefined;
+}
+export declare namespace ListPermissionsResponse {
+    
+    const filterSensitiveLog: (obj: ListPermissionsResponse) => any;
+}
+export declare enum UpdateAction {
+    
+    ADD = "ADD",
+    
+    REVOKE = "REVOKE"
+}
+
+export interface UpdateInstruction {
+    
+    action: UpdateAction | string | undefined;
+    
+    role: Role | string | undefined;
+    
+    users: User[] | undefined;
+}
+export declare namespace UpdateInstruction {
+    
+    const filterSensitiveLog: (obj: UpdateInstruction) => any;
+}
+export interface UpdatePermissionsRequest {
+    
+    updateInstructionBatch: UpdateInstruction[] | undefined;
+    
+    workspaceId: string | undefined;
+}
+export declare namespace UpdatePermissionsRequest {
+    
+    const filterSensitiveLog: (obj: UpdatePermissionsRequest) => any;
+}
+
+export interface UpdateError {
+    
+    code: number | undefined;
+    
+    message: string | undefined;
+    
+    causedBy: UpdateInstruction | undefined;
+}
+export declare namespace UpdateError {
+    
+    const filterSensitiveLog: (obj: UpdateError) => any;
+}
+export interface UpdatePermissionsResponse {
+    
+    errors: UpdateError[] | undefined;
+}
+export declare namespace UpdatePermissionsResponse {
+    
+    const filterSensitiveLog: (obj: UpdatePermissionsResponse) => any;
+}
+export interface CreateWorkspaceRequest {
+    
+    accountAccessType: AccountAccessType | string | undefined;
+    
+    clientToken?: string;
+    
+    organizationRoleName?: string;
+    
+    permissionType: PermissionType | string | undefined;
+    
+    stackSetName?: string;
+    
+    workspaceDataSources?: (DataSourceType | string)[];
+    
+    workspaceDescription?: string;
+    
+    workspaceName?: string;
+    
+    workspaceNotificationDestinations?: (NotificationDestinationType | string)[];
+    
+    workspaceOrganizationalUnits?: string[];
+    
+    workspaceRoleArn?: string;
+    
+    authenticationProviders: (AuthenticationProviderTypes | string)[] | undefined;
+}
+export declare namespace CreateWorkspaceRequest {
+    
+    const filterSensitiveLog: (obj: CreateWorkspaceRequest) => any;
+}
+export interface CreateWorkspaceResponse {
+    
+    workspace: WorkspaceDescription | undefined;
+}
+export declare namespace CreateWorkspaceResponse {
+    
+    const filterSensitiveLog: (obj: CreateWorkspaceResponse) => any;
+}
+
+export declare class ServiceQuotaExceededException extends __BaseException {
+    readonly name: "ServiceQuotaExceededException";
+    readonly $fault: "client";
+    
+    resourceId: string | undefined;
+    
+    resourceType: string | undefined;
+    
+    serviceCode: string | undefined;
+    
+    quotaCode: string | undefined;
+    
+    constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
+}
+export interface DeleteWorkspaceRequest {
+    
+    workspaceId: string | undefined;
+}
+export declare namespace DeleteWorkspaceRequest {
+    
+    const filterSensitiveLog: (obj: DeleteWorkspaceRequest) => any;
+}
+export interface DeleteWorkspaceResponse {
+    
+    workspace: WorkspaceDescription | undefined;
+}
+export declare namespace DeleteWorkspaceResponse {
+    
+    const filterSensitiveLog: (obj: DeleteWorkspaceResponse) => any;
+}
+export interface DescribeWorkspaceRequest {
+    
+    workspaceId: string | undefined;
+}
+export declare namespace DescribeWorkspaceRequest {
+    
+    const filterSensitiveLog: (obj: DescribeWorkspaceRequest) => any;
+}
+export interface DescribeWorkspaceResponse {
+    
+    workspace: WorkspaceDescription | undefined;
+}
+export declare namespace DescribeWorkspaceResponse {
+    
+    const filterSensitiveLog: (obj: DescribeWorkspaceResponse) => any;
+}
+export interface ListWorkspacesRequest {
+    
+    maxResults?: number;
+    
+    nextToken?: string;
+}
+export declare namespace ListWorkspacesRequest {
+    
+    const filterSensitiveLog: (obj: ListWorkspacesRequest) => any;
+}
+
+export interface WorkspaceSummary {
+    
+    created: Date | undefined;
+    
+    description?: string;
+    
+    endpoint: string | undefined;
+    
+    grafanaVersion: string | undefined;
+    
+    id: string | undefined;
+    
+    modified: Date | undefined;
+    
+    name?: string;
+    
+    notificationDestinations?: (NotificationDestinationType | string)[];
+    
+    status: WorkspaceStatus | string | undefined;
+    
+    authentication: AuthenticationSummary | undefined;
+}
+export declare namespace WorkspaceSummary {
+    
+    const filterSensitiveLog: (obj: WorkspaceSummary) => any;
+}
+export interface ListWorkspacesResponse {
+    
+    workspaces: WorkspaceSummary[] | undefined;
+    
+    nextToken?: string;
+}
+export declare namespace ListWorkspacesResponse {
+    
+    const filterSensitiveLog: (obj: ListWorkspacesResponse) => any;
+}
+export interface UpdateWorkspaceRequest {
+    
+    accountAccessType?: AccountAccessType | string;
+    
+    organizationRoleName?: string;
+    
+    permissionType?: PermissionType | string;
+    
+    stackSetName?: string;
+    
+    workspaceDataSources?: (DataSourceType | string)[];
+    
+    workspaceDescription?: string;
+    
+    workspaceId: string | undefined;
+    
+    workspaceName?: string;
+    
+    workspaceNotificationDestinations?: (NotificationDestinationType | string)[];
+    
+    workspaceOrganizationalUnits?: string[];
+    
+    workspaceRoleArn?: string;
+}
+export declare namespace UpdateWorkspaceRequest {
+    
+    const filterSensitiveLog: (obj: UpdateWorkspaceRequest) => any;
+}
+export interface UpdateWorkspaceResponse {
+    
+    workspace: WorkspaceDescription | undefined;
+}
+export declare namespace UpdateWorkspaceResponse {
+    
+    const filterSensitiveLog: (obj: UpdateWorkspaceResponse) => any;
+}

package/dist-types/ts3.4/pagination/Interfaces.d.ts

@@ -0,0 +1,6 @@
+import { PaginationConfiguration } from "@aws-sdk/types";
+import { Grafana } from "../Grafana";
+import { GrafanaClient } from "../GrafanaClient";
+export interface GrafanaPaginationConfiguration extends PaginationConfiguration {
+    client: Grafana | GrafanaClient;
+}

package/dist-types/ts3.4/pagination/ListPermissionsPaginator.d.ts

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListPermissionsCommandInput, ListPermissionsCommandOutput } from "../commands/ListPermissionsCommand";
+import { GrafanaPaginationConfiguration } from "./Interfaces";
+export declare function paginateListPermissions(config: GrafanaPaginationConfiguration, input: ListPermissionsCommandInput, ...additionalArguments: any): Paginator<ListPermissionsCommandOutput>;

package/dist-types/ts3.4/pagination/ListWorkspacesPaginator.d.ts

@@ -0,0 +1,4 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListWorkspacesCommandInput, ListWorkspacesCommandOutput } from "../commands/ListWorkspacesCommand";
+import { GrafanaPaginationConfiguration } from "./Interfaces";
+export declare function paginateListWorkspaces(config: GrafanaPaginationConfiguration, input: ListWorkspacesCommandInput, ...additionalArguments: any): Paginator<ListWorkspacesCommandOutput>;

package/dist-types/ts3.4/pagination/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Interfaces";
+export * from "./ListPermissionsPaginator";
+export * from "./ListWorkspacesPaginator";