managedgrafana

package
v1.44.40 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 22, 2022 License: Apache-2.0 Imports: 10 Imported by: 19

Documentation

Overview

Package managedgrafana provides the client and types for making API requests to Amazon Managed Grafana.

Amazon Managed Grafana is a fully managed and secure data visualization service that you can use to instantly query, correlate, and visualize operational metrics, logs, and traces from multiple sources. Amazon Managed Grafana makes it easy to deploy, operate, and scale Grafana, a widely deployed data visualization tool that is popular for its extensible data support.

With Amazon Managed Grafana, you create logically isolated Grafana servers called workspaces. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces without having to build, package, or deploy any hardware to run Grafana servers.

See https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18 for more information on this service.

See managedgrafana package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/managedgrafana/

Using the Client

To contact Amazon Managed Grafana with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon Managed Grafana client ManagedGrafana for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/managedgrafana/#New

Index

Constants

View Source 
const (
	// AccountAccessTypeCurrentAccount is a AccountAccessType enum value
	AccountAccessTypeCurrentAccount = "CURRENT_ACCOUNT"

	// AccountAccessTypeOrganization is a AccountAccessType enum value
	AccountAccessTypeOrganization = "ORGANIZATION"
)
View Source 
const (
	// AuthenticationProviderTypesAwsSso is a AuthenticationProviderTypes enum value
	AuthenticationProviderTypesAwsSso = "AWS_SSO"

	// AuthenticationProviderTypesSaml is a AuthenticationProviderTypes enum value
	AuthenticationProviderTypesSaml = "SAML"
)
View Source 
const (
	// DataSourceTypeAmazonOpensearchService is a DataSourceType enum value
	DataSourceTypeAmazonOpensearchService = "AMAZON_OPENSEARCH_SERVICE"

	// DataSourceTypeCloudwatch is a DataSourceType enum value
	DataSourceTypeCloudwatch = "CLOUDWATCH"

	// DataSourceTypePrometheus is a DataSourceType enum value
	DataSourceTypePrometheus = "PROMETHEUS"

	// DataSourceTypeXray is a DataSourceType enum value
	DataSourceTypeXray = "XRAY"

	// DataSourceTypeTimestream is a DataSourceType enum value
	DataSourceTypeTimestream = "TIMESTREAM"

	// DataSourceTypeSitewise is a DataSourceType enum value
	DataSourceTypeSitewise = "SITEWISE"

	// DataSourceTypeAthena is a DataSourceType enum value
	DataSourceTypeAthena = "ATHENA"

	// DataSourceTypeRedshift is a DataSourceType enum value
	DataSourceTypeRedshift = "REDSHIFT"
)
View Source 
const (
	// LicenseTypeEnterprise is a LicenseType enum value
	LicenseTypeEnterprise = "ENTERPRISE"

	// LicenseTypeEnterpriseFreeTrial is a LicenseType enum value
	LicenseTypeEnterpriseFreeTrial = "ENTERPRISE_FREE_TRIAL"
)
View Source 
const (
	// PermissionTypeCustomerManaged is a PermissionType enum value
	PermissionTypeCustomerManaged = "CUSTOMER_MANAGED"

	// PermissionTypeServiceManaged is a PermissionType enum value
	PermissionTypeServiceManaged = "SERVICE_MANAGED"
)
View Source 
const (
	// RoleAdmin is a Role enum value
	RoleAdmin = "ADMIN"

	// RoleEditor is a Role enum value
	RoleEditor = "EDITOR"

	// RoleViewer is a Role enum value
	RoleViewer = "VIEWER"
)
View Source 
const (
	// SamlConfigurationStatusConfigured is a SamlConfigurationStatus enum value
	SamlConfigurationStatusConfigured = "CONFIGURED"

	// SamlConfigurationStatusNotConfigured is a SamlConfigurationStatus enum value
	SamlConfigurationStatusNotConfigured = "NOT_CONFIGURED"
)
View Source 
const (
	// UpdateActionAdd is a UpdateAction enum value
	UpdateActionAdd = "ADD"

	// UpdateActionRevoke is a UpdateAction enum value
	UpdateActionRevoke = "REVOKE"
)
View Source 
const (
	// UserTypeSsoUser is a UserType enum value
	UserTypeSsoUser = "SSO_USER"

	// UserTypeSsoGroup is a UserType enum value
	UserTypeSsoGroup = "SSO_GROUP"
)
View Source 
const (
	// ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value
	ValidationExceptionReasonUnknownOperation = "UNKNOWN_OPERATION"

	// ValidationExceptionReasonCannotParse is a ValidationExceptionReason enum value
	ValidationExceptionReasonCannotParse = "CANNOT_PARSE"

	// ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value
	ValidationExceptionReasonFieldValidationFailed = "FIELD_VALIDATION_FAILED"

	// ValidationExceptionReasonOther is a ValidationExceptionReason enum value
	ValidationExceptionReasonOther = "OTHER"
)
View Source 
const (
	// WorkspaceStatusActive is a WorkspaceStatus enum value
	WorkspaceStatusActive = "ACTIVE"

	// WorkspaceStatusCreating is a WorkspaceStatus enum value
	WorkspaceStatusCreating = "CREATING"

	// WorkspaceStatusDeleting is a WorkspaceStatus enum value
	WorkspaceStatusDeleting = "DELETING"

	// WorkspaceStatusFailed is a WorkspaceStatus enum value
	WorkspaceStatusFailed = "FAILED"

	// WorkspaceStatusUpdating is a WorkspaceStatus enum value
	WorkspaceStatusUpdating = "UPDATING"

	// WorkspaceStatusUpgrading is a WorkspaceStatus enum value
	WorkspaceStatusUpgrading = "UPGRADING"

	// WorkspaceStatusDeletionFailed is a WorkspaceStatus enum value
	WorkspaceStatusDeletionFailed = "DELETION_FAILED"

	// WorkspaceStatusCreationFailed is a WorkspaceStatus enum value
	WorkspaceStatusCreationFailed = "CREATION_FAILED"

	// WorkspaceStatusUpdateFailed is a WorkspaceStatus enum value
	WorkspaceStatusUpdateFailed = "UPDATE_FAILED"

	// WorkspaceStatusUpgradeFailed is a WorkspaceStatus enum value
	WorkspaceStatusUpgradeFailed = "UPGRADE_FAILED"

	// WorkspaceStatusLicenseRemovalFailed is a WorkspaceStatus enum value
	WorkspaceStatusLicenseRemovalFailed = "LICENSE_REMOVAL_FAILED"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You do not have sufficient permissions to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// A resource was in an inconsistent state during an update or a deletion.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// Unexpected error while processing the request. Retry the request.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The request references a resource that does not exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The request would cause a service quota to be exceeded.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// The request was denied because of request throttling. Retry the request.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The value of a parameter in the request caused an error.
	ErrCodeValidationException = "ValidationException"
)
View Source 
const (
	ServiceName = "grafana"   // Name of service.
	EndpointsID = ServiceName // ID to lookup a service endpoint with.
	ServiceID   = "grafana"   // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// NotificationDestinationTypeSns is a NotificationDestinationType enum value
	NotificationDestinationTypeSns = "SNS"
)

Variables

This section is empty.

Functions

func AccountAccessType_Values 

func AccountAccessType_Values() []string

AccountAccessType_Values returns all elements of the AccountAccessType enum

func AuthenticationProviderTypes_Values 

func AuthenticationProviderTypes_Values() []string

AuthenticationProviderTypes_Values returns all elements of the AuthenticationProviderTypes enum

func DataSourceType_Values 

func DataSourceType_Values() []string

DataSourceType_Values returns all elements of the DataSourceType enum

func LicenseType_Values 

func LicenseType_Values() []string

LicenseType_Values returns all elements of the LicenseType enum

func NotificationDestinationType_Values 

func NotificationDestinationType_Values() []string

NotificationDestinationType_Values returns all elements of the NotificationDestinationType enum

func PermissionType_Values 

func PermissionType_Values() []string

PermissionType_Values returns all elements of the PermissionType enum

func Role_Values 

func Role_Values() []string

Role_Values returns all elements of the Role enum

func SamlConfigurationStatus_Values 

func SamlConfigurationStatus_Values() []string

SamlConfigurationStatus_Values returns all elements of the SamlConfigurationStatus enum

func UpdateAction_Values 

func UpdateAction_Values() []string

UpdateAction_Values returns all elements of the UpdateAction enum

func UserType_Values 

func UserType_Values() []string

UserType_Values returns all elements of the UserType enum

func ValidationExceptionReason_Values 

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

func WorkspaceStatus_Values 

func WorkspaceStatus_Values() []string

WorkspaceStatus_Values returns all elements of the WorkspaceStatus enum

Types

type AccessDeniedException 

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

You do not have sufficient permissions to perform this action.

func (*AccessDeniedException) Code 

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error 

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString 

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message 

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr 

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID 

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode 

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String 

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssertionAttributes 

type AssertionAttributes struct {

	// The name of the attribute within the SAML assertion to use as the email names
	// for SAML users.
	Email *string `locationName:"email" min:"1" type:"string"`

	// The name of the attribute within the SAML assertion to use as the user full
	// "friendly" names for user groups.
	Groups *string `locationName:"groups" min:"1" type:"string"`

	// The name of the attribute within the SAML assertion to use as the login names
	// for SAML users.
	Login *string `locationName:"login" min:"1" type:"string"`

	// The name of the attribute within the SAML assertion to use as the user full
	// "friendly" names for SAML users.
	Name *string `locationName:"name" min:"1" type:"string"`

	// The name of the attribute within the SAML assertion to use as the user full
	// "friendly" names for the users' organizations.
	Org *string `locationName:"org" min:"1" type:"string"`

	// The name of the attribute within the SAML assertion to use as the user roles.
	Role *string `locationName:"role" min:"1" type:"string"`
	// contains filtered or unexported fields
}

A structure that defines which attributes in the IdP assertion are to be used to define information about the users authenticated by the IdP to use the workspace.

func (AssertionAttributes) GoString 

func (s AssertionAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssertionAttributes) SetEmail 

func (s *AssertionAttributes) SetEmail(v string) *AssertionAttributes

SetEmail sets the Email field's value.

func (*AssertionAttributes) SetGroups 

func (s *AssertionAttributes) SetGroups(v string) *AssertionAttributes

SetGroups sets the Groups field's value.

func (*AssertionAttributes) SetLogin 

func (s *AssertionAttributes) SetLogin(v string) *AssertionAttributes

SetLogin sets the Login field's value.

func (*AssertionAttributes) SetName 

func (s *AssertionAttributes) SetName(v string) *AssertionAttributes

SetName sets the Name field's value.

func (*AssertionAttributes) SetOrg 

func (s *AssertionAttributes) SetOrg(v string) *AssertionAttributes

SetOrg sets the Org field's value.

func (*AssertionAttributes) SetRole 

func (s *AssertionAttributes) SetRole(v string) *AssertionAttributes

SetRole sets the Role field's value.

func (AssertionAttributes) String 

func (s AssertionAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssertionAttributes) Validate 

func (s *AssertionAttributes) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateLicenseInput 

type AssociateLicenseInput struct {

	// The type of license to associate with the workspace.
	//
	// LicenseType is a required field
	LicenseType *string `location:"uri" locationName:"licenseType" type:"string" required:"true" enum:"LicenseType"`

	// The ID of the workspace to associate the license with.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateLicenseInput) GoString 

func (s AssociateLicenseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateLicenseInput) SetLicenseType 

func (s *AssociateLicenseInput) SetLicenseType(v string) *AssociateLicenseInput

SetLicenseType sets the LicenseType field's value.

func (*AssociateLicenseInput) SetWorkspaceId 

func (s *AssociateLicenseInput) SetWorkspaceId(v string) *AssociateLicenseInput

SetWorkspaceId sets the WorkspaceId field's value.

func (AssociateLicenseInput) String 

func (s AssociateLicenseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateLicenseInput) Validate 

func (s *AssociateLicenseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateLicenseOutput 

type AssociateLicenseOutput struct {

	// A structure containing data about the workspace.
	//
	// Workspace is a required field
	Workspace *WorkspaceDescription `locationName:"workspace" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (AssociateLicenseOutput) GoString 

func (s AssociateLicenseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateLicenseOutput) SetWorkspace 

func (s *AssociateLicenseOutput) SetWorkspace(v *WorkspaceDescription) *AssociateLicenseOutput

SetWorkspace sets the Workspace field's value.

func (AssociateLicenseOutput) String 

func (s AssociateLicenseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuthenticationDescription 

type AuthenticationDescription struct {

	// A structure containing information about how this workspace works with Amazon
	// Web Services SSO.
	AwsSso *AwsSsoAuthentication `locationName:"awsSso" type:"structure"`

	// Specifies whether this workspace uses Amazon Web Services SSO, SAML, or both
	// methods to authenticate users to use the Grafana console in the Amazon Managed
	// Grafana workspace.
	//
	// Providers is a required field
	Providers []*string `locationName:"providers" type:"list" required:"true" enum:"AuthenticationProviderTypes"`

	// A structure containing information about how this workspace works with SAML,
	// including what attributes within the assertion are to be mapped to user information
	// in the workspace.
	Saml *SamlAuthentication `locationName:"saml" type:"structure"`
	// contains filtered or unexported fields
}

A structure containing information about the user authentication methods used by the workspace.

func (AuthenticationDescription) GoString 

func (s AuthenticationDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthenticationDescription) SetAwsSso 

func (s *AuthenticationDescription) SetAwsSso(v *AwsSsoAuthentication) *AuthenticationDescription

SetAwsSso sets the AwsSso field's value.

func (*AuthenticationDescription) SetProviders 

func (s *AuthenticationDescription) SetProviders(v []*string) *AuthenticationDescription

SetProviders sets the Providers field's value.

func (*AuthenticationDescription) SetSaml 

func (s *AuthenticationDescription) SetSaml(v *SamlAuthentication) *AuthenticationDescription

SetSaml sets the Saml field's value.

func (AuthenticationDescription) String 

func (s AuthenticationDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AuthenticationSummary 

type AuthenticationSummary struct {

	// Specifies whether the workspace uses SAML, Amazon Web Services SSO, or both
	// methods for user authentication.
	//
	// Providers is a required field
	Providers []*string `locationName:"providers" type:"list" required:"true" enum:"AuthenticationProviderTypes"`

	// Specifies whether the workplace's user authentication method is fully configured.
	SamlConfigurationStatus *string `locationName:"samlConfigurationStatus" type:"string" enum:"SamlConfigurationStatus"`
	// contains filtered or unexported fields
}

A structure that describes whether the workspace uses SAML, Amazon Web Services SSO, or both methods for user authentication, and whether that authentication is fully configured.

func (AuthenticationSummary) GoString 

func (s AuthenticationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AuthenticationSummary) SetProviders 

func (s *AuthenticationSummary) SetProviders(v []*string) *AuthenticationSummary

SetProviders sets the Providers field's value.

func (*AuthenticationSummary) SetSamlConfigurationStatus 

func (s *AuthenticationSummary) SetSamlConfigurationStatus(v string) *AuthenticationSummary

SetSamlConfigurationStatus sets the SamlConfigurationStatus field's value.

func (AuthenticationSummary) String 

func (s AuthenticationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AwsSsoAuthentication 

type AwsSsoAuthentication struct {

	// The ID of the Amazon Web Services SSO-managed application that is created
	// by Amazon Managed Grafana.
	SsoClientId *string `locationName:"ssoClientId" type:"string"`
	// contains filtered or unexported fields
}

A structure containing information about how this workspace works with Amazon Web Services SSO.

func (AwsSsoAuthentication) GoString 

func (s AwsSsoAuthentication) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AwsSsoAuthentication) SetSsoClientId 

func (s *AwsSsoAuthentication) SetSsoClientId(v string) *AwsSsoAuthentication

SetSsoClientId sets the SsoClientId field's value.

func (AwsSsoAuthentication) String 

func (s AwsSsoAuthentication) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException 

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// The ID of the resource that is associated with the error.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of the resource that is associated with the error.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A resource was in an inconsistent state during an update or a deletion.

func (*ConflictException) Code 

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error 

func (s *ConflictException) Error() string

func (ConflictException) GoString 

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message 

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr 

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID 

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode 

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String 

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWorkspaceApiKeyInput added in v1.44.14 

type CreateWorkspaceApiKeyInput struct {

	// Specifies the name of the key to create. Key names must be unique to the
	// workspace.
	//
	// KeyName is a required field
	KeyName *string `locationName:"keyName" min:"1" type:"string" required:"true"`

	// Specifies the permission level of the key.
	//
	// Valid Values: VIEWER | EDITOR | ADMIN
	//
	// KeyRole is a required field
	KeyRole *string `locationName:"keyRole" type:"string" required:"true"`

	// Specifies the time in seconds until the key expires. Keys can be valid for
	// up to 30 days.
	//
	// SecondsToLive is a required field
	SecondsToLive *int64 `locationName:"secondsToLive" min:"1" type:"integer" required:"true"`

	// The ID of the workspace in which to create an API key.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateWorkspaceApiKeyInput) GoString added in v1.44.14 

func (s CreateWorkspaceApiKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceApiKeyInput) SetKeyName added in v1.44.14 

func (s *CreateWorkspaceApiKeyInput) SetKeyName(v string) *CreateWorkspaceApiKeyInput

SetKeyName sets the KeyName field's value.

func (*CreateWorkspaceApiKeyInput) SetKeyRole added in v1.44.14 

func (s *CreateWorkspaceApiKeyInput) SetKeyRole(v string) *CreateWorkspaceApiKeyInput

SetKeyRole sets the KeyRole field's value.

func (*CreateWorkspaceApiKeyInput) SetSecondsToLive added in v1.44.14 

func (s *CreateWorkspaceApiKeyInput) SetSecondsToLive(v int64) *CreateWorkspaceApiKeyInput

SetSecondsToLive sets the SecondsToLive field's value.

func (*CreateWorkspaceApiKeyInput) SetWorkspaceId added in v1.44.14 

func (s *CreateWorkspaceApiKeyInput) SetWorkspaceId(v string) *CreateWorkspaceApiKeyInput

SetWorkspaceId sets the WorkspaceId field's value.

func (CreateWorkspaceApiKeyInput) String added in v1.44.14 

func (s CreateWorkspaceApiKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceApiKeyInput) Validate added in v1.44.14 

func (s *CreateWorkspaceApiKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateWorkspaceApiKeyOutput added in v1.44.14 

type CreateWorkspaceApiKeyOutput struct {

	// The key token that was created. Use this value as a bearer token to authenticate
	// HTTP requests to the workspace.
	//
	// Key is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateWorkspaceApiKeyOutput's
	// String and GoString methods.
	//
	// Key is a required field
	Key *string `locationName:"key" type:"string" required:"true" sensitive:"true"`

	// The name of the key that was created.
	//
	// KeyName is a required field
	KeyName *string `locationName:"keyName" min:"1" type:"string" required:"true"`

	// The ID of the workspace that the key is valid for.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `locationName:"workspaceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateWorkspaceApiKeyOutput) GoString added in v1.44.14 

func (s CreateWorkspaceApiKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceApiKeyOutput) SetKey added in v1.44.14 

func (s *CreateWorkspaceApiKeyOutput) SetKey(v string) *CreateWorkspaceApiKeyOutput

SetKey sets the Key field's value.

func (*CreateWorkspaceApiKeyOutput) SetKeyName added in v1.44.14 

func (s *CreateWorkspaceApiKeyOutput) SetKeyName(v string) *CreateWorkspaceApiKeyOutput

SetKeyName sets the KeyName field's value.

func (*CreateWorkspaceApiKeyOutput) SetWorkspaceId added in v1.44.14 

func (s *CreateWorkspaceApiKeyOutput) SetWorkspaceId(v string) *CreateWorkspaceApiKeyOutput

SetWorkspaceId sets the WorkspaceId field's value.

func (CreateWorkspaceApiKeyOutput) String added in v1.44.14 

func (s CreateWorkspaceApiKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWorkspaceInput 

type CreateWorkspaceInput struct {

	// Specifies whether the workspace can access Amazon Web Services resources
	// in this Amazon Web Services account only, or whether it can also access Amazon
	// Web Services resources in other accounts in the same organization. If you
	// specify ORGANIZATION, you must specify which organizational units the workspace
	// can access in the workspaceOrganizationalUnits parameter.
	//
	// AccountAccessType is a required field
	AccountAccessType *string `locationName:"accountAccessType" type:"string" required:"true" enum:"AccountAccessType"`

	// Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single
	// Sign On, or both to authenticate users for using the Grafana console within
	// a workspace. For more information, see User authentication in Amazon Managed
	// Grafana (https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html).
	//
	// AuthenticationProviders is a required field
	AuthenticationProviders []*string `locationName:"authenticationProviders" type:"list" required:"true" enum:"AuthenticationProviderTypes"`

	// A unique, case-sensitive, user-provided identifier to ensure the idempotency
	// of the request.
	ClientToken *string `locationName:"clientToken" type:"string" idempotencyToken:"true"`

	// The name of an IAM role that already exists to use with Organizations to
	// access Amazon Web Services data sources and notification channels in other
	// accounts in an organization.
	//
	// OrganizationRoleName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateWorkspaceInput's
	// String and GoString methods.
	OrganizationRoleName *string `locationName:"organizationRoleName" min:"1" type:"string" sensitive:"true"`

	// If you specify SERVICE_MANAGED on AWS Grafana console, Amazon Managed Grafana
	// automatically creates the IAM roles and provisions the permissions that the
	// workspace needs to use Amazon Web Services data sources and notification
	// channels. In CLI mode, the permissionType SERVICE_MANAGED will not create
	// the IAM role for you.
	//
	// If you specify CUSTOMER_MANAGED, you will manage those roles and permissions
	// yourself. If you are creating this workspace in a member account of an organization
	// that is not a delegated administrator account, and you want the workspace
	// to access data sources in other Amazon Web Services accounts in the organization,
	// you must choose CUSTOMER_MANAGED.
	//
	// For more information, see Amazon Managed Grafana permissions and policies
	// for Amazon Web Services data sources and notification channels (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html).
	//
	// PermissionType is a required field
	PermissionType *string `locationName:"permissionType" type:"string" required:"true" enum:"PermissionType"`

	// The name of the CloudFormation stack set to use to generate IAM roles to
	// be used for this workspace.
	StackSetName *string `locationName:"stackSetName" type:"string"`

	// The list of tags associated with the workspace.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// Specify the Amazon Web Services data sources that you want to be queried
	// in this workspace. Specifying these data sources here enables Amazon Managed
	// Grafana to create IAM roles and permissions that allow Amazon Managed Grafana
	// to read data from these sources. You must still add them as data sources
	// in the Grafana console in the workspace.
	//
	// If you don't specify a data source here, you can still add it as a data source
	// in the workspace console later. However, you will then have to manually configure
	// permissions for it.
	WorkspaceDataSources []*string `locationName:"workspaceDataSources" type:"list" enum:"DataSourceType"`

	// A description for the workspace. This is used only to help you identify this
	// workspace.
	//
	// Pattern: ^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$
	//
	// WorkspaceDescription is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateWorkspaceInput's
	// String and GoString methods.
	WorkspaceDescription *string `locationName:"workspaceDescription" type:"string" sensitive:"true"`

	// The name for the workspace. It does not have to be unique.
	//
	// WorkspaceName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateWorkspaceInput's
	// String and GoString methods.
	WorkspaceName *string `locationName:"workspaceName" type:"string" sensitive:"true"`

	// Specify the Amazon Web Services notification channels that you plan to use
	// in this workspace. Specifying these data sources here enables Amazon Managed
	// Grafana to create IAM roles and permissions that allow Amazon Managed Grafana
	// to use these channels.
	WorkspaceNotificationDestinations []*string `locationName:"workspaceNotificationDestinations" type:"list" enum:"NotificationDestinationType"`

	// Specifies the organizational units that this workspace is allowed to use
	// data sources from, if this workspace is in an account that is part of an
	// organization.
	//
	// WorkspaceOrganizationalUnits is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateWorkspaceInput's
	// String and GoString methods.
	WorkspaceOrganizationalUnits []*string `locationName:"workspaceOrganizationalUnits" type:"list" sensitive:"true"`

	// The workspace needs an IAM role that grants permissions to the Amazon Web
	// Services resources that the workspace will view data from. If you already
	// have a role that you want to use, specify it here. The permission type should
	// be set to CUSTOMER_MANAGED.
	//
	// WorkspaceRoleArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateWorkspaceInput's
	// String and GoString methods.
	WorkspaceRoleArn *string `locationName:"workspaceRoleArn" min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (CreateWorkspaceInput) GoString 

func (s CreateWorkspaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceInput) SetAccountAccessType 

func (s *CreateWorkspaceInput) SetAccountAccessType(v string) *CreateWorkspaceInput

SetAccountAccessType sets the AccountAccessType field's value.

func (*CreateWorkspaceInput) SetAuthenticationProviders 

func (s *CreateWorkspaceInput) SetAuthenticationProviders(v []*string) *CreateWorkspaceInput

SetAuthenticationProviders sets the AuthenticationProviders field's value.

func (*CreateWorkspaceInput) SetClientToken 

func (s *CreateWorkspaceInput) SetClientToken(v string) *CreateWorkspaceInput

SetClientToken sets the ClientToken field's value.

func (*CreateWorkspaceInput) SetOrganizationRoleName 

func (s *CreateWorkspaceInput) SetOrganizationRoleName(v string) *CreateWorkspaceInput

SetOrganizationRoleName sets the OrganizationRoleName field's value.

func (*CreateWorkspaceInput) SetPermissionType 

func (s *CreateWorkspaceInput) SetPermissionType(v string) *CreateWorkspaceInput

SetPermissionType sets the PermissionType field's value.

func (*CreateWorkspaceInput) SetStackSetName 

func (s *CreateWorkspaceInput) SetStackSetName(v string) *CreateWorkspaceInput

SetStackSetName sets the StackSetName field's value.

func (*CreateWorkspaceInput) SetTags added in v1.43.30 

func (s *CreateWorkspaceInput) SetTags(v map[string]*string) *CreateWorkspaceInput

SetTags sets the Tags field's value.

func (*CreateWorkspaceInput) SetWorkspaceDataSources 

func (s *CreateWorkspaceInput) SetWorkspaceDataSources(v []*string) *CreateWorkspaceInput

SetWorkspaceDataSources sets the WorkspaceDataSources field's value.

func (*CreateWorkspaceInput) SetWorkspaceDescription 

func (s *CreateWorkspaceInput) SetWorkspaceDescription(v string) *CreateWorkspaceInput

SetWorkspaceDescription sets the WorkspaceDescription field's value.

func (*CreateWorkspaceInput) SetWorkspaceName 

func (s *CreateWorkspaceInput) SetWorkspaceName(v string) *CreateWorkspaceInput

SetWorkspaceName sets the WorkspaceName field's value.

func (*CreateWorkspaceInput) SetWorkspaceNotificationDestinations 

func (s *CreateWorkspaceInput) SetWorkspaceNotificationDestinations(v []*string) *CreateWorkspaceInput

SetWorkspaceNotificationDestinations sets the WorkspaceNotificationDestinations field's value.

func (*CreateWorkspaceInput) SetWorkspaceOrganizationalUnits 

func (s *CreateWorkspaceInput) SetWorkspaceOrganizationalUnits(v []*string) *CreateWorkspaceInput

SetWorkspaceOrganizationalUnits sets the WorkspaceOrganizationalUnits field's value.

func (*CreateWorkspaceInput) SetWorkspaceRoleArn 

func (s *CreateWorkspaceInput) SetWorkspaceRoleArn(v string) *CreateWorkspaceInput

SetWorkspaceRoleArn sets the WorkspaceRoleArn field's value.

func (CreateWorkspaceInput) String 

func (s CreateWorkspaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceInput) Validate 

func (s *CreateWorkspaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateWorkspaceOutput 

type CreateWorkspaceOutput struct {

	// A structure containing data about the workspace that was created.
	//
	// Workspace is a required field
	Workspace *WorkspaceDescription `locationName:"workspace" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateWorkspaceOutput) GoString 

func (s CreateWorkspaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkspaceOutput) SetWorkspace 

func (s *CreateWorkspaceOutput) SetWorkspace(v *WorkspaceDescription) *CreateWorkspaceOutput

SetWorkspace sets the Workspace field's value.

func (CreateWorkspaceOutput) String 

func (s CreateWorkspaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWorkspaceApiKeyInput added in v1.44.14 

type DeleteWorkspaceApiKeyInput struct {

	// The name of the API key to delete.
	//
	// KeyName is a required field
	KeyName *string `location:"uri" locationName:"keyName" min:"1" type:"string" required:"true"`

	// The ID of the workspace to delete.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteWorkspaceApiKeyInput) GoString added in v1.44.14 

func (s DeleteWorkspaceApiKeyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkspaceApiKeyInput) SetKeyName added in v1.44.14 

func (s *DeleteWorkspaceApiKeyInput) SetKeyName(v string) *DeleteWorkspaceApiKeyInput

SetKeyName sets the KeyName field's value.

func (*DeleteWorkspaceApiKeyInput) SetWorkspaceId added in v1.44.14 

func (s *DeleteWorkspaceApiKeyInput) SetWorkspaceId(v string) *DeleteWorkspaceApiKeyInput

SetWorkspaceId sets the WorkspaceId field's value.

func (DeleteWorkspaceApiKeyInput) String added in v1.44.14 

func (s DeleteWorkspaceApiKeyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkspaceApiKeyInput) Validate added in v1.44.14 

func (s *DeleteWorkspaceApiKeyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteWorkspaceApiKeyOutput added in v1.44.14 

type DeleteWorkspaceApiKeyOutput struct {

	// The name of the API key that was deleted.
	//
	// KeyName is a required field
	KeyName *string `locationName:"keyName" min:"1" type:"string" required:"true"`

	// The ID of the workspace where the key was deleted.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `locationName:"workspaceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteWorkspaceApiKeyOutput) GoString added in v1.44.14 

func (s DeleteWorkspaceApiKeyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkspaceApiKeyOutput) SetKeyName added in v1.44.14 

func (s *DeleteWorkspaceApiKeyOutput) SetKeyName(v string) *DeleteWorkspaceApiKeyOutput

SetKeyName sets the KeyName field's value.

func (*DeleteWorkspaceApiKeyOutput) SetWorkspaceId added in v1.44.14 

func (s *DeleteWorkspaceApiKeyOutput) SetWorkspaceId(v string) *DeleteWorkspaceApiKeyOutput

SetWorkspaceId sets the WorkspaceId field's value.

func (DeleteWorkspaceApiKeyOutput) String added in v1.44.14 

func (s DeleteWorkspaceApiKeyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWorkspaceInput 

type DeleteWorkspaceInput struct {

	// The ID of the workspace to delete.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteWorkspaceInput) GoString 

func (s DeleteWorkspaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkspaceInput) SetWorkspaceId 

func (s *DeleteWorkspaceInput) SetWorkspaceId(v string) *DeleteWorkspaceInput

SetWorkspaceId sets the WorkspaceId field's value.

func (DeleteWorkspaceInput) String 

func (s DeleteWorkspaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkspaceInput) Validate 

func (s *DeleteWorkspaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteWorkspaceOutput 

type DeleteWorkspaceOutput struct {

	// A structure containing information about the workspace that was deleted.
	//
	// Workspace is a required field
	Workspace *WorkspaceDescription `locationName:"workspace" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteWorkspaceOutput) GoString 

func (s DeleteWorkspaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkspaceOutput) SetWorkspace 

func (s *DeleteWorkspaceOutput) SetWorkspace(v *WorkspaceDescription) *DeleteWorkspaceOutput

SetWorkspace sets the Workspace field's value.

func (DeleteWorkspaceOutput) String 

func (s DeleteWorkspaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWorkspaceAuthenticationInput 

type DescribeWorkspaceAuthenticationInput struct {

	// The ID of the workspace to return authentication information about.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeWorkspaceAuthenticationInput) GoString 

func (s DescribeWorkspaceAuthenticationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceAuthenticationInput) SetWorkspaceId 

func (s *DescribeWorkspaceAuthenticationInput) SetWorkspaceId(v string) *DescribeWorkspaceAuthenticationInput

SetWorkspaceId sets the WorkspaceId field's value.

func (DescribeWorkspaceAuthenticationInput) String 

func (s DescribeWorkspaceAuthenticationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceAuthenticationInput) Validate 

func (s *DescribeWorkspaceAuthenticationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeWorkspaceAuthenticationOutput 

type DescribeWorkspaceAuthenticationOutput struct {

	// A structure containing information about the authentication methods used
	// in the workspace.
	//
	// Authentication is a required field
	Authentication *AuthenticationDescription `locationName:"authentication" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeWorkspaceAuthenticationOutput) GoString 

func (s DescribeWorkspaceAuthenticationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceAuthenticationOutput) SetAuthentication 

func (s *DescribeWorkspaceAuthenticationOutput) SetAuthentication(v *AuthenticationDescription) *DescribeWorkspaceAuthenticationOutput

SetAuthentication sets the Authentication field's value.

func (DescribeWorkspaceAuthenticationOutput) String 

func (s DescribeWorkspaceAuthenticationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeWorkspaceInput 

type DescribeWorkspaceInput struct {

	// The ID of the workspace to display information about.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeWorkspaceInput) GoString 

func (s DescribeWorkspaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceInput) SetWorkspaceId 

func (s *DescribeWorkspaceInput) SetWorkspaceId(v string) *DescribeWorkspaceInput

SetWorkspaceId sets the WorkspaceId field's value.

func (DescribeWorkspaceInput) String 

func (s DescribeWorkspaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceInput) Validate 

func (s *DescribeWorkspaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeWorkspaceOutput 

type DescribeWorkspaceOutput struct {

	// A structure containing information about the workspace.
	//
	// Workspace is a required field
	Workspace *WorkspaceDescription `locationName:"workspace" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeWorkspaceOutput) GoString 

func (s DescribeWorkspaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeWorkspaceOutput) SetWorkspace 

func (s *DescribeWorkspaceOutput) SetWorkspace(v *WorkspaceDescription) *DescribeWorkspaceOutput

SetWorkspace sets the Workspace field's value.

func (DescribeWorkspaceOutput) String 

func (s DescribeWorkspaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateLicenseInput 

type DisassociateLicenseInput struct {

	// The type of license to remove from the workspace.
	//
	// LicenseType is a required field
	LicenseType *string `location:"uri" locationName:"licenseType" type:"string" required:"true" enum:"LicenseType"`

	// The ID of the workspace to remove the Grafana Enterprise license from.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateLicenseInput) GoString 

func (s DisassociateLicenseInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateLicenseInput) SetLicenseType 

func (s *DisassociateLicenseInput) SetLicenseType(v string) *DisassociateLicenseInput

SetLicenseType sets the LicenseType field's value.

func (*DisassociateLicenseInput) SetWorkspaceId 

func (s *DisassociateLicenseInput) SetWorkspaceId(v string) *DisassociateLicenseInput

SetWorkspaceId sets the WorkspaceId field's value.

func (DisassociateLicenseInput) String 

func (s DisassociateLicenseInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateLicenseInput) Validate 

func (s *DisassociateLicenseInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateLicenseOutput 

type DisassociateLicenseOutput struct {

	// A structure containing information about the workspace.
	//
	// Workspace is a required field
	Workspace *WorkspaceDescription `locationName:"workspace" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateLicenseOutput) GoString 

func (s DisassociateLicenseOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateLicenseOutput) SetWorkspace 

func (s *DisassociateLicenseOutput) SetWorkspace(v *WorkspaceDescription) *DisassociateLicenseOutput

SetWorkspace sets the Workspace field's value.

func (DisassociateLicenseOutput) String 

func (s DisassociateLicenseOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IdpMetadata 

type IdpMetadata struct {

	// The URL of the location containing the metadata.
	Url *string `locationName:"url" min:"1" type:"string"`

	// The actual full metadata file, in XML format.
	Xml *string `locationName:"xml" type:"string"`
	// contains filtered or unexported fields
}

A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace. You can specify the metadata either by providing a URL to its location in the url parameter, or by specifying the full metadata in XML format in the xml parameter.

func (IdpMetadata) GoString 

func (s IdpMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdpMetadata) SetUrl 

func (s *IdpMetadata) SetUrl(v string) *IdpMetadata

SetUrl sets the Url field's value.

func (*IdpMetadata) SetXml 

func (s *IdpMetadata) SetXml(v string) *IdpMetadata

SetXml sets the Xml field's value.

func (IdpMetadata) String 

func (s IdpMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IdpMetadata) Validate 

func (s *IdpMetadata) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InternalServerException 

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// How long to wait before you retry this operation.
	RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"`
	// contains filtered or unexported fields
}

Unexpected error while processing the request. Retry the request.

func (*InternalServerException) Code 

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error 

func (s *InternalServerException) Error() string

func (InternalServerException) GoString 

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message 

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr 

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID 

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode 

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String 

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListPermissionsInput 

type ListPermissionsInput struct {

	// (Optional) Limits the results to only the group that matches this ID.
	GroupId *string `location:"querystring" locationName:"groupId" min:"1" type:"string"`

	// The maximum number of results to include in the response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token to use when requesting the next set of results. You received this
	// token from a previous ListPermissions operation.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// (Optional) Limits the results to only the user that matches this ID.
	UserId *string `location:"querystring" locationName:"userId" min:"1" type:"string"`

	// (Optional) If you specify SSO_USER, then only the permissions of Amazon Web
	// Services SSO users are returned. If you specify SSO_GROUP, only the permissions
	// of Amazon Web Services SSO groups are returned.
	UserType *string `location:"querystring" locationName:"userType" type:"string" enum:"UserType"`

	// The ID of the workspace to list permissions for. This parameter is required.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListPermissionsInput) GoString 

func (s ListPermissionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPermissionsInput) SetGroupId 

func (s *ListPermissionsInput) SetGroupId(v string) *ListPermissionsInput

SetGroupId sets the GroupId field's value.

func (*ListPermissionsInput) SetMaxResults 

func (s *ListPermissionsInput) SetMaxResults(v int64) *ListPermissionsInput

SetMaxResults sets the MaxResults field's value.

func (*ListPermissionsInput) SetNextToken 

func (s *ListPermissionsInput) SetNextToken(v string) *ListPermissionsInput

SetNextToken sets the NextToken field's value.

func (*ListPermissionsInput) SetUserId 

func (s *ListPermissionsInput) SetUserId(v string) *ListPermissionsInput

SetUserId sets the UserId field's value.

func (*ListPermissionsInput) SetUserType 

func (s *ListPermissionsInput) SetUserType(v string) *ListPermissionsInput

SetUserType sets the UserType field's value.

func (*ListPermissionsInput) SetWorkspaceId 

func (s *ListPermissionsInput) SetWorkspaceId(v string) *ListPermissionsInput

SetWorkspaceId sets the WorkspaceId field's value.

func (ListPermissionsInput) String 

func (s ListPermissionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPermissionsInput) Validate 

func (s *ListPermissionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPermissionsOutput 

type ListPermissionsOutput struct {

	// The token to use in a subsequent ListPermissions operation to return the
	// next set of results.
	NextToken *string `locationName:"nextToken" type:"string"`

	// The permissions returned by the operation.
	//
	// Permissions is a required field
	Permissions []*PermissionEntry `locationName:"permissions" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListPermissionsOutput) GoString 

func (s ListPermissionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListPermissionsOutput) SetNextToken 

func (s *ListPermissionsOutput) SetNextToken(v string) *ListPermissionsOutput

SetNextToken sets the NextToken field's value.

func (*ListPermissionsOutput) SetPermissions 

func (s *ListPermissionsOutput) SetPermissions(v []*PermissionEntry) *ListPermissionsOutput

SetPermissions sets the Permissions field's value.

func (ListPermissionsOutput) String 

func (s ListPermissionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.43.30 

type ListTagsForResourceInput struct {

	// The ARN of the resource the list of tags are associated with.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.43.30 

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetResourceArn added in v1.43.30 

func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String added in v1.43.30 

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.43.30 

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.43.30 

type ListTagsForResourceOutput struct {

	// The list of tags that are associated with the resource.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.43.30 

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.43.30 

func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForResourceOutput

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.43.30 

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListWorkspacesInput 

type ListWorkspacesInput struct {

	// The maximum number of workspaces to include in the results.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The token for the next set of workspaces to return. (You receive this token
	// from a previous ListWorkspaces operation.)
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListWorkspacesInput) GoString 

func (s ListWorkspacesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkspacesInput) SetMaxResults 

func (s *ListWorkspacesInput) SetMaxResults(v int64) *ListWorkspacesInput

SetMaxResults sets the MaxResults field's value.

func (*ListWorkspacesInput) SetNextToken 

func (s *ListWorkspacesInput) SetNextToken(v string) *ListWorkspacesInput

SetNextToken sets the NextToken field's value.

func (ListWorkspacesInput) String 

func (s ListWorkspacesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkspacesInput) Validate 

func (s *ListWorkspacesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListWorkspacesOutput 

type ListWorkspacesOutput struct {

	// The token to use when requesting the next set of workspaces.
	NextToken *string `locationName:"nextToken" type:"string"`

	// An array of structures that contain some information about the workspaces
	// in the account.
	//
	// Workspaces is a required field
	Workspaces []*WorkspaceSummary `locationName:"workspaces" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListWorkspacesOutput) GoString 

func (s ListWorkspacesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkspacesOutput) SetNextToken 

func (s *ListWorkspacesOutput) SetNextToken(v string) *ListWorkspacesOutput

SetNextToken sets the NextToken field's value.

func (*ListWorkspacesOutput) SetWorkspaces 

func (s *ListWorkspacesOutput) SetWorkspaces(v []*WorkspaceSummary) *ListWorkspacesOutput

SetWorkspaces sets the Workspaces field's value.

func (ListWorkspacesOutput) String 

func (s ListWorkspacesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ManagedGrafana 

type ManagedGrafana struct {
	*client.Client
}

ManagedGrafana provides the API operation methods for making requests to Amazon Managed Grafana. See this package's package overview docs for details on the service.

ManagedGrafana methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *ManagedGrafana

New creates a new instance of the ManagedGrafana client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

mySession := session.Must(session.NewSession())

// Create a ManagedGrafana client from just a session.
svc := managedgrafana.New(mySession)

// Create a ManagedGrafana client with additional configuration
svc := managedgrafana.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ManagedGrafana) AssociateLicense 

func (c *ManagedGrafana) AssociateLicense(input *AssociateLicenseInput) (*AssociateLicenseOutput, error)

AssociateLicense API operation for Amazon Managed Grafana.

Assigns a Grafana Enterprise license to a workspace. Upgrading to Grafana Enterprise incurs additional fees. For more information, see Upgrade a workspace to Grafana Enterprise (https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation AssociateLicense for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The request references a resource that does not exist.

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • ValidationException The value of a parameter in the request caused an error.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/AssociateLicense

func (*ManagedGrafana) AssociateLicenseRequest 

func (c *ManagedGrafana) AssociateLicenseRequest(input *AssociateLicenseInput) (req *request.Request, output *AssociateLicenseOutput)

AssociateLicenseRequest generates a "aws/request.Request" representing the client's request for the AssociateLicense operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateLicense for more information on using the AssociateLicense API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the AssociateLicenseRequest method.
req, resp := client.AssociateLicenseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/AssociateLicense

func (*ManagedGrafana) AssociateLicenseWithContext 

func (c *ManagedGrafana) AssociateLicenseWithContext(ctx aws.Context, input *AssociateLicenseInput, opts ...request.Option) (*AssociateLicenseOutput, error)

AssociateLicenseWithContext is the same as AssociateLicense with the addition of the ability to pass a context and additional request options.

See AssociateLicense for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) CreateWorkspace 

func (c *ManagedGrafana) CreateWorkspace(input *CreateWorkspaceInput) (*CreateWorkspaceOutput, error)

CreateWorkspace API operation for Amazon Managed Grafana.

Creates a workspace. In a workspace, you can create Grafana dashboards and visualizations to analyze your metrics, logs, and traces. You don't have to build, package, or deploy any hardware to run the Grafana server.

Don't use CreateWorkspace to modify an existing workspace. Instead, use UpdateWorkspace (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspace.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation CreateWorkspace for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • ConflictException A resource was in an inconsistent state during an update or a deletion.

  • ValidationException The value of a parameter in the request caused an error.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/CreateWorkspace

func (*ManagedGrafana) CreateWorkspaceApiKey added in v1.44.14 

func (c *ManagedGrafana) CreateWorkspaceApiKey(input *CreateWorkspaceApiKeyInput) (*CreateWorkspaceApiKeyOutput, error)

CreateWorkspaceApiKey API operation for Amazon Managed Grafana.

Creates an API key for the workspace. This key can be used to authenticate requests sent to the workspace's HTTP API. See https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html (https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html) for available APIs and example requests.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation CreateWorkspaceApiKey for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The request references a resource that does not exist.

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • ConflictException A resource was in an inconsistent state during an update or a deletion.

  • ValidationException The value of a parameter in the request caused an error.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

  • ServiceQuotaExceededException The request would cause a service quota to be exceeded.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/CreateWorkspaceApiKey

func (*ManagedGrafana) CreateWorkspaceApiKeyRequest added in v1.44.14 

func (c *ManagedGrafana) CreateWorkspaceApiKeyRequest(input *CreateWorkspaceApiKeyInput) (req *request.Request, output *CreateWorkspaceApiKeyOutput)

CreateWorkspaceApiKeyRequest generates a "aws/request.Request" representing the client's request for the CreateWorkspaceApiKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWorkspaceApiKey for more information on using the CreateWorkspaceApiKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateWorkspaceApiKeyRequest method.
req, resp := client.CreateWorkspaceApiKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/CreateWorkspaceApiKey

func (*ManagedGrafana) CreateWorkspaceApiKeyWithContext added in v1.44.14 

func (c *ManagedGrafana) CreateWorkspaceApiKeyWithContext(ctx aws.Context, input *CreateWorkspaceApiKeyInput, opts ...request.Option) (*CreateWorkspaceApiKeyOutput, error)

CreateWorkspaceApiKeyWithContext is the same as CreateWorkspaceApiKey with the addition of the ability to pass a context and additional request options.

See CreateWorkspaceApiKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) CreateWorkspaceRequest 

func (c *ManagedGrafana) CreateWorkspaceRequest(input *CreateWorkspaceInput) (req *request.Request, output *CreateWorkspaceOutput)

CreateWorkspaceRequest generates a "aws/request.Request" representing the client's request for the CreateWorkspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWorkspace for more information on using the CreateWorkspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateWorkspaceRequest method.
req, resp := client.CreateWorkspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/CreateWorkspace

func (*ManagedGrafana) CreateWorkspaceWithContext 

func (c *ManagedGrafana) CreateWorkspaceWithContext(ctx aws.Context, input *CreateWorkspaceInput, opts ...request.Option) (*CreateWorkspaceOutput, error)

CreateWorkspaceWithContext is the same as CreateWorkspace with the addition of the ability to pass a context and additional request options.

See CreateWorkspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) DeleteWorkspace 

func (c *ManagedGrafana) DeleteWorkspace(input *DeleteWorkspaceInput) (*DeleteWorkspaceOutput, error)

DeleteWorkspace API operation for Amazon Managed Grafana.

Deletes an Amazon Managed Grafana workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation DeleteWorkspace for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The request references a resource that does not exist.

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • ConflictException A resource was in an inconsistent state during an update or a deletion.

  • ValidationException The value of a parameter in the request caused an error.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DeleteWorkspace

func (*ManagedGrafana) DeleteWorkspaceApiKey added in v1.44.14 

func (c *ManagedGrafana) DeleteWorkspaceApiKey(input *DeleteWorkspaceApiKeyInput) (*DeleteWorkspaceApiKeyOutput, error)

DeleteWorkspaceApiKey API operation for Amazon Managed Grafana.

Deletes an API key for a workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation DeleteWorkspaceApiKey for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The request references a resource that does not exist.

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • ConflictException A resource was in an inconsistent state during an update or a deletion.

  • ValidationException The value of a parameter in the request caused an error.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DeleteWorkspaceApiKey

func (*ManagedGrafana) DeleteWorkspaceApiKeyRequest added in v1.44.14 

func (c *ManagedGrafana) DeleteWorkspaceApiKeyRequest(input *DeleteWorkspaceApiKeyInput) (req *request.Request, output *DeleteWorkspaceApiKeyOutput)

DeleteWorkspaceApiKeyRequest generates a "aws/request.Request" representing the client's request for the DeleteWorkspaceApiKey operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWorkspaceApiKey for more information on using the DeleteWorkspaceApiKey API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteWorkspaceApiKeyRequest method.
req, resp := client.DeleteWorkspaceApiKeyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DeleteWorkspaceApiKey

func (*ManagedGrafana) DeleteWorkspaceApiKeyWithContext added in v1.44.14 

func (c *ManagedGrafana) DeleteWorkspaceApiKeyWithContext(ctx aws.Context, input *DeleteWorkspaceApiKeyInput, opts ...request.Option) (*DeleteWorkspaceApiKeyOutput, error)

DeleteWorkspaceApiKeyWithContext is the same as DeleteWorkspaceApiKey with the addition of the ability to pass a context and additional request options.

See DeleteWorkspaceApiKey for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) DeleteWorkspaceRequest 

func (c *ManagedGrafana) DeleteWorkspaceRequest(input *DeleteWorkspaceInput) (req *request.Request, output *DeleteWorkspaceOutput)

DeleteWorkspaceRequest generates a "aws/request.Request" representing the client's request for the DeleteWorkspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWorkspace for more information on using the DeleteWorkspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteWorkspaceRequest method.
req, resp := client.DeleteWorkspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DeleteWorkspace

func (*ManagedGrafana) DeleteWorkspaceWithContext 

func (c *ManagedGrafana) DeleteWorkspaceWithContext(ctx aws.Context, input *DeleteWorkspaceInput, opts ...request.Option) (*DeleteWorkspaceOutput, error)

DeleteWorkspaceWithContext is the same as DeleteWorkspace with the addition of the ability to pass a context and additional request options.

See DeleteWorkspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) DescribeWorkspace 

func (c *ManagedGrafana) DescribeWorkspace(input *DescribeWorkspaceInput) (*DescribeWorkspaceOutput, error)

DescribeWorkspace API operation for Amazon Managed Grafana.

Displays information about one Amazon Managed Grafana workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation DescribeWorkspace for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The request references a resource that does not exist.

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • ValidationException The value of a parameter in the request caused an error.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DescribeWorkspace

func (*ManagedGrafana) DescribeWorkspaceAuthentication 

func (c *ManagedGrafana) DescribeWorkspaceAuthentication(input *DescribeWorkspaceAuthenticationInput) (*DescribeWorkspaceAuthenticationOutput, error)

DescribeWorkspaceAuthentication API operation for Amazon Managed Grafana.

Displays information about the authentication methods used in one Amazon Managed Grafana workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation DescribeWorkspaceAuthentication for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The request references a resource that does not exist.

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • ValidationException The value of a parameter in the request caused an error.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DescribeWorkspaceAuthentication

func (*ManagedGrafana) DescribeWorkspaceAuthenticationRequest 

func (c *ManagedGrafana) DescribeWorkspaceAuthenticationRequest(input *DescribeWorkspaceAuthenticationInput) (req *request.Request, output *DescribeWorkspaceAuthenticationOutput)

DescribeWorkspaceAuthenticationRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspaceAuthentication operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWorkspaceAuthentication for more information on using the DescribeWorkspaceAuthentication API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeWorkspaceAuthenticationRequest method.
req, resp := client.DescribeWorkspaceAuthenticationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DescribeWorkspaceAuthentication

func (*ManagedGrafana) DescribeWorkspaceAuthenticationWithContext 

func (c *ManagedGrafana) DescribeWorkspaceAuthenticationWithContext(ctx aws.Context, input *DescribeWorkspaceAuthenticationInput, opts ...request.Option) (*DescribeWorkspaceAuthenticationOutput, error)

DescribeWorkspaceAuthenticationWithContext is the same as DescribeWorkspaceAuthentication with the addition of the ability to pass a context and additional request options.

See DescribeWorkspaceAuthentication for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) DescribeWorkspaceRequest 

func (c *ManagedGrafana) DescribeWorkspaceRequest(input *DescribeWorkspaceInput) (req *request.Request, output *DescribeWorkspaceOutput)

DescribeWorkspaceRequest generates a "aws/request.Request" representing the client's request for the DescribeWorkspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeWorkspace for more information on using the DescribeWorkspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeWorkspaceRequest method.
req, resp := client.DescribeWorkspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DescribeWorkspace

func (*ManagedGrafana) DescribeWorkspaceWithContext 

func (c *ManagedGrafana) DescribeWorkspaceWithContext(ctx aws.Context, input *DescribeWorkspaceInput, opts ...request.Option) (*DescribeWorkspaceOutput, error)

DescribeWorkspaceWithContext is the same as DescribeWorkspace with the addition of the ability to pass a context and additional request options.

See DescribeWorkspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) DisassociateLicense 

func (c *ManagedGrafana) DisassociateLicense(input *DisassociateLicenseInput) (*DisassociateLicenseOutput, error)

DisassociateLicense API operation for Amazon Managed Grafana.

Removes the Grafana Enterprise license from a workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation DisassociateLicense for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The request references a resource that does not exist.

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • ValidationException The value of a parameter in the request caused an error.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DisassociateLicense

func (*ManagedGrafana) DisassociateLicenseRequest 

func (c *ManagedGrafana) DisassociateLicenseRequest(input *DisassociateLicenseInput) (req *request.Request, output *DisassociateLicenseOutput)

DisassociateLicenseRequest generates a "aws/request.Request" representing the client's request for the DisassociateLicense operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateLicense for more information on using the DisassociateLicense API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DisassociateLicenseRequest method.
req, resp := client.DisassociateLicenseRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DisassociateLicense

func (*ManagedGrafana) DisassociateLicenseWithContext 

func (c *ManagedGrafana) DisassociateLicenseWithContext(ctx aws.Context, input *DisassociateLicenseInput, opts ...request.Option) (*DisassociateLicenseOutput, error)

DisassociateLicenseWithContext is the same as DisassociateLicense with the addition of the ability to pass a context and additional request options.

See DisassociateLicense for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) ListPermissions 

func (c *ManagedGrafana) ListPermissions(input *ListPermissionsInput) (*ListPermissionsOutput, error)

ListPermissions API operation for Amazon Managed Grafana.

Lists the users and groups who have the Grafana Admin and Editor roles in this workspace. If you use this operation without specifying userId or groupId, the operation returns the roles of all users and groups. If you specify a userId or a groupId, only the roles for that user or group are returned. If you do this, you can specify only one userId or one groupId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation ListPermissions for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The request references a resource that does not exist.

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • ValidationException The value of a parameter in the request caused an error.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/ListPermissions

func (*ManagedGrafana) ListPermissionsPages 

func (c *ManagedGrafana) ListPermissionsPages(input *ListPermissionsInput, fn func(*ListPermissionsOutput, bool) bool) error

ListPermissionsPages iterates over the pages of a ListPermissions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPermissions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListPermissions operation.
pageNum := 0
err := client.ListPermissionsPages(params,
    func(page *managedgrafana.ListPermissionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ManagedGrafana) ListPermissionsPagesWithContext 

func (c *ManagedGrafana) ListPermissionsPagesWithContext(ctx aws.Context, input *ListPermissionsInput, fn func(*ListPermissionsOutput, bool) bool, opts ...request.Option) error

ListPermissionsPagesWithContext same as ListPermissionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) ListPermissionsRequest 

func (c *ManagedGrafana) ListPermissionsRequest(input *ListPermissionsInput) (req *request.Request, output *ListPermissionsOutput)

ListPermissionsRequest generates a "aws/request.Request" representing the client's request for the ListPermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPermissions for more information on using the ListPermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListPermissionsRequest method.
req, resp := client.ListPermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/ListPermissions

func (*ManagedGrafana) ListPermissionsWithContext 

func (c *ManagedGrafana) ListPermissionsWithContext(ctx aws.Context, input *ListPermissionsInput, opts ...request.Option) (*ListPermissionsOutput, error)

ListPermissionsWithContext is the same as ListPermissions with the addition of the ability to pass a context and additional request options.

See ListPermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) ListTagsForResource added in v1.43.30 

func (c *ManagedGrafana) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon Managed Grafana.

The ListTagsForResource operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the resourceArn. Currently, the only resource that can be tagged is a workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The request references a resource that does not exist.

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • ValidationException The value of a parameter in the request caused an error.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/ListTagsForResource

func (*ManagedGrafana) ListTagsForResourceRequest added in v1.43.30 

func (c *ManagedGrafana) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/ListTagsForResource

func (*ManagedGrafana) ListTagsForResourceWithContext added in v1.43.30 

func (c *ManagedGrafana) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) ListWorkspaces 

func (c *ManagedGrafana) ListWorkspaces(input *ListWorkspacesInput) (*ListWorkspacesOutput, error)

ListWorkspaces API operation for Amazon Managed Grafana.

Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use DescribeWorkspace (https://docs.aws.amazon.com/AAMG/latest/APIReference/API_DescribeWorkspace.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation ListWorkspaces for usage and error information.

Returned Error Types:

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/ListWorkspaces

func (*ManagedGrafana) ListWorkspacesPages 

func (c *ManagedGrafana) ListWorkspacesPages(input *ListWorkspacesInput, fn func(*ListWorkspacesOutput, bool) bool) error

ListWorkspacesPages iterates over the pages of a ListWorkspaces operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListWorkspaces method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service. 

// Example iterating over at most 3 pages of a ListWorkspaces operation.
pageNum := 0
err := client.ListWorkspacesPages(params,
    func(page *managedgrafana.ListWorkspacesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*ManagedGrafana) ListWorkspacesPagesWithContext 

func (c *ManagedGrafana) ListWorkspacesPagesWithContext(ctx aws.Context, input *ListWorkspacesInput, fn func(*ListWorkspacesOutput, bool) bool, opts ...request.Option) error

ListWorkspacesPagesWithContext same as ListWorkspacesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) ListWorkspacesRequest 

func (c *ManagedGrafana) ListWorkspacesRequest(input *ListWorkspacesInput) (req *request.Request, output *ListWorkspacesOutput)

ListWorkspacesRequest generates a "aws/request.Request" representing the client's request for the ListWorkspaces operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWorkspaces for more information on using the ListWorkspaces API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListWorkspacesRequest method.
req, resp := client.ListWorkspacesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/ListWorkspaces

func (*ManagedGrafana) ListWorkspacesWithContext 

func (c *ManagedGrafana) ListWorkspacesWithContext(ctx aws.Context, input *ListWorkspacesInput, opts ...request.Option) (*ListWorkspacesOutput, error)

ListWorkspacesWithContext is the same as ListWorkspaces with the addition of the ability to pass a context and additional request options.

See ListWorkspaces for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) TagResource added in v1.43.30 

func (c *ManagedGrafana) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon Managed Grafana.

The TagResource operation associates tags with an Amazon Managed Grafana resource. Currently, the only resource that can be tagged is workspaces.

If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation TagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The request references a resource that does not exist.

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • ValidationException The value of a parameter in the request caused an error.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/TagResource

func (*ManagedGrafana) TagResourceRequest added in v1.43.30 

func (c *ManagedGrafana) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/TagResource

func (*ManagedGrafana) TagResourceWithContext added in v1.43.30 

func (c *ManagedGrafana) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) UntagResource added in v1.43.30 

func (c *ManagedGrafana) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon Managed Grafana.

The UntagResource operation removes the association of the tag with the Amazon Managed Grafana resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation UntagResource for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The request references a resource that does not exist.

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • ValidationException The value of a parameter in the request caused an error.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UntagResource

func (*ManagedGrafana) UntagResourceRequest added in v1.43.30 

func (c *ManagedGrafana) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UntagResource

func (*ManagedGrafana) UntagResourceWithContext added in v1.43.30 

func (c *ManagedGrafana) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) UpdatePermissions 

func (c *ManagedGrafana) UpdatePermissions(input *UpdatePermissionsInput) (*UpdatePermissionsOutput, error)

UpdatePermissions API operation for Amazon Managed Grafana.

Updates which users in a workspace have the Grafana Admin or Editor roles.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation UpdatePermissions for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The request references a resource that does not exist.

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • ValidationException The value of a parameter in the request caused an error.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UpdatePermissions

func (*ManagedGrafana) UpdatePermissionsRequest 

func (c *ManagedGrafana) UpdatePermissionsRequest(input *UpdatePermissionsInput) (req *request.Request, output *UpdatePermissionsOutput)

UpdatePermissionsRequest generates a "aws/request.Request" representing the client's request for the UpdatePermissions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdatePermissions for more information on using the UpdatePermissions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdatePermissionsRequest method.
req, resp := client.UpdatePermissionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UpdatePermissions

func (*ManagedGrafana) UpdatePermissionsWithContext 

func (c *ManagedGrafana) UpdatePermissionsWithContext(ctx aws.Context, input *UpdatePermissionsInput, opts ...request.Option) (*UpdatePermissionsOutput, error)

UpdatePermissionsWithContext is the same as UpdatePermissions with the addition of the ability to pass a context and additional request options.

See UpdatePermissions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) UpdateWorkspace 

func (c *ManagedGrafana) UpdateWorkspace(input *UpdateWorkspaceInput) (*UpdateWorkspaceOutput, error)

UpdateWorkspace API operation for Amazon Managed Grafana.

Modifies an existing Amazon Managed Grafana workspace. If you use this operation and omit any optional parameters, the existing values of those parameters are not changed.

To modify the user authentication methods that the workspace uses, such as SAML or Amazon Web Services SSO, use UpdateWorkspaceAuthentication (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdateWorkspaceAuthentication.html).

To modify which users in the workspace have the Admin and Editor Grafana roles, use UpdatePermissions (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation UpdateWorkspace for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The request references a resource that does not exist.

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • ConflictException A resource was in an inconsistent state during an update or a deletion.

  • ValidationException The value of a parameter in the request caused an error.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UpdateWorkspace

func (*ManagedGrafana) UpdateWorkspaceAuthentication 

func (c *ManagedGrafana) UpdateWorkspaceAuthentication(input *UpdateWorkspaceAuthenticationInput) (*UpdateWorkspaceAuthenticationOutput, error)

UpdateWorkspaceAuthentication API operation for Amazon Managed Grafana.

Use this operation to define the identity provider (IdP) that this workspace authenticates users from, using SAML. You can also map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the Admin and Editor roles in the workspace.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon Managed Grafana's API operation UpdateWorkspaceAuthentication for usage and error information.

Returned Error Types:

  • ResourceNotFoundException The request references a resource that does not exist.

  • ThrottlingException The request was denied because of request throttling. Retry the request.

  • ConflictException A resource was in an inconsistent state during an update or a deletion.

  • ValidationException The value of a parameter in the request caused an error.

  • AccessDeniedException You do not have sufficient permissions to perform this action.

  • InternalServerException Unexpected error while processing the request. Retry the request.

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UpdateWorkspaceAuthentication

func (*ManagedGrafana) UpdateWorkspaceAuthenticationRequest 

func (c *ManagedGrafana) UpdateWorkspaceAuthenticationRequest(input *UpdateWorkspaceAuthenticationInput) (req *request.Request, output *UpdateWorkspaceAuthenticationOutput)

UpdateWorkspaceAuthenticationRequest generates a "aws/request.Request" representing the client's request for the UpdateWorkspaceAuthentication operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateWorkspaceAuthentication for more information on using the UpdateWorkspaceAuthentication API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateWorkspaceAuthenticationRequest method.
req, resp := client.UpdateWorkspaceAuthenticationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UpdateWorkspaceAuthentication

func (*ManagedGrafana) UpdateWorkspaceAuthenticationWithContext 

func (c *ManagedGrafana) UpdateWorkspaceAuthenticationWithContext(ctx aws.Context, input *UpdateWorkspaceAuthenticationInput, opts ...request.Option) (*UpdateWorkspaceAuthenticationOutput, error)

UpdateWorkspaceAuthenticationWithContext is the same as UpdateWorkspaceAuthentication with the addition of the ability to pass a context and additional request options.

See UpdateWorkspaceAuthentication for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*ManagedGrafana) UpdateWorkspaceRequest 

func (c *ManagedGrafana) UpdateWorkspaceRequest(input *UpdateWorkspaceInput) (req *request.Request, output *UpdateWorkspaceOutput)

UpdateWorkspaceRequest generates a "aws/request.Request" representing the client's request for the UpdateWorkspace operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateWorkspace for more information on using the UpdateWorkspace API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateWorkspaceRequest method.
req, resp := client.UpdateWorkspaceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/UpdateWorkspace

func (*ManagedGrafana) UpdateWorkspaceWithContext 

func (c *ManagedGrafana) UpdateWorkspaceWithContext(ctx aws.Context, input *UpdateWorkspaceInput, opts ...request.Option) (*UpdateWorkspaceOutput, error)

UpdateWorkspaceWithContext is the same as UpdateWorkspace with the addition of the ability to pass a context and additional request options.

See UpdateWorkspace for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type PermissionEntry 

type PermissionEntry struct {

	// Specifies whether the user or group has the Admin or Editor role.
	//
	// Role is a required field
	Role *string `locationName:"role" type:"string" required:"true" enum:"Role"`

	// A structure with the ID of the user or group with this role.
	//
	// User is a required field
	User *User `locationName:"user" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A structure containing the identity of one user or group and the Admin or Editor role that they have.

func (PermissionEntry) GoString 

func (s PermissionEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PermissionEntry) SetRole 

func (s *PermissionEntry) SetRole(v string) *PermissionEntry

SetRole sets the Role field's value.

func (*PermissionEntry) SetUser 

func (s *PermissionEntry) SetUser(v *User) *PermissionEntry

SetUser sets the User field's value.

func (PermissionEntry) String 

func (s PermissionEntry) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The value of a parameter in the request caused an error.
	Message_ *string `locationName:"message" type:"string"`

	// The ID of the resource that is associated with the error.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of the resource that is associated with the error.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request references a resource that does not exist.

func (*ResourceNotFoundException) Code 

func (s *ResourceNotFoundException) Code() string

Code returns the exception type name.

func (*ResourceNotFoundException) Error 

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString 

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message 

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr 

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID 

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode 

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String 

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RoleValues 

type RoleValues struct {

	// A list of groups from the SAML assertion attribute to grant the Grafana Admin
	// role to.
	Admin []*string `locationName:"admin" type:"list"`

	// A list of groups from the SAML assertion attribute to grant the Grafana Editor
	// role to.
	Editor []*string `locationName:"editor" type:"list"`
	// contains filtered or unexported fields
}

This structure defines which groups defined in the SAML assertion attribute are to be mapped to the Grafana Admin and Editor roles in the workspace.

func (RoleValues) GoString 

func (s RoleValues) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RoleValues) SetAdmin 

func (s *RoleValues) SetAdmin(v []*string) *RoleValues

SetAdmin sets the Admin field's value.

func (*RoleValues) SetEditor 

func (s *RoleValues) SetEditor(v []*string) *RoleValues

SetEditor sets the Editor field's value.

func (RoleValues) String 

func (s RoleValues) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SamlAuthentication 

type SamlAuthentication struct {

	// A structure containing details about how this workspace works with SAML.
	Configuration *SamlConfiguration `locationName:"configuration" type:"structure"`

	// Specifies whether the workspace's SAML configuration is complete.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"SamlConfigurationStatus"`
	// contains filtered or unexported fields
}

A structure containing information about how this workspace works with SAML.

func (SamlAuthentication) GoString 

func (s SamlAuthentication) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SamlAuthentication) SetConfiguration 

func (s *SamlAuthentication) SetConfiguration(v *SamlConfiguration) *SamlAuthentication

SetConfiguration sets the Configuration field's value.

func (*SamlAuthentication) SetStatus 

func (s *SamlAuthentication) SetStatus(v string) *SamlAuthentication

SetStatus sets the Status field's value.

func (SamlAuthentication) String 

func (s SamlAuthentication) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type SamlConfiguration 

type SamlConfiguration struct {

	// Lists which organizations defined in the SAML assertion are allowed to use
	// the Amazon Managed Grafana workspace. If this is empty, all organizations
	// in the assertion attribute have access.
	AllowedOrganizations []*string `locationName:"allowedOrganizations" type:"list"`

	// A structure that defines which attributes in the SAML assertion are to be
	// used to define information about the users authenticated by that IdP to use
	// the workspace.
	AssertionAttributes *AssertionAttributes `locationName:"assertionAttributes" type:"structure"`

	// A structure containing the identity provider (IdP) metadata used to integrate
	// the identity provider with this workspace.
	//
	// IdpMetadata is a required field
	IdpMetadata *IdpMetadata `locationName:"idpMetadata" type:"structure" required:"true"`

	// How long a sign-on session by a SAML user is valid, before the user has to
	// sign on again.
	LoginValidityDuration *int64 `locationName:"loginValidityDuration" type:"integer"`

	// A structure containing arrays that map group names in the SAML assertion
	// to the Grafana Admin and Editor roles in the workspace.
	RoleValues *RoleValues `locationName:"roleValues" type:"structure"`
	// contains filtered or unexported fields
}

A structure containing information about how this workspace works with SAML.

func (SamlConfiguration) GoString 

func (s SamlConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SamlConfiguration) SetAllowedOrganizations 

func (s *SamlConfiguration) SetAllowedOrganizations(v []*string) *SamlConfiguration

SetAllowedOrganizations sets the AllowedOrganizations field's value.

func (*SamlConfiguration) SetAssertionAttributes 

func (s *SamlConfiguration) SetAssertionAttributes(v *AssertionAttributes) *SamlConfiguration

SetAssertionAttributes sets the AssertionAttributes field's value.

func (*SamlConfiguration) SetIdpMetadata 

func (s *SamlConfiguration) SetIdpMetadata(v *IdpMetadata) *SamlConfiguration

SetIdpMetadata sets the IdpMetadata field's value.

func (*SamlConfiguration) SetLoginValidityDuration 

func (s *SamlConfiguration) SetLoginValidityDuration(v int64) *SamlConfiguration

SetLoginValidityDuration sets the LoginValidityDuration field's value.

func (*SamlConfiguration) SetRoleValues 

func (s *SamlConfiguration) SetRoleValues(v *RoleValues) *SamlConfiguration

SetRoleValues sets the RoleValues field's value.

func (SamlConfiguration) String 

func (s SamlConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SamlConfiguration) Validate 

func (s *SamlConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// The ID of the service quota that was exceeded.
	//
	// QuotaCode is a required field
	QuotaCode *string `locationName:"quotaCode" type:"string" required:"true"`

	// The ID of the resource that is associated with the error.
	//
	// ResourceId is a required field
	ResourceId *string `locationName:"resourceId" type:"string" required:"true"`

	// The type of the resource that is associated with the error.
	//
	// ResourceType is a required field
	ResourceType *string `locationName:"resourceType" type:"string" required:"true"`

	// The value of a parameter in the request caused an error.
	//
	// ServiceCode is a required field
	ServiceCode *string `locationName:"serviceCode" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request would cause a service quota to be exceeded.

func (*ServiceQuotaExceededException) Code 

func (s *ServiceQuotaExceededException) Code() string

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error 

func (s *ServiceQuotaExceededException) Error() string

func (ServiceQuotaExceededException) GoString 

func (s ServiceQuotaExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message 

func (s *ServiceQuotaExceededException) Message() string

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr 

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID 

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode 

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String 

func (s ServiceQuotaExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput added in v1.43.30 

type TagResourceInput struct {

	// The ARN of the resource the tag is associated with.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// The list of tag keys and values to associate with the resource. You can associate
	// tag keys only, tags (key and values) only or a combination of tag keys and
	// tags.
	//
	// Tags is a required field
	Tags map[string]*string `locationName:"tags" type:"map" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.43.30 

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn added in v1.43.30 

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags added in v1.43.30 

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String added in v1.43.30 

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.43.30 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.43.30 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.43.30 

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.43.30 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException 

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// The ID of the service quota that was exceeded.
	QuotaCode *string `locationName:"quotaCode" type:"string"`

	// The value of a parameter in the request caused an error.
	RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"`

	// The ID of the service that is associated with the error.
	ServiceCode *string `locationName:"serviceCode" type:"string"`
	// contains filtered or unexported fields
}

The request was denied because of request throttling. Retry the request.

func (*ThrottlingException) Code 

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error 

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString 

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message 

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr 

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID 

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode 

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String 

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.43.30 

type UntagResourceInput struct {

	// The ARN of the resource the tag association is removed from.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// The key values of the tag to be removed from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.43.30 

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn added in v1.43.30 

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys added in v1.43.30 

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String added in v1.43.30 

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.43.30 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.43.30 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.43.30 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.43.30 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateError 

type UpdateError struct {

	// Specifies which permission update caused the error.
	//
	// CausedBy is a required field
	CausedBy *UpdateInstruction `locationName:"causedBy" type:"structure" required:"true"`

	// The error code.
	//
	// Code is a required field
	Code *int64 `locationName:"code" min:"100" type:"integer" required:"true"`

	// The message for this error.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A structure containing information about one error encountered while performing an UpdatePermissions (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html) operation.

func (UpdateError) GoString 

func (s UpdateError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateError) SetCausedBy 

func (s *UpdateError) SetCausedBy(v *UpdateInstruction) *UpdateError

SetCausedBy sets the CausedBy field's value.

func (*UpdateError) SetCode 

func (s *UpdateError) SetCode(v int64) *UpdateError

SetCode sets the Code field's value.

func (*UpdateError) SetMessage 

func (s *UpdateError) SetMessage(v string) *UpdateError

SetMessage sets the Message field's value.

func (UpdateError) String 

func (s UpdateError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateInstruction 

type UpdateInstruction struct {

	// Specifies whether this update is to add or revoke role permissions.
	//
	// Action is a required field
	Action *string `locationName:"action" type:"string" required:"true" enum:"UpdateAction"`

	// The role to add or revoke for the user or the group specified in users.
	//
	// Role is a required field
	Role *string `locationName:"role" type:"string" required:"true" enum:"Role"`

	// A structure that specifies the user or group to add or revoke the role for.
	//
	// Users is a required field
	Users []*User `locationName:"users" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Contains the instructions for one Grafana role permission update in a UpdatePermissions (https://docs.aws.amazon.com/grafana/latest/APIReference/API_UpdatePermissions.html) operation.

func (UpdateInstruction) GoString 

func (s UpdateInstruction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateInstruction) SetAction 

func (s *UpdateInstruction) SetAction(v string) *UpdateInstruction

SetAction sets the Action field's value.

func (*UpdateInstruction) SetRole 

func (s *UpdateInstruction) SetRole(v string) *UpdateInstruction

SetRole sets the Role field's value.

func (*UpdateInstruction) SetUsers 

func (s *UpdateInstruction) SetUsers(v []*User) *UpdateInstruction

SetUsers sets the Users field's value.

func (UpdateInstruction) String 

func (s UpdateInstruction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateInstruction) Validate 

func (s *UpdateInstruction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdatePermissionsInput 

type UpdatePermissionsInput struct {

	// An array of structures that contain the permission updates to make.
	//
	// UpdateInstructionBatch is a required field
	UpdateInstructionBatch []*UpdateInstruction `locationName:"updateInstructionBatch" type:"list" required:"true"`

	// The ID of the workspace to update.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdatePermissionsInput) GoString 

func (s UpdatePermissionsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePermissionsInput) SetUpdateInstructionBatch 

func (s *UpdatePermissionsInput) SetUpdateInstructionBatch(v []*UpdateInstruction) *UpdatePermissionsInput

SetUpdateInstructionBatch sets the UpdateInstructionBatch field's value.

func (*UpdatePermissionsInput) SetWorkspaceId 

func (s *UpdatePermissionsInput) SetWorkspaceId(v string) *UpdatePermissionsInput

SetWorkspaceId sets the WorkspaceId field's value.

func (UpdatePermissionsInput) String 

func (s UpdatePermissionsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePermissionsInput) Validate 

func (s *UpdatePermissionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdatePermissionsOutput 

type UpdatePermissionsOutput struct {

	// An array of structures that contain the errors from the operation, if any.
	//
	// Errors is a required field
	Errors []*UpdateError `locationName:"errors" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UpdatePermissionsOutput) GoString 

func (s UpdatePermissionsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdatePermissionsOutput) SetErrors 

func (s *UpdatePermissionsOutput) SetErrors(v []*UpdateError) *UpdatePermissionsOutput

SetErrors sets the Errors field's value.

func (UpdatePermissionsOutput) String 

func (s UpdatePermissionsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateWorkspaceAuthenticationInput 

type UpdateWorkspaceAuthenticationInput struct {

	// Specifies whether this workspace uses SAML 2.0, Amazon Web Services Single
	// Sign On, or both to authenticate users for using the Grafana console within
	// a workspace. For more information, see User authentication in Amazon Managed
	// Grafana (https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html).
	//
	// AuthenticationProviders is a required field
	AuthenticationProviders []*string `locationName:"authenticationProviders" type:"list" required:"true" enum:"AuthenticationProviderTypes"`

	// If the workspace uses SAML, use this structure to map SAML assertion attributes
	// to workspace user information and define which groups in the assertion attribute
	// are to have the Admin and Editor roles in the workspace.
	SamlConfiguration *SamlConfiguration `locationName:"samlConfiguration" type:"structure"`

	// The ID of the workspace to update the authentication for.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateWorkspaceAuthenticationInput) GoString 

func (s UpdateWorkspaceAuthenticationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkspaceAuthenticationInput) SetAuthenticationProviders 

func (s *UpdateWorkspaceAuthenticationInput) SetAuthenticationProviders(v []*string) *UpdateWorkspaceAuthenticationInput

SetAuthenticationProviders sets the AuthenticationProviders field's value.

func (*UpdateWorkspaceAuthenticationInput) SetSamlConfiguration 

func (s *UpdateWorkspaceAuthenticationInput) SetSamlConfiguration(v *SamlConfiguration) *UpdateWorkspaceAuthenticationInput

SetSamlConfiguration sets the SamlConfiguration field's value.

func (*UpdateWorkspaceAuthenticationInput) SetWorkspaceId 

func (s *UpdateWorkspaceAuthenticationInput) SetWorkspaceId(v string) *UpdateWorkspaceAuthenticationInput

SetWorkspaceId sets the WorkspaceId field's value.

func (UpdateWorkspaceAuthenticationInput) String 

func (s UpdateWorkspaceAuthenticationInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkspaceAuthenticationInput) Validate 

func (s *UpdateWorkspaceAuthenticationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateWorkspaceAuthenticationOutput 

type UpdateWorkspaceAuthenticationOutput struct {

	// A structure that describes the user authentication for this workspace after
	// the update is made.
	//
	// Authentication is a required field
	Authentication *AuthenticationDescription `locationName:"authentication" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateWorkspaceAuthenticationOutput) GoString 

func (s UpdateWorkspaceAuthenticationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkspaceAuthenticationOutput) SetAuthentication 

func (s *UpdateWorkspaceAuthenticationOutput) SetAuthentication(v *AuthenticationDescription) *UpdateWorkspaceAuthenticationOutput

SetAuthentication sets the Authentication field's value.

func (UpdateWorkspaceAuthenticationOutput) String 

func (s UpdateWorkspaceAuthenticationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateWorkspaceInput 

type UpdateWorkspaceInput struct {

	// Specifies whether the workspace can access Amazon Web Services resources
	// in this Amazon Web Services account only, or whether it can also access Amazon
	// Web Services resources in other accounts in the same organization. If you
	// specify ORGANIZATION, you must specify which organizational units the workspace
	// can access in the workspaceOrganizationalUnits parameter.
	AccountAccessType *string `locationName:"accountAccessType" type:"string" enum:"AccountAccessType"`

	// The name of an IAM role that already exists to use to access resources through
	// Organizations.
	//
	// OrganizationRoleName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateWorkspaceInput's
	// String and GoString methods.
	OrganizationRoleName *string `locationName:"organizationRoleName" min:"1" type:"string" sensitive:"true"`

	// If you specify Service Managed, Amazon Managed Grafana automatically creates
	// the IAM roles and provisions the permissions that the workspace needs to
	// use Amazon Web Services data sources and notification channels.
	//
	// If you specify CUSTOMER_MANAGED, you will manage those roles and permissions
	// yourself. If you are creating this workspace in a member account of an organization
	// and that account is not a delegated administrator account, and you want the
	// workspace to access data sources in other Amazon Web Services accounts in
	// the organization, you must choose CUSTOMER_MANAGED.
	//
	// For more information, see Amazon Managed Grafana permissions and policies
	// for Amazon Web Services data sources and notification channels (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html)
	PermissionType *string `locationName:"permissionType" type:"string" enum:"PermissionType"`

	// The name of the CloudFormation stack set to use to generate IAM roles to
	// be used for this workspace.
	StackSetName *string `locationName:"stackSetName" type:"string"`

	// Specify the Amazon Web Services data sources that you want to be queried
	// in this workspace. Specifying these data sources here enables Amazon Managed
	// Grafana to create IAM roles and permissions that allow Amazon Managed Grafana
	// to read data from these sources. You must still add them as data sources
	// in the Grafana console in the workspace.
	//
	// If you don't specify a data source here, you can still add it as a data source
	// later in the workspace console. However, you will then have to manually configure
	// permissions for it.
	WorkspaceDataSources []*string `locationName:"workspaceDataSources" type:"list" enum:"DataSourceType"`

	// A description for the workspace. This is used only to help you identify this
	// workspace.
	//
	// WorkspaceDescription is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateWorkspaceInput's
	// String and GoString methods.
	WorkspaceDescription *string `locationName:"workspaceDescription" type:"string" sensitive:"true"`

	// The ID of the workspace to update.
	//
	// WorkspaceId is a required field
	WorkspaceId *string `location:"uri" locationName:"workspaceId" type:"string" required:"true"`

	// A new name for the workspace to update.
	//
	// WorkspaceName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateWorkspaceInput's
	// String and GoString methods.
	WorkspaceName *string `locationName:"workspaceName" type:"string" sensitive:"true"`

	// Specify the Amazon Web Services notification channels that you plan to use
	// in this workspace. Specifying these data sources here enables Amazon Managed
	// Grafana to create IAM roles and permissions that allow Amazon Managed Grafana
	// to use these channels.
	WorkspaceNotificationDestinations []*string `locationName:"workspaceNotificationDestinations" type:"list" enum:"NotificationDestinationType"`

	// Specifies the organizational units that this workspace is allowed to use
	// data sources from, if this workspace is in an account that is part of an
	// organization.
	//
	// WorkspaceOrganizationalUnits is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateWorkspaceInput's
	// String and GoString methods.
	WorkspaceOrganizationalUnits []*string `locationName:"workspaceOrganizationalUnits" type:"list" sensitive:"true"`

	// The workspace needs an IAM role that grants permissions to the Amazon Web
	// Services resources that the workspace will view data from. If you already
	// have a role that you want to use, specify it here. If you omit this field
	// and you specify some Amazon Web Services resources in workspaceDataSources
	// or workspaceNotificationDestinations, a new IAM role with the necessary permissions
	// is automatically created.
	//
	// WorkspaceRoleArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateWorkspaceInput's
	// String and GoString methods.
	WorkspaceRoleArn *string `locationName:"workspaceRoleArn" min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UpdateWorkspaceInput) GoString 

func (s UpdateWorkspaceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkspaceInput) SetAccountAccessType 

func (s *UpdateWorkspaceInput) SetAccountAccessType(v string) *UpdateWorkspaceInput

SetAccountAccessType sets the AccountAccessType field's value.

func (*UpdateWorkspaceInput) SetOrganizationRoleName 

func (s *UpdateWorkspaceInput) SetOrganizationRoleName(v string) *UpdateWorkspaceInput

SetOrganizationRoleName sets the OrganizationRoleName field's value.

func (*UpdateWorkspaceInput) SetPermissionType 

func (s *UpdateWorkspaceInput) SetPermissionType(v string) *UpdateWorkspaceInput

SetPermissionType sets the PermissionType field's value.

func (*UpdateWorkspaceInput) SetStackSetName 

func (s *UpdateWorkspaceInput) SetStackSetName(v string) *UpdateWorkspaceInput

SetStackSetName sets the StackSetName field's value.

func (*UpdateWorkspaceInput) SetWorkspaceDataSources 

func (s *UpdateWorkspaceInput) SetWorkspaceDataSources(v []*string) *UpdateWorkspaceInput

SetWorkspaceDataSources sets the WorkspaceDataSources field's value.

func (*UpdateWorkspaceInput) SetWorkspaceDescription 

func (s *UpdateWorkspaceInput) SetWorkspaceDescription(v string) *UpdateWorkspaceInput

SetWorkspaceDescription sets the WorkspaceDescription field's value.

func (*UpdateWorkspaceInput) SetWorkspaceId 

func (s *UpdateWorkspaceInput) SetWorkspaceId(v string) *UpdateWorkspaceInput

SetWorkspaceId sets the WorkspaceId field's value.

func (*UpdateWorkspaceInput) SetWorkspaceName 

func (s *UpdateWorkspaceInput) SetWorkspaceName(v string) *UpdateWorkspaceInput

SetWorkspaceName sets the WorkspaceName field's value.

func (*UpdateWorkspaceInput) SetWorkspaceNotificationDestinations 

func (s *UpdateWorkspaceInput) SetWorkspaceNotificationDestinations(v []*string) *UpdateWorkspaceInput

SetWorkspaceNotificationDestinations sets the WorkspaceNotificationDestinations field's value.

func (*UpdateWorkspaceInput) SetWorkspaceOrganizationalUnits 

func (s *UpdateWorkspaceInput) SetWorkspaceOrganizationalUnits(v []*string) *UpdateWorkspaceInput

SetWorkspaceOrganizationalUnits sets the WorkspaceOrganizationalUnits field's value.

func (*UpdateWorkspaceInput) SetWorkspaceRoleArn 

func (s *UpdateWorkspaceInput) SetWorkspaceRoleArn(v string) *UpdateWorkspaceInput

SetWorkspaceRoleArn sets the WorkspaceRoleArn field's value.

func (UpdateWorkspaceInput) String 

func (s UpdateWorkspaceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkspaceInput) Validate 

func (s *UpdateWorkspaceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateWorkspaceOutput 

type UpdateWorkspaceOutput struct {

	// A structure containing data about the workspace that was created.
	//
	// Workspace is a required field
	Workspace *WorkspaceDescription `locationName:"workspace" type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateWorkspaceOutput) GoString 

func (s UpdateWorkspaceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkspaceOutput) SetWorkspace 

func (s *UpdateWorkspaceOutput) SetWorkspace(v *WorkspaceDescription) *UpdateWorkspaceOutput

SetWorkspace sets the Workspace field's value.

func (UpdateWorkspaceOutput) String 

func (s UpdateWorkspaceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type User 

type User struct {

	// The ID of the user or group.
	//
	// Pattern: ^([0-9a-fA-F]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$
	//
	// Id is a required field
	Id *string `locationName:"id" min:"1" type:"string" required:"true"`

	// Specifies whether this is a single user or a group.
	//
	// Type is a required field
	Type *string `locationName:"type" type:"string" required:"true" enum:"UserType"`
	// contains filtered or unexported fields
}

A structure that specifies one user or group in the workspace.

func (User) GoString 

func (s User) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*User) SetId 

func (s *User) SetId(v string) *User

SetId sets the Id field's value.

func (*User) SetType 

func (s *User) SetType(v string) *User

SetType sets the Type field's value.

func (User) String 

func (s User) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*User) Validate 

func (s *User) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ValidationException 

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// A list of fields that might be associated with the error.
	FieldList []*ValidationExceptionField `locationName:"fieldList" type:"list"`

	// A description of the error.
	Message_ *string `locationName:"message" type:"string"`

	// The reason that the operation failed.
	//
	// Reason is a required field
	Reason *string `locationName:"reason" type:"string" required:"true" enum:"ValidationExceptionReason"`
	// contains filtered or unexported fields
}

The value of a parameter in the request caused an error.

func (*ValidationException) Code 

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error 

func (s *ValidationException) Error() string

func (ValidationException) GoString 

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message 

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr 

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID 

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode 

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String 

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationExceptionField 

type ValidationExceptionField struct {

	// A message describing why this field couldn't be validated.
	//
	// Message is a required field
	Message *string `locationName:"message" type:"string" required:"true"`

	// The name of the field that caused the validation error.
	//
	// Name is a required field
	Name *string `locationName:"name" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A structure that contains information about a request parameter that caused an error.

func (ValidationExceptionField) GoString 

func (s ValidationExceptionField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationExceptionField) SetMessage 

func (s *ValidationExceptionField) SetMessage(v string) *ValidationExceptionField

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName 

func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField

SetName sets the Name field's value.

func (ValidationExceptionField) String 

func (s ValidationExceptionField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkspaceDescription 

type WorkspaceDescription struct {

	// Specifies whether the workspace can access Amazon Web Services resources
	// in this Amazon Web Services account only, or whether it can also access Amazon
	// Web Services resources in other accounts in the same organization. If this
	// is ORGANIZATION, the workspaceOrganizationalUnits parameter specifies which
	// organizational units the workspace can access.
	AccountAccessType *string `locationName:"accountAccessType" type:"string" enum:"AccountAccessType"`

	// A structure that describes whether the workspace uses SAML, Amazon Web Services
	// SSO, or both methods for user authentication.
	//
	// Authentication is a required field
	Authentication *AuthenticationSummary `locationName:"authentication" type:"structure" required:"true"`

	// The date that the workspace was created.
	//
	// Created is a required field
	Created *time.Time `locationName:"created" type:"timestamp" required:"true"`

	// Specifies the Amazon Web Services data sources that have been configured
	// to have IAM roles and permissions created to allow Amazon Managed Grafana
	// to read data from these sources.
	//
	// DataSources is a required field
	DataSources []*string `locationName:"dataSources" type:"list" required:"true" enum:"DataSourceType"`

	// The user-defined description of the workspace.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by WorkspaceDescription's
	// String and GoString methods.
	Description *string `locationName:"description" type:"string" sensitive:"true"`

	// The URL that users can use to access the Grafana console in the workspace.
	//
	// Endpoint is a required field
	Endpoint *string `locationName:"endpoint" min:"1" type:"string" required:"true"`

	// Specifies whether this workspace has already fully used its free trial for
	// Grafana Enterprise.
	FreeTrialConsumed *bool `locationName:"freeTrialConsumed" type:"boolean"`

	// If this workspace is currently in the free trial period for Grafana Enterprise,
	// this value specifies when that free trial ends.
	FreeTrialExpiration *time.Time `locationName:"freeTrialExpiration" type:"timestamp"`

	// The version of Grafana supported in this workspace.
	//
	// GrafanaVersion is a required field
	GrafanaVersion *string `locationName:"grafanaVersion" min:"1" type:"string" required:"true"`

	// The unique ID of this workspace.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// If this workspace has a full Grafana Enterprise license, this specifies when
	// the license ends and will need to be renewed.
	LicenseExpiration *time.Time `locationName:"licenseExpiration" type:"timestamp"`

	// Specifies whether this workspace has a full Grafana Enterprise license or
	// a free trial license.
	LicenseType *string `locationName:"licenseType" type:"string" enum:"LicenseType"`

	// The most recent date that the workspace was modified.
	//
	// Modified is a required field
	Modified *time.Time `locationName:"modified" type:"timestamp" required:"true"`

	// The name of the workspace.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by WorkspaceDescription's
	// String and GoString methods.
	Name *string `locationName:"name" type:"string" sensitive:"true"`

	// The Amazon Web Services notification channels that Amazon Managed Grafana
	// can automatically create IAM roles and permissions for, to allow Amazon Managed
	// Grafana to use these channels.
	NotificationDestinations []*string `locationName:"notificationDestinations" type:"list" enum:"NotificationDestinationType"`

	// The name of the IAM role that is used to access resources through Organizations.
	//
	// OrganizationRoleName is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by WorkspaceDescription's
	// String and GoString methods.
	OrganizationRoleName *string `locationName:"organizationRoleName" min:"1" type:"string" sensitive:"true"`

	// Specifies the organizational units that this workspace is allowed to use
	// data sources from, if this workspace is in an account that is part of an
	// organization.
	//
	// OrganizationalUnits is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by WorkspaceDescription's
	// String and GoString methods.
	OrganizationalUnits []*string `locationName:"organizationalUnits" type:"list" sensitive:"true"`

	// If this is Service Managed, Amazon Managed Grafana automatically creates
	// the IAM roles and provisions the permissions that the workspace needs to
	// use Amazon Web Services data sources and notification channels.
	//
	// If this is CUSTOMER_MANAGED, you manage those roles and permissions yourself.
	// If you are creating this workspace in a member account of an organization
	// and that account is not a delegated administrator account, and you want the
	// workspace to access data sources in other Amazon Web Services accounts in
	// the organization, you must choose CUSTOMER_MANAGED.
	//
	// For more information, see Amazon Managed Grafana permissions and policies
	// for Amazon Web Services data sources and notification channels (https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html)
	PermissionType *string `locationName:"permissionType" type:"string" enum:"PermissionType"`

	// The name of the CloudFormation stack set that is used to generate IAM roles
	// to be used for this workspace.
	StackSetName *string `locationName:"stackSetName" type:"string"`

	// The current status of the workspace.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"WorkspaceStatus"`

	// The list of tags associated with the workspace.
	Tags map[string]*string `locationName:"tags" type:"map"`

	// The IAM role that grants permissions to the Amazon Web Services resources
	// that the workspace will view data from. This role must already exist.
	//
	// WorkspaceRoleArn is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by WorkspaceDescription's
	// String and GoString methods.
	WorkspaceRoleArn *string `locationName:"workspaceRoleArn" min:"1" type:"string" sensitive:"true"`
	// contains filtered or unexported fields
}

A structure containing information about an Amazon Managed Grafana workspace in your account.

func (WorkspaceDescription) GoString 

func (s WorkspaceDescription) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceDescription) SetAccountAccessType 

func (s *WorkspaceDescription) SetAccountAccessType(v string) *WorkspaceDescription

SetAccountAccessType sets the AccountAccessType field's value.

func (*WorkspaceDescription) SetAuthentication 

func (s *WorkspaceDescription) SetAuthentication(v *AuthenticationSummary) *WorkspaceDescription

SetAuthentication sets the Authentication field's value.

func (*WorkspaceDescription) SetCreated 

func (s *WorkspaceDescription) SetCreated(v time.Time) *WorkspaceDescription

SetCreated sets the Created field's value.

func (*WorkspaceDescription) SetDataSources 

func (s *WorkspaceDescription) SetDataSources(v []*string) *WorkspaceDescription

SetDataSources sets the DataSources field's value.

func (*WorkspaceDescription) SetDescription 

func (s *WorkspaceDescription) SetDescription(v string) *WorkspaceDescription

SetDescription sets the Description field's value.

func (*WorkspaceDescription) SetEndpoint 

func (s *WorkspaceDescription) SetEndpoint(v string) *WorkspaceDescription

SetEndpoint sets the Endpoint field's value.

func (*WorkspaceDescription) SetFreeTrialConsumed 

func (s *WorkspaceDescription) SetFreeTrialConsumed(v bool) *WorkspaceDescription

SetFreeTrialConsumed sets the FreeTrialConsumed field's value.

func (*WorkspaceDescription) SetFreeTrialExpiration 

func (s *WorkspaceDescription) SetFreeTrialExpiration(v time.Time) *WorkspaceDescription

SetFreeTrialExpiration sets the FreeTrialExpiration field's value.

func (*WorkspaceDescription) SetGrafanaVersion 

func (s *WorkspaceDescription) SetGrafanaVersion(v string) *WorkspaceDescription

SetGrafanaVersion sets the GrafanaVersion field's value.

func (*WorkspaceDescription) SetId 

func (s *WorkspaceDescription) SetId(v string) *WorkspaceDescription

SetId sets the Id field's value.

func (*WorkspaceDescription) SetLicenseExpiration 

func (s *WorkspaceDescription) SetLicenseExpiration(v time.Time) *WorkspaceDescription

SetLicenseExpiration sets the LicenseExpiration field's value.

func (*WorkspaceDescription) SetLicenseType 

func (s *WorkspaceDescription) SetLicenseType(v string) *WorkspaceDescription

SetLicenseType sets the LicenseType field's value.

func (*WorkspaceDescription) SetModified 

func (s *WorkspaceDescription) SetModified(v time.Time) *WorkspaceDescription

SetModified sets the Modified field's value.

func (*WorkspaceDescription) SetName 

func (s *WorkspaceDescription) SetName(v string) *WorkspaceDescription

SetName sets the Name field's value.

func (*WorkspaceDescription) SetNotificationDestinations 

func (s *WorkspaceDescription) SetNotificationDestinations(v []*string) *WorkspaceDescription

SetNotificationDestinations sets the NotificationDestinations field's value.

func (*WorkspaceDescription) SetOrganizationRoleName 

func (s *WorkspaceDescription) SetOrganizationRoleName(v string) *WorkspaceDescription

SetOrganizationRoleName sets the OrganizationRoleName field's value.

func (*WorkspaceDescription) SetOrganizationalUnits 

func (s *WorkspaceDescription) SetOrganizationalUnits(v []*string) *WorkspaceDescription

SetOrganizationalUnits sets the OrganizationalUnits field's value.

func (*WorkspaceDescription) SetPermissionType 

func (s *WorkspaceDescription) SetPermissionType(v string) *WorkspaceDescription

SetPermissionType sets the PermissionType field's value.

func (*WorkspaceDescription) SetStackSetName 

func (s *WorkspaceDescription) SetStackSetName(v string) *WorkspaceDescription

SetStackSetName sets the StackSetName field's value.

func (*WorkspaceDescription) SetStatus 

func (s *WorkspaceDescription) SetStatus(v string) *WorkspaceDescription

SetStatus sets the Status field's value.

func (*WorkspaceDescription) SetTags added in v1.43.30 

func (s *WorkspaceDescription) SetTags(v map[string]*string) *WorkspaceDescription

SetTags sets the Tags field's value.

func (*WorkspaceDescription) SetWorkspaceRoleArn 

func (s *WorkspaceDescription) SetWorkspaceRoleArn(v string) *WorkspaceDescription

SetWorkspaceRoleArn sets the WorkspaceRoleArn field's value.

func (WorkspaceDescription) String 

func (s WorkspaceDescription) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkspaceSummary 

type WorkspaceSummary struct {

	// A structure containing information about the authentication methods used
	// in the workspace.
	//
	// Authentication is a required field
	Authentication *AuthenticationSummary `locationName:"authentication" type:"structure" required:"true"`

	// The date that the workspace was created.
	//
	// Created is a required field
	Created *time.Time `locationName:"created" type:"timestamp" required:"true"`

	// The customer-entered description of the workspace.
	//
	// Description is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by WorkspaceSummary's
	// String and GoString methods.
	Description *string `locationName:"description" type:"string" sensitive:"true"`

	// The URL endpoint to use to access the Grafana console in the workspace.
	//
	// Endpoint is a required field
	Endpoint *string `locationName:"endpoint" min:"1" type:"string" required:"true"`

	// The Grafana version that the workspace is running.
	//
	// GrafanaVersion is a required field
	GrafanaVersion *string `locationName:"grafanaVersion" min:"1" type:"string" required:"true"`

	// The unique ID of the workspace.
	//
	// Id is a required field
	Id *string `locationName:"id" type:"string" required:"true"`

	// The most recent date that the workspace was modified.
	//
	// Modified is a required field
	Modified *time.Time `locationName:"modified" type:"timestamp" required:"true"`

	// The name of the workspace.
	//
	// Name is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by WorkspaceSummary's
	// String and GoString methods.
	Name *string `locationName:"name" type:"string" sensitive:"true"`

	// The Amazon Web Services notification channels that Amazon Managed Grafana
	// can automatically create IAM roles and permissions for, which allows Amazon
	// Managed Grafana to use these channels.
	NotificationDestinations []*string `locationName:"notificationDestinations" type:"list" enum:"NotificationDestinationType"`

	// The current status of the workspace.
	//
	// Status is a required field
	Status *string `locationName:"status" type:"string" required:"true" enum:"WorkspaceStatus"`

	// The list of tags associated with the workspace.
	Tags map[string]*string `locationName:"tags" type:"map"`
	// contains filtered or unexported fields
}

A structure that contains some information about one workspace in the account.

func (WorkspaceSummary) GoString 

func (s WorkspaceSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkspaceSummary) SetAuthentication 

func (s *WorkspaceSummary) SetAuthentication(v *AuthenticationSummary) *WorkspaceSummary

SetAuthentication sets the Authentication field's value.

func (*WorkspaceSummary) SetCreated 

func (s *WorkspaceSummary) SetCreated(v time.Time) *WorkspaceSummary

SetCreated sets the Created field's value.

func (*WorkspaceSummary) SetDescription 

func (s *WorkspaceSummary) SetDescription(v string) *WorkspaceSummary

SetDescription sets the Description field's value.

func (*WorkspaceSummary) SetEndpoint 

func (s *WorkspaceSummary) SetEndpoint(v string) *WorkspaceSummary

SetEndpoint sets the Endpoint field's value.

func (*WorkspaceSummary) SetGrafanaVersion 

func (s *WorkspaceSummary) SetGrafanaVersion(v string) *WorkspaceSummary

SetGrafanaVersion sets the GrafanaVersion field's value.

func (*WorkspaceSummary) SetId 

func (s *WorkspaceSummary) SetId(v string) *WorkspaceSummary

SetId sets the Id field's value.

func (*WorkspaceSummary) SetModified 

func (s *WorkspaceSummary) SetModified(v time.Time) *WorkspaceSummary

SetModified sets the Modified field's value.

func (*WorkspaceSummary) SetName 

func (s *WorkspaceSummary) SetName(v string) *WorkspaceSummary

SetName sets the Name field's value.

func (*WorkspaceSummary) SetNotificationDestinations 

func (s *WorkspaceSummary) SetNotificationDestinations(v []*string) *WorkspaceSummary

SetNotificationDestinations sets the NotificationDestinations field's value.

func (*WorkspaceSummary) SetStatus 

func (s *WorkspaceSummary) SetStatus(v string) *WorkspaceSummary

SetStatus sets the Status field's value.

func (*WorkspaceSummary) SetTags added in v1.43.30 

func (s *WorkspaceSummary) SetTags(v map[string]*string) *WorkspaceSummary

SetTags sets the Tags field's value.

func (WorkspaceSummary) String 

func (s WorkspaceSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

Path Synopsis
Package managedgrafanaiface provides an interface to enable mocking the Amazon Managed Grafana service client for testing your code.
 Package managedgrafanaiface provides an interface to enable mocking the Amazon Managed Grafana service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.