Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- AssociateLicense
- CreateWorkspace
- CreateWorkspaceApiKey
- DeleteWorkspace
- DeleteWorkspaceApiKey
- DescribeWorkspace
- DescribeWorkspaceAuthentication
- DescribeWorkspaceConfiguration
- DisassociateLicense
- ListPermissions (Paginated)
- ListTagsForResource
- ListWorkspaces (Paginated)
- TagResource
- UntagResource
- UpdatePermissions
- UpdateWorkspace
- UpdateWorkspaceAuthentication
- UpdateWorkspaceConfiguration
- Types
- AccountAccessType
- AuthenticationProviderTypes
- DataSourceType
- LicenseType
- NotificationDestinationType
- PermissionType
- Role
- SamlConfigurationStatus
- UpdateAction
- UserType
- WorkspaceStatus
- AssertionAttributes
- AuthenticationDescription
- AuthenticationSummary
- AwsSsoAuthentication
- IdpMetadata
- PermissionEntry
- RoleValues
- SamlAuthentication
- SamlConfiguration
- UpdateError
- UpdateInstruction
- User
- VpcConfiguration
- WorkspaceDescription
- WorkspaceSummary
Derived from API version 2020-08-18
of the AWS service descriptions, licensed under Apache 2.0.
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.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data AssociateLicense = AssociateLicense' LicenseType Text
- newAssociateLicense :: LicenseType -> Text -> AssociateLicense
- data AssociateLicenseResponse = AssociateLicenseResponse' Int WorkspaceDescription
- newAssociateLicenseResponse :: Int -> WorkspaceDescription -> AssociateLicenseResponse
- data CreateWorkspace = CreateWorkspace' (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe VpcConfiguration) (Maybe [DataSourceType]) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe [NotificationDestinationType]) (Maybe (Sensitive [Text])) (Maybe (Sensitive Text)) AccountAccessType [AuthenticationProviderTypes] PermissionType
- newCreateWorkspace :: AccountAccessType -> PermissionType -> CreateWorkspace
- data CreateWorkspaceResponse = CreateWorkspaceResponse' Int WorkspaceDescription
- newCreateWorkspaceResponse :: Int -> WorkspaceDescription -> CreateWorkspaceResponse
- data CreateWorkspaceApiKey = CreateWorkspaceApiKey' Text Text Natural Text
- newCreateWorkspaceApiKey :: Text -> Text -> Natural -> Text -> CreateWorkspaceApiKey
- data CreateWorkspaceApiKeyResponse = CreateWorkspaceApiKeyResponse' Int (Sensitive Text) Text Text
- newCreateWorkspaceApiKeyResponse :: Int -> Text -> Text -> Text -> CreateWorkspaceApiKeyResponse
- data DeleteWorkspace = DeleteWorkspace' Text
- newDeleteWorkspace :: Text -> DeleteWorkspace
- data DeleteWorkspaceResponse = DeleteWorkspaceResponse' Int WorkspaceDescription
- newDeleteWorkspaceResponse :: Int -> WorkspaceDescription -> DeleteWorkspaceResponse
- data DeleteWorkspaceApiKey = DeleteWorkspaceApiKey' Text Text
- newDeleteWorkspaceApiKey :: Text -> Text -> DeleteWorkspaceApiKey
- data DeleteWorkspaceApiKeyResponse = DeleteWorkspaceApiKeyResponse' Int Text Text
- newDeleteWorkspaceApiKeyResponse :: Int -> Text -> Text -> DeleteWorkspaceApiKeyResponse
- data DescribeWorkspace = DescribeWorkspace' Text
- newDescribeWorkspace :: Text -> DescribeWorkspace
- data DescribeWorkspaceResponse = DescribeWorkspaceResponse' Int WorkspaceDescription
- newDescribeWorkspaceResponse :: Int -> WorkspaceDescription -> DescribeWorkspaceResponse
- data DescribeWorkspaceAuthentication = DescribeWorkspaceAuthentication' Text
- newDescribeWorkspaceAuthentication :: Text -> DescribeWorkspaceAuthentication
- data DescribeWorkspaceAuthenticationResponse = DescribeWorkspaceAuthenticationResponse' Int AuthenticationDescription
- newDescribeWorkspaceAuthenticationResponse :: Int -> AuthenticationDescription -> DescribeWorkspaceAuthenticationResponse
- data DescribeWorkspaceConfiguration = DescribeWorkspaceConfiguration' Text
- newDescribeWorkspaceConfiguration :: Text -> DescribeWorkspaceConfiguration
- data DescribeWorkspaceConfigurationResponse = DescribeWorkspaceConfigurationResponse' Int Text
- newDescribeWorkspaceConfigurationResponse :: Int -> Text -> DescribeWorkspaceConfigurationResponse
- data DisassociateLicense = DisassociateLicense' LicenseType Text
- newDisassociateLicense :: LicenseType -> Text -> DisassociateLicense
- data DisassociateLicenseResponse = DisassociateLicenseResponse' Int WorkspaceDescription
- newDisassociateLicenseResponse :: Int -> WorkspaceDescription -> DisassociateLicenseResponse
- data ListPermissions = ListPermissions' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe UserType) Text
- newListPermissions :: Text -> ListPermissions
- data ListPermissionsResponse = ListPermissionsResponse' (Maybe Text) Int [PermissionEntry]
- newListPermissionsResponse :: Int -> ListPermissionsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListWorkspaces = ListWorkspaces' (Maybe Natural) (Maybe Text)
- newListWorkspaces :: ListWorkspaces
- data ListWorkspacesResponse = ListWorkspacesResponse' (Maybe Text) Int [WorkspaceSummary]
- newListWorkspacesResponse :: Int -> ListWorkspacesResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdatePermissions = UpdatePermissions' [UpdateInstruction] Text
- newUpdatePermissions :: Text -> UpdatePermissions
- data UpdatePermissionsResponse = UpdatePermissionsResponse' Int [UpdateError]
- newUpdatePermissionsResponse :: Int -> UpdatePermissionsResponse
- data UpdateWorkspace = UpdateWorkspace' (Maybe AccountAccessType) (Maybe (Sensitive Text)) (Maybe PermissionType) (Maybe Bool) (Maybe Text) (Maybe VpcConfiguration) (Maybe [DataSourceType]) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe [NotificationDestinationType]) (Maybe (Sensitive [Text])) (Maybe (Sensitive Text)) Text
- newUpdateWorkspace :: Text -> UpdateWorkspace
- data UpdateWorkspaceResponse = UpdateWorkspaceResponse' Int WorkspaceDescription
- newUpdateWorkspaceResponse :: Int -> WorkspaceDescription -> UpdateWorkspaceResponse
- data UpdateWorkspaceAuthentication = UpdateWorkspaceAuthentication' (Maybe SamlConfiguration) [AuthenticationProviderTypes] Text
- newUpdateWorkspaceAuthentication :: Text -> UpdateWorkspaceAuthentication
- data UpdateWorkspaceAuthenticationResponse = UpdateWorkspaceAuthenticationResponse' Int AuthenticationDescription
- newUpdateWorkspaceAuthenticationResponse :: Int -> AuthenticationDescription -> UpdateWorkspaceAuthenticationResponse
- data UpdateWorkspaceConfiguration = UpdateWorkspaceConfiguration' Text Text
- newUpdateWorkspaceConfiguration :: Text -> Text -> UpdateWorkspaceConfiguration
- data UpdateWorkspaceConfigurationResponse = UpdateWorkspaceConfigurationResponse' Int
- newUpdateWorkspaceConfigurationResponse :: Int -> UpdateWorkspaceConfigurationResponse
- newtype AccountAccessType where
- newtype AuthenticationProviderTypes where
- newtype DataSourceType where
- DataSourceType' { }
- pattern DataSourceType_AMAZON_OPENSEARCH_SERVICE :: DataSourceType
- pattern DataSourceType_ATHENA :: DataSourceType
- pattern DataSourceType_CLOUDWATCH :: DataSourceType
- pattern DataSourceType_PROMETHEUS :: DataSourceType
- pattern DataSourceType_REDSHIFT :: DataSourceType
- pattern DataSourceType_SITEWISE :: DataSourceType
- pattern DataSourceType_TIMESTREAM :: DataSourceType
- pattern DataSourceType_TWINMAKER :: DataSourceType
- pattern DataSourceType_XRAY :: DataSourceType
- newtype LicenseType where
- LicenseType' { }
- pattern LicenseType_ENTERPRISE :: LicenseType
- pattern LicenseType_ENTERPRISE_FREE_TRIAL :: LicenseType
- newtype NotificationDestinationType where
- newtype PermissionType where
- PermissionType' { }
- pattern PermissionType_CUSTOMER_MANAGED :: PermissionType
- pattern PermissionType_SERVICE_MANAGED :: PermissionType
- newtype Role where
- Role' { }
- pattern Role_ADMIN :: Role
- pattern Role_EDITOR :: Role
- pattern Role_VIEWER :: Role
- newtype SamlConfigurationStatus where
- newtype UpdateAction where
- UpdateAction' { }
- pattern UpdateAction_ADD :: UpdateAction
- pattern UpdateAction_REVOKE :: UpdateAction
- newtype UserType where
- UserType' {
- fromUserType :: Text
- pattern UserType_SSO_GROUP :: UserType
- pattern UserType_SSO_USER :: UserType
- UserType' {
- newtype WorkspaceStatus where
- WorkspaceStatus' { }
- pattern WorkspaceStatus_ACTIVE :: WorkspaceStatus
- pattern WorkspaceStatus_CREATING :: WorkspaceStatus
- pattern WorkspaceStatus_CREATION_FAILED :: WorkspaceStatus
- pattern WorkspaceStatus_DELETING :: WorkspaceStatus
- pattern WorkspaceStatus_DELETION_FAILED :: WorkspaceStatus
- pattern WorkspaceStatus_FAILED :: WorkspaceStatus
- pattern WorkspaceStatus_LICENSE_REMOVAL_FAILED :: WorkspaceStatus
- pattern WorkspaceStatus_UPDATE_FAILED :: WorkspaceStatus
- pattern WorkspaceStatus_UPDATING :: WorkspaceStatus
- pattern WorkspaceStatus_UPGRADE_FAILED :: WorkspaceStatus
- pattern WorkspaceStatus_UPGRADING :: WorkspaceStatus
- data AssertionAttributes = AssertionAttributes' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newAssertionAttributes :: AssertionAttributes
- data AuthenticationDescription = AuthenticationDescription' (Maybe AwsSsoAuthentication) (Maybe SamlAuthentication) [AuthenticationProviderTypes]
- newAuthenticationDescription :: AuthenticationDescription
- data AuthenticationSummary = AuthenticationSummary' (Maybe SamlConfigurationStatus) [AuthenticationProviderTypes]
- newAuthenticationSummary :: AuthenticationSummary
- data AwsSsoAuthentication = AwsSsoAuthentication' (Maybe Text)
- newAwsSsoAuthentication :: AwsSsoAuthentication
- data IdpMetadata = IdpMetadata' (Maybe Text) (Maybe Text)
- newIdpMetadata :: IdpMetadata
- data PermissionEntry = PermissionEntry' Role User
- newPermissionEntry :: Role -> User -> PermissionEntry
- data RoleValues = RoleValues' (Maybe [Text]) (Maybe [Text])
- newRoleValues :: RoleValues
- data SamlAuthentication = SamlAuthentication' (Maybe SamlConfiguration) SamlConfigurationStatus
- newSamlAuthentication :: SamlConfigurationStatus -> SamlAuthentication
- data SamlConfiguration = SamlConfiguration' (Maybe [Text]) (Maybe AssertionAttributes) (Maybe Int) (Maybe RoleValues) IdpMetadata
- newSamlConfiguration :: IdpMetadata -> SamlConfiguration
- data UpdateError = UpdateError' UpdateInstruction Natural Text
- newUpdateError :: UpdateInstruction -> Natural -> Text -> UpdateError
- data UpdateInstruction = UpdateInstruction' UpdateAction Role [User]
- newUpdateInstruction :: UpdateAction -> Role -> UpdateInstruction
- data User = User' Text UserType
- newUser :: Text -> UserType -> User
- data VpcConfiguration = VpcConfiguration' (NonEmpty Text) (NonEmpty Text)
- newVpcConfiguration :: NonEmpty Text -> NonEmpty Text -> VpcConfiguration
- data WorkspaceDescription = WorkspaceDescription' (Maybe AccountAccessType) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe POSIX) (Maybe POSIX) (Maybe LicenseType) (Maybe (Sensitive Text)) (Maybe [NotificationDestinationType]) (Maybe (Sensitive Text)) (Maybe (Sensitive [Text])) (Maybe PermissionType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe VpcConfiguration) (Maybe (Sensitive Text)) AuthenticationSummary POSIX [DataSourceType] Text Text Text POSIX WorkspaceStatus
- newWorkspaceDescription :: AuthenticationSummary -> UTCTime -> Text -> Text -> Text -> UTCTime -> WorkspaceStatus -> WorkspaceDescription
- data WorkspaceSummary = WorkspaceSummary' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe [NotificationDestinationType]) (Maybe (HashMap Text Text)) AuthenticationSummary POSIX Text Text Text POSIX WorkspaceStatus
- newWorkspaceSummary :: AuthenticationSummary -> UTCTime -> Text -> Text -> Text -> UTCTime -> WorkspaceStatus -> WorkspaceSummary
Service Configuration
defaultService :: Service Source #
API version 2020-08-18
of the Amazon Managed Grafana SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Grafana
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient permissions to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
A resource was in an inconsistent state during an update or a deletion.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
Unexpected error while processing the request. Retry the request.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The request references a resource that does not exist.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request would cause a service quota to be exceeded.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied because of request throttling. Retry the request.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The value of a parameter in the request caused an error.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateLicense
data AssociateLicense Source #
See: newAssociateLicense
smart constructor.
Instances
Create a value of AssociateLicense
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateLicense
, associateLicense_licenseType
- The type of license to associate with the workspace.
$sel:workspaceId:AssociateLicense'
, associateLicense_workspaceId
- The ID of the workspace to associate the license with.
data AssociateLicenseResponse Source #
See: newAssociateLicenseResponse
smart constructor.
Instances
newAssociateLicenseResponse Source #
Create a value of AssociateLicenseResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:AssociateLicenseResponse'
, associateLicenseResponse_httpStatus
- The response's http status code.
$sel:workspace:AssociateLicenseResponse'
, associateLicenseResponse_workspace
- A structure containing data about the workspace.
CreateWorkspace
data CreateWorkspace Source #
See: newCreateWorkspace
smart constructor.
CreateWorkspace' (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe VpcConfiguration) (Maybe [DataSourceType]) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe [NotificationDestinationType]) (Maybe (Sensitive [Text])) (Maybe (Sensitive Text)) AccountAccessType [AuthenticationProviderTypes] PermissionType |
Instances
Create a value of CreateWorkspace
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateWorkspace'
, createWorkspace_clientToken
- A unique, case-sensitive, user-provided identifier to ensure the
idempotency of the request.
CreateWorkspace
, createWorkspace_configuration
- The configuration string for the workspace that you create. For more
information about the format and configuration options available, see
Working in your Grafana workspace.
CreateWorkspace
, createWorkspace_organizationRoleName
- 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.
CreateWorkspace
, createWorkspace_stackSetName
- The name of the CloudFormation stack set to use to generate IAM roles to
be used for this workspace.
CreateWorkspace
, createWorkspace_tags
- The list of tags associated with the workspace.
CreateWorkspace
, createWorkspace_vpcConfiguration
- The configuration settings for an Amazon VPC that contains data sources
for your Grafana workspace to connect to.
$sel:workspaceDataSources:CreateWorkspace'
, createWorkspace_workspaceDataSources
- 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.
$sel:workspaceDescription:CreateWorkspace'
, createWorkspace_workspaceDescription
- 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}$
$sel:workspaceName:CreateWorkspace'
, createWorkspace_workspaceName
- The name for the workspace. It does not have to be unique.
$sel:workspaceNotificationDestinations:CreateWorkspace'
, createWorkspace_workspaceNotificationDestinations
- 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.
$sel:workspaceOrganizationalUnits:CreateWorkspace'
, createWorkspace_workspaceOrganizationalUnits
- 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.
CreateWorkspace
, createWorkspace_workspaceRoleArn
- 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
.
CreateWorkspace
, createWorkspace_accountAccessType
- 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.
$sel:authenticationProviders:CreateWorkspace'
, createWorkspace_authenticationProviders
- Specifies whether this workspace uses SAML 2.0, IAM Identity Center
(successor to 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.
CreateWorkspace
, createWorkspace_permissionType
- 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 the CLI mode, the permissionType
SERVICE_MANAGED
will not create the IAM role for you. The ability for
the Amazon Managed Grafana to create the IAM role on behalf of the user
is supported only in the Amazon Managed Grafana AWS console. Use only
the CUSTOMER_MANAGED
permission type when creating a workspace in the
CLI.
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.
data CreateWorkspaceResponse Source #
See: newCreateWorkspaceResponse
smart constructor.
Instances
newCreateWorkspaceResponse Source #
Create a value of CreateWorkspaceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateWorkspaceResponse'
, createWorkspaceResponse_httpStatus
- The response's http status code.
$sel:workspace:CreateWorkspaceResponse'
, createWorkspaceResponse_workspace
- A structure containing data about the workspace that was created.
CreateWorkspaceApiKey
data CreateWorkspaceApiKey Source #
See: newCreateWorkspaceApiKey
smart constructor.
Instances
newCreateWorkspaceApiKey Source #
:: Text | |
-> Text | |
-> Natural | |
-> Text | |
-> CreateWorkspaceApiKey |
Create a value of CreateWorkspaceApiKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWorkspaceApiKey
, createWorkspaceApiKey_keyName
- Specifies the name of the key. Keynames must be unique to the workspace.
$sel:keyRole:CreateWorkspaceApiKey'
, createWorkspaceApiKey_keyRole
- Specifies the permission level of the key.
Valid values: VIEWER
|EDITOR
|ADMIN
$sel:secondsToLive:CreateWorkspaceApiKey'
, createWorkspaceApiKey_secondsToLive
- Specifies the time in seconds until the key expires. Keys can be valid
for up to 30 days.
CreateWorkspaceApiKey
, createWorkspaceApiKey_workspaceId
- The ID of the workspace to create an API key.
data CreateWorkspaceApiKeyResponse Source #
See: newCreateWorkspaceApiKeyResponse
smart constructor.
Instances
newCreateWorkspaceApiKeyResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Text | |
-> CreateWorkspaceApiKeyResponse |
Create a value of CreateWorkspaceApiKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateWorkspaceApiKeyResponse'
, createWorkspaceApiKeyResponse_httpStatus
- The response's http status code.
$sel:key:CreateWorkspaceApiKeyResponse'
, createWorkspaceApiKeyResponse_key
- The key token. Use this value as a bearer token to authenticate HTTP
requests to the workspace.
CreateWorkspaceApiKey
, createWorkspaceApiKeyResponse_keyName
- The name of the key that was created.
CreateWorkspaceApiKey
, createWorkspaceApiKeyResponse_workspaceId
- The ID of the workspace that the key is valid for.
DeleteWorkspace
data DeleteWorkspace Source #
See: newDeleteWorkspace
smart constructor.
Instances
Create a value of DeleteWorkspace
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:workspaceId:DeleteWorkspace'
, deleteWorkspace_workspaceId
- The ID of the workspace to delete.
data DeleteWorkspaceResponse Source #
See: newDeleteWorkspaceResponse
smart constructor.
Instances
newDeleteWorkspaceResponse Source #
Create a value of DeleteWorkspaceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteWorkspaceResponse'
, deleteWorkspaceResponse_httpStatus
- The response's http status code.
$sel:workspace:DeleteWorkspaceResponse'
, deleteWorkspaceResponse_workspace
- A structure containing information about the workspace that was deleted.
DeleteWorkspaceApiKey
data DeleteWorkspaceApiKey Source #
See: newDeleteWorkspaceApiKey
smart constructor.
Instances
newDeleteWorkspaceApiKey Source #
Create a value of DeleteWorkspaceApiKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteWorkspaceApiKey
, deleteWorkspaceApiKey_keyName
- The name of the API key to delete.
DeleteWorkspaceApiKey
, deleteWorkspaceApiKey_workspaceId
- The ID of the workspace to delete.
data DeleteWorkspaceApiKeyResponse Source #
See: newDeleteWorkspaceApiKeyResponse
smart constructor.
Instances
newDeleteWorkspaceApiKeyResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> DeleteWorkspaceApiKeyResponse |
Create a value of DeleteWorkspaceApiKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteWorkspaceApiKeyResponse'
, deleteWorkspaceApiKeyResponse_httpStatus
- The response's http status code.
DeleteWorkspaceApiKey
, deleteWorkspaceApiKeyResponse_keyName
- The name of the key that was deleted.
DeleteWorkspaceApiKey
, deleteWorkspaceApiKeyResponse_workspaceId
- The ID of the workspace where the key was deleted.
DescribeWorkspace
data DescribeWorkspace Source #
See: newDescribeWorkspace
smart constructor.
Instances
Create a value of DescribeWorkspace
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:workspaceId:DescribeWorkspace'
, describeWorkspace_workspaceId
- The ID of the workspace to display information about.
data DescribeWorkspaceResponse Source #
See: newDescribeWorkspaceResponse
smart constructor.
Instances
newDescribeWorkspaceResponse Source #
Create a value of DescribeWorkspaceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeWorkspaceResponse'
, describeWorkspaceResponse_httpStatus
- The response's http status code.
$sel:workspace:DescribeWorkspaceResponse'
, describeWorkspaceResponse_workspace
- A structure containing information about the workspace.
DescribeWorkspaceAuthentication
data DescribeWorkspaceAuthentication Source #
See: newDescribeWorkspaceAuthentication
smart constructor.
Instances
newDescribeWorkspaceAuthentication Source #
Create a value of DescribeWorkspaceAuthentication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:workspaceId:DescribeWorkspaceAuthentication'
, describeWorkspaceAuthentication_workspaceId
- The ID of the workspace to return authentication information about.
data DescribeWorkspaceAuthenticationResponse Source #
See: newDescribeWorkspaceAuthenticationResponse
smart constructor.
Instances
newDescribeWorkspaceAuthenticationResponse Source #
Create a value of DescribeWorkspaceAuthenticationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeWorkspaceAuthenticationResponse'
, describeWorkspaceAuthenticationResponse_httpStatus
- The response's http status code.
DescribeWorkspaceAuthenticationResponse
, describeWorkspaceAuthenticationResponse_authentication
- A structure containing information about the authentication methods used
in the workspace.
DescribeWorkspaceConfiguration
data DescribeWorkspaceConfiguration Source #
See: newDescribeWorkspaceConfiguration
smart constructor.
Instances
newDescribeWorkspaceConfiguration Source #
Create a value of DescribeWorkspaceConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:workspaceId:DescribeWorkspaceConfiguration'
, describeWorkspaceConfiguration_workspaceId
- The ID of the workspace to get configuration information for.
data DescribeWorkspaceConfigurationResponse Source #
See: newDescribeWorkspaceConfigurationResponse
smart constructor.
Instances
newDescribeWorkspaceConfigurationResponse Source #
Create a value of DescribeWorkspaceConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DescribeWorkspaceConfigurationResponse'
, describeWorkspaceConfigurationResponse_httpStatus
- The response's http status code.
DescribeWorkspaceConfigurationResponse
, describeWorkspaceConfigurationResponse_configuration
- The configuration string for the workspace that you requested. For more
information about the format and configuration options available, see
Working in your Grafana workspace.
DisassociateLicense
data DisassociateLicense Source #
See: newDisassociateLicense
smart constructor.
Instances
newDisassociateLicense Source #
Create a value of DisassociateLicense
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateLicense
, disassociateLicense_licenseType
- The type of license to remove from the workspace.
$sel:workspaceId:DisassociateLicense'
, disassociateLicense_workspaceId
- The ID of the workspace to remove the Grafana Enterprise license from.
data DisassociateLicenseResponse Source #
See: newDisassociateLicenseResponse
smart constructor.
Instances
newDisassociateLicenseResponse Source #
Create a value of DisassociateLicenseResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DisassociateLicenseResponse'
, disassociateLicenseResponse_httpStatus
- The response's http status code.
$sel:workspace:DisassociateLicenseResponse'
, disassociateLicenseResponse_workspace
- A structure containing information about the workspace.
ListPermissions (Paginated)
data ListPermissions Source #
See: newListPermissions
smart constructor.
Instances
Create a value of ListPermissions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupId:ListPermissions'
, listPermissions_groupId
- (Optional) Limits the results to only the group that matches this ID.
$sel:maxResults:ListPermissions'
, listPermissions_maxResults
- The maximum number of results to include in the response.
ListPermissions
, listPermissions_nextToken
- The token to use when requesting the next set of results. You received
this token from a previous ListPermissions
operation.
$sel:userId:ListPermissions'
, listPermissions_userId
- (Optional) Limits the results to only the user that matches this ID.
$sel:userType:ListPermissions'
, listPermissions_userType
- (Optional) If you specify SSO_USER
, then only the permissions of IAM
Identity Center users are returned. If you specify SSO_GROUP
, only the
permissions of IAM Identity Center groups are returned.
$sel:workspaceId:ListPermissions'
, listPermissions_workspaceId
- The ID of the workspace to list permissions for. This parameter is
required.
data ListPermissionsResponse Source #
See: newListPermissionsResponse
smart constructor.
Instances
newListPermissionsResponse Source #
Create a value of ListPermissionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListPermissions
, listPermissionsResponse_nextToken
- The token to use in a subsequent ListPermissions
operation to return
the next set of results.
$sel:httpStatus:ListPermissionsResponse'
, listPermissionsResponse_httpStatus
- The response's http status code.
$sel:permissions:ListPermissionsResponse'
, listPermissionsResponse_permissions
- The permissions returned by the operation.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The ARN of the resource the list of tags are associated with.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResourceResponse
, listTagsForResourceResponse_tags
- The list of tags that are associated with the resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListWorkspaces (Paginated)
data ListWorkspaces Source #
See: newListWorkspaces
smart constructor.
Instances
newListWorkspaces :: ListWorkspaces Source #
Create a value of ListWorkspaces
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListWorkspaces'
, listWorkspaces_maxResults
- The maximum number of workspaces to include in the results.
ListWorkspaces
, listWorkspaces_nextToken
- The token for the next set of workspaces to return. (You receive this
token from a previous ListWorkspaces
operation.)
data ListWorkspacesResponse Source #
See: newListWorkspacesResponse
smart constructor.
Instances
newListWorkspacesResponse Source #
Create a value of ListWorkspacesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWorkspaces
, listWorkspacesResponse_nextToken
- The token to use when requesting the next set of workspaces.
$sel:httpStatus:ListWorkspacesResponse'
, listWorkspacesResponse_httpStatus
- The response's http status code.
$sel:workspaces:ListWorkspacesResponse'
, listWorkspacesResponse_workspaces
- An array of structures that contain some information about the
workspaces in the account.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource'
, tagResource_resourceArn
- The ARN of the resource the tag is associated with.
TagResource
, tagResource_tags
- 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.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource'
, untagResource_resourceArn
- The ARN of the resource the tag association is removed from.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The key values of the tag to be removed from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdatePermissions
data UpdatePermissions Source #
See: newUpdatePermissions
smart constructor.
Instances
Create a value of UpdatePermissions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:updateInstructionBatch:UpdatePermissions'
, updatePermissions_updateInstructionBatch
- An array of structures that contain the permission updates to make.
$sel:workspaceId:UpdatePermissions'
, updatePermissions_workspaceId
- The ID of the workspace to update.
data UpdatePermissionsResponse Source #
See: newUpdatePermissionsResponse
smart constructor.
Instances
newUpdatePermissionsResponse Source #
Create a value of UpdatePermissionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdatePermissionsResponse'
, updatePermissionsResponse_httpStatus
- The response's http status code.
$sel:errors:UpdatePermissionsResponse'
, updatePermissionsResponse_errors
- An array of structures that contain the errors from the operation, if
any.
UpdateWorkspace
data UpdateWorkspace Source #
See: newUpdateWorkspace
smart constructor.
UpdateWorkspace' (Maybe AccountAccessType) (Maybe (Sensitive Text)) (Maybe PermissionType) (Maybe Bool) (Maybe Text) (Maybe VpcConfiguration) (Maybe [DataSourceType]) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe [NotificationDestinationType]) (Maybe (Sensitive [Text])) (Maybe (Sensitive Text)) Text |
Instances
Create a value of UpdateWorkspace
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateWorkspace
, updateWorkspace_accountAccessType
- 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.
UpdateWorkspace
, updateWorkspace_organizationRoleName
- The name of an IAM role that already exists to use to access resources
through Organizations.
UpdateWorkspace
, updateWorkspace_permissionType
- 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
$sel:removeVpcConfiguration:UpdateWorkspace'
, updateWorkspace_removeVpcConfiguration
- Whether to remove the VPC configuration from the workspace.
Setting this to true
and providing a vpcConfiguration
to set will
return an error.
UpdateWorkspace
, updateWorkspace_stackSetName
- The name of the CloudFormation stack set to use to generate IAM roles to
be used for this workspace.
UpdateWorkspace
, updateWorkspace_vpcConfiguration
- The configuration settings for an Amazon VPC that contains data sources
for your Grafana workspace to connect to.
$sel:workspaceDataSources:UpdateWorkspace'
, updateWorkspace_workspaceDataSources
- 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.
$sel:workspaceDescription:UpdateWorkspace'
, updateWorkspace_workspaceDescription
- A description for the workspace. This is used only to help you identify
this workspace.
$sel:workspaceName:UpdateWorkspace'
, updateWorkspace_workspaceName
- A new name for the workspace to update.
$sel:workspaceNotificationDestinations:UpdateWorkspace'
, updateWorkspace_workspaceNotificationDestinations
- 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.
$sel:workspaceOrganizationalUnits:UpdateWorkspace'
, updateWorkspace_workspaceOrganizationalUnits
- 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.
UpdateWorkspace
, updateWorkspace_workspaceRoleArn
- 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.
$sel:workspaceId:UpdateWorkspace'
, updateWorkspace_workspaceId
- The ID of the workspace to update.
data UpdateWorkspaceResponse Source #
See: newUpdateWorkspaceResponse
smart constructor.
Instances
newUpdateWorkspaceResponse Source #
Create a value of UpdateWorkspaceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateWorkspaceResponse'
, updateWorkspaceResponse_httpStatus
- The response's http status code.
$sel:workspace:UpdateWorkspaceResponse'
, updateWorkspaceResponse_workspace
- A structure containing data about the workspace that was created.
UpdateWorkspaceAuthentication
data UpdateWorkspaceAuthentication Source #
See: newUpdateWorkspaceAuthentication
smart constructor.
Instances
newUpdateWorkspaceAuthentication Source #
Create a value of UpdateWorkspaceAuthentication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:samlConfiguration:UpdateWorkspaceAuthentication'
, updateWorkspaceAuthentication_samlConfiguration
- 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.
$sel:authenticationProviders:UpdateWorkspaceAuthentication'
, updateWorkspaceAuthentication_authenticationProviders
- Specifies whether this workspace uses SAML 2.0, IAM Identity Center
(successor to 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.
$sel:workspaceId:UpdateWorkspaceAuthentication'
, updateWorkspaceAuthentication_workspaceId
- The ID of the workspace to update the authentication for.
data UpdateWorkspaceAuthenticationResponse Source #
See: newUpdateWorkspaceAuthenticationResponse
smart constructor.
Instances
newUpdateWorkspaceAuthenticationResponse Source #
Create a value of UpdateWorkspaceAuthenticationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateWorkspaceAuthenticationResponse'
, updateWorkspaceAuthenticationResponse_httpStatus
- The response's http status code.
UpdateWorkspaceAuthenticationResponse
, updateWorkspaceAuthenticationResponse_authentication
- A structure that describes the user authentication for this workspace
after the update is made.
UpdateWorkspaceConfiguration
data UpdateWorkspaceConfiguration Source #
See: newUpdateWorkspaceConfiguration
smart constructor.
Instances
newUpdateWorkspaceConfiguration Source #
:: Text | |
-> Text | |
-> UpdateWorkspaceConfiguration |
Create a value of UpdateWorkspaceConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateWorkspaceConfiguration
, updateWorkspaceConfiguration_configuration
- The new configuration string for the workspace. For more information
about the format and configuration options available, see
Working in your Grafana workspace.
$sel:workspaceId:UpdateWorkspaceConfiguration'
, updateWorkspaceConfiguration_workspaceId
- The ID of the workspace to update.
data UpdateWorkspaceConfigurationResponse Source #
See: newUpdateWorkspaceConfigurationResponse
smart constructor.
Instances
Generic UpdateWorkspaceConfigurationResponse Source # | |
Defined in Amazonka.Grafana.UpdateWorkspaceConfiguration type Rep UpdateWorkspaceConfigurationResponse :: Type -> Type # | |
Read UpdateWorkspaceConfigurationResponse Source # | |
Show UpdateWorkspaceConfigurationResponse Source # | |
NFData UpdateWorkspaceConfigurationResponse Source # | |
Defined in Amazonka.Grafana.UpdateWorkspaceConfiguration rnf :: UpdateWorkspaceConfigurationResponse -> () # | |
Eq UpdateWorkspaceConfigurationResponse Source # | |
type Rep UpdateWorkspaceConfigurationResponse Source # | |
Defined in Amazonka.Grafana.UpdateWorkspaceConfiguration type Rep UpdateWorkspaceConfigurationResponse = D1 ('MetaData "UpdateWorkspaceConfigurationResponse" "Amazonka.Grafana.UpdateWorkspaceConfiguration" "amazonka-grafana-2.0-1hXXW2cgZWZJGJ3AoD5xOB" 'False) (C1 ('MetaCons "UpdateWorkspaceConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateWorkspaceConfigurationResponse Source #
Create a value of UpdateWorkspaceConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateWorkspaceConfigurationResponse'
, updateWorkspaceConfigurationResponse_httpStatus
- The response's http status code.
Types
AccountAccessType
newtype AccountAccessType Source #
pattern AccountAccessType_CURRENT_ACCOUNT :: AccountAccessType | |
pattern AccountAccessType_ORGANIZATION :: AccountAccessType |
Instances
AuthenticationProviderTypes
newtype AuthenticationProviderTypes Source #
pattern AuthenticationProviderTypes_AWS_SSO :: AuthenticationProviderTypes | |
pattern AuthenticationProviderTypes_SAML :: AuthenticationProviderTypes |
Instances
DataSourceType
newtype DataSourceType Source #
pattern DataSourceType_AMAZON_OPENSEARCH_SERVICE :: DataSourceType | |
pattern DataSourceType_ATHENA :: DataSourceType | |
pattern DataSourceType_CLOUDWATCH :: DataSourceType | |
pattern DataSourceType_PROMETHEUS :: DataSourceType | |
pattern DataSourceType_REDSHIFT :: DataSourceType | |
pattern DataSourceType_SITEWISE :: DataSourceType | |
pattern DataSourceType_TIMESTREAM :: DataSourceType | |
pattern DataSourceType_TWINMAKER :: DataSourceType | |
pattern DataSourceType_XRAY :: DataSourceType |
Instances
LicenseType
newtype LicenseType Source #
pattern LicenseType_ENTERPRISE :: LicenseType | |
pattern LicenseType_ENTERPRISE_FREE_TRIAL :: LicenseType |
Instances
NotificationDestinationType
newtype NotificationDestinationType Source #
Instances
PermissionType
newtype PermissionType Source #
pattern PermissionType_CUSTOMER_MANAGED :: PermissionType | |
pattern PermissionType_SERVICE_MANAGED :: PermissionType |
Instances
Role
pattern Role_ADMIN :: Role | |
pattern Role_EDITOR :: Role | |
pattern Role_VIEWER :: Role |
Instances
SamlConfigurationStatus
newtype SamlConfigurationStatus Source #
pattern SamlConfigurationStatus_CONFIGURED :: SamlConfigurationStatus | |
pattern SamlConfigurationStatus_NOT_CONFIGURED :: SamlConfigurationStatus |
Instances
UpdateAction
newtype UpdateAction Source #
pattern UpdateAction_ADD :: UpdateAction | |
pattern UpdateAction_REVOKE :: UpdateAction |
Instances
UserType
pattern UserType_SSO_GROUP :: UserType | |
pattern UserType_SSO_USER :: UserType |
Instances
WorkspaceStatus
newtype WorkspaceStatus Source #
pattern WorkspaceStatus_ACTIVE :: WorkspaceStatus | |
pattern WorkspaceStatus_CREATING :: WorkspaceStatus | |
pattern WorkspaceStatus_CREATION_FAILED :: WorkspaceStatus | |
pattern WorkspaceStatus_DELETING :: WorkspaceStatus | |
pattern WorkspaceStatus_DELETION_FAILED :: WorkspaceStatus | |
pattern WorkspaceStatus_FAILED :: WorkspaceStatus | |
pattern WorkspaceStatus_LICENSE_REMOVAL_FAILED :: WorkspaceStatus | |
pattern WorkspaceStatus_UPDATE_FAILED :: WorkspaceStatus | |
pattern WorkspaceStatus_UPDATING :: WorkspaceStatus | |
pattern WorkspaceStatus_UPGRADE_FAILED :: WorkspaceStatus | |
pattern WorkspaceStatus_UPGRADING :: WorkspaceStatus |
Instances
AssertionAttributes
data AssertionAttributes Source #
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.
See: newAssertionAttributes
smart constructor.
Instances
newAssertionAttributes :: AssertionAttributes Source #
Create a value of AssertionAttributes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:email:AssertionAttributes'
, assertionAttributes_email
- The name of the attribute within the SAML assertion to use as the email
names for SAML users.
$sel:groups:AssertionAttributes'
, assertionAttributes_groups
- The name of the attribute within the SAML assertion to use as the user
full "friendly" names for user groups.
$sel:login:AssertionAttributes'
, assertionAttributes_login
- The name of the attribute within the SAML assertion to use as the login
names for SAML users.
$sel:name:AssertionAttributes'
, assertionAttributes_name
- The name of the attribute within the SAML assertion to use as the user
full "friendly" names for SAML users.
$sel:org:AssertionAttributes'
, assertionAttributes_org
- The name of the attribute within the SAML assertion to use as the user
full "friendly" names for the users' organizations.
$sel:role':AssertionAttributes'
, assertionAttributes_role
- The name of the attribute within the SAML assertion to use as the user
roles.
AuthenticationDescription
data AuthenticationDescription Source #
A structure containing information about the user authentication methods used by the workspace.
See: newAuthenticationDescription
smart constructor.
AuthenticationDescription' (Maybe AwsSsoAuthentication) (Maybe SamlAuthentication) [AuthenticationProviderTypes] |
Instances
newAuthenticationDescription :: AuthenticationDescription Source #
Create a value of AuthenticationDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:awsSso:AuthenticationDescription'
, authenticationDescription_awsSso
- A structure containing information about how this workspace works with
IAM Identity Center.
$sel:saml:AuthenticationDescription'
, authenticationDescription_saml
- 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.
$sel:providers:AuthenticationDescription'
, authenticationDescription_providers
- Specifies whether this workspace uses IAM Identity Center, SAML, or both
methods to authenticate users to use the Grafana console in the Amazon
Managed Grafana workspace.
AuthenticationSummary
data AuthenticationSummary Source #
A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication, and whether that authentication is fully configured.
See: newAuthenticationSummary
smart constructor.
Instances
newAuthenticationSummary :: AuthenticationSummary Source #
Create a value of AuthenticationSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:samlConfigurationStatus:AuthenticationSummary'
, authenticationSummary_samlConfigurationStatus
- Specifies whether the workplace's user authentication method is fully
configured.
$sel:providers:AuthenticationSummary'
, authenticationSummary_providers
- Specifies whether the workspace uses SAML, IAM Identity Center, or both
methods for user authentication.
AwsSsoAuthentication
data AwsSsoAuthentication Source #
A structure containing information about how this workspace works with IAM Identity Center.
See: newAwsSsoAuthentication
smart constructor.
Instances
newAwsSsoAuthentication :: AwsSsoAuthentication Source #
Create a value of AwsSsoAuthentication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ssoClientId:AwsSsoAuthentication'
, awsSsoAuthentication_ssoClientId
- The ID of the IAM Identity Center-managed application that is created by
Amazon Managed Grafana.
IdpMetadata
data IdpMetadata Source #
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. Specifying both will cause an error.
See: newIdpMetadata
smart constructor.
IdpMetadata' (Maybe Text) (Maybe Text) |
Instances
newIdpMetadata :: IdpMetadata Source #
Create a value of IdpMetadata
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:url:IdpMetadata'
, idpMetadata_url
- The URL of the location containing the IdP metadata.
$sel:xml:IdpMetadata'
, idpMetadata_xml
- The full IdP metadata, in XML format.
PermissionEntry
data PermissionEntry Source #
A structure containing the identity of one user or group and the
Admin
, Editor
, or Viewer
role that they have.
See: newPermissionEntry
smart constructor.
Instances
Create a value of PermissionEntry
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:role':PermissionEntry'
, permissionEntry_role
- Specifies whether the user or group has the Admin
, Editor
, or
Viewer
role.
$sel:user:PermissionEntry'
, permissionEntry_user
- A structure with the ID of the user or group with this role.
RoleValues
data RoleValues Source #
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. SAML authenticated users not part of Admin
or Editor
role groups have Viewer
permission over the workspace.
See: newRoleValues
smart constructor.
RoleValues' (Maybe [Text]) (Maybe [Text]) |
Instances
newRoleValues :: RoleValues Source #
Create a value of RoleValues
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:admin:RoleValues'
, roleValues_admin
- A list of groups from the SAML assertion attribute to grant the Grafana
Admin
role to.
$sel:editor:RoleValues'
, roleValues_editor
- A list of groups from the SAML assertion attribute to grant the Grafana
Editor
role to.
SamlAuthentication
data SamlAuthentication Source #
A structure containing information about how this workspace works with SAML.
See: newSamlAuthentication
smart constructor.
Instances
newSamlAuthentication Source #
Create a value of SamlAuthentication
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configuration:SamlAuthentication'
, samlAuthentication_configuration
- A structure containing details about how this workspace works with SAML.
$sel:status:SamlAuthentication'
, samlAuthentication_status
- Specifies whether the workspace's SAML configuration is complete.
SamlConfiguration
data SamlConfiguration Source #
A structure containing information about how this workspace works with SAML.
See: newSamlConfiguration
smart constructor.
SamlConfiguration' (Maybe [Text]) (Maybe AssertionAttributes) (Maybe Int) (Maybe RoleValues) IdpMetadata |
Instances
Create a value of SamlConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowedOrganizations:SamlConfiguration'
, samlConfiguration_allowedOrganizations
- 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.
$sel:assertionAttributes:SamlConfiguration'
, samlConfiguration_assertionAttributes
- 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.
$sel:loginValidityDuration:SamlConfiguration'
, samlConfiguration_loginValidityDuration
- How long a sign-on session by a SAML user is valid, before the user has
to sign on again.
$sel:roleValues:SamlConfiguration'
, samlConfiguration_roleValues
- A structure containing arrays that map group names in the SAML assertion
to the Grafana Admin
and Editor
roles in the workspace.
$sel:idpMetadata:SamlConfiguration'
, samlConfiguration_idpMetadata
- A structure containing the identity provider (IdP) metadata used to
integrate the identity provider with this workspace.
UpdateError
data UpdateError Source #
A structure containing information about one error encountered while performing an UpdatePermissions operation.
See: newUpdateError
smart constructor.
Instances
:: UpdateInstruction | |
-> Natural | |
-> Text | |
-> UpdateError |
Create a value of UpdateError
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:causedBy:UpdateError'
, updateError_causedBy
- Specifies which permission update caused the error.
$sel:code:UpdateError'
, updateError_code
- The error code.
$sel:message:UpdateError'
, updateError_message
- The message for this error.
UpdateInstruction
data UpdateInstruction Source #
Contains the instructions for one Grafana role permission update in a UpdatePermissions operation.
See: newUpdateInstruction
smart constructor.
Instances
:: UpdateAction | |
-> Role | |
-> UpdateInstruction |
Create a value of UpdateInstruction
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:UpdateInstruction'
, updateInstruction_action
- Specifies whether this update is to add or revoke role permissions.
$sel:role':UpdateInstruction'
, updateInstruction_role
- The role to add or revoke for the user or the group specified in
users
.
$sel:users:UpdateInstruction'
, updateInstruction_users
- A structure that specifies the user or group to add or revoke the role
for.
User
A structure that specifies one user or group in the workspace.
See: newUser
smart constructor.
Instances
FromJSON User Source # | |
ToJSON User Source # | |
Defined in Amazonka.Grafana.Types.User | |
Generic User Source # | |
Read User Source # | |
Show User Source # | |
NFData User Source # | |
Defined in Amazonka.Grafana.Types.User | |
Eq User Source # | |
Hashable User Source # | |
Defined in Amazonka.Grafana.Types.User | |
type Rep User Source # | |
Defined in Amazonka.Grafana.Types.User type Rep User = D1 ('MetaData "User" "Amazonka.Grafana.Types.User" "amazonka-grafana-2.0-1hXXW2cgZWZJGJ3AoD5xOB" 'False) (C1 ('MetaCons "User'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserType))) |
Create a value of User
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:User'
, user_id
- 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}$
$sel:type':User'
, user_type
- Specifies whether this is a single user or a group.
VpcConfiguration
data VpcConfiguration Source #
The configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
See: newVpcConfiguration
smart constructor.
Instances
:: NonEmpty Text | |
-> NonEmpty Text | |
-> VpcConfiguration |
Create a value of VpcConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:securityGroupIds:VpcConfiguration'
, vpcConfiguration_securityGroupIds
- The list of Amazon EC2 security group IDs attached to the Amazon VPC for
your Grafana workspace to connect.
$sel:subnetIds:VpcConfiguration'
, vpcConfiguration_subnetIds
- The list of Amazon EC2 subnet IDs created in the Amazon VPC for your
Grafana workspace to connect.
WorkspaceDescription
data WorkspaceDescription Source #
A structure containing information about an Amazon Managed Grafana workspace in your account.
See: newWorkspaceDescription
smart constructor.
WorkspaceDescription' (Maybe AccountAccessType) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe POSIX) (Maybe POSIX) (Maybe LicenseType) (Maybe (Sensitive Text)) (Maybe [NotificationDestinationType]) (Maybe (Sensitive Text)) (Maybe (Sensitive [Text])) (Maybe PermissionType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe VpcConfiguration) (Maybe (Sensitive Text)) AuthenticationSummary POSIX [DataSourceType] Text Text Text POSIX WorkspaceStatus |
Instances
newWorkspaceDescription Source #
:: AuthenticationSummary | |
-> UTCTime | |
-> Text | |
-> Text | |
-> Text | |
-> UTCTime | |
-> WorkspaceStatus | |
-> WorkspaceDescription |
Create a value of WorkspaceDescription
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accountAccessType:WorkspaceDescription'
, workspaceDescription_accountAccessType
- 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.
$sel:description:WorkspaceDescription'
, workspaceDescription_description
- The user-defined description of the workspace.
$sel:freeTrialConsumed:WorkspaceDescription'
, workspaceDescription_freeTrialConsumed
- Specifies whether this workspace has already fully used its free trial
for Grafana Enterprise.
$sel:freeTrialExpiration:WorkspaceDescription'
, workspaceDescription_freeTrialExpiration
- If this workspace is currently in the free trial period for Grafana
Enterprise, this value specifies when that free trial ends.
$sel:licenseExpiration:WorkspaceDescription'
, workspaceDescription_licenseExpiration
- If this workspace has a full Grafana Enterprise license, this specifies
when the license ends and will need to be renewed.
$sel:licenseType:WorkspaceDescription'
, workspaceDescription_licenseType
- Specifies whether this workspace has a full Grafana Enterprise license
or a free trial license.
$sel:name:WorkspaceDescription'
, workspaceDescription_name
- The name of the workspace.
$sel:notificationDestinations:WorkspaceDescription'
, workspaceDescription_notificationDestinations
- 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.
$sel:organizationRoleName:WorkspaceDescription'
, workspaceDescription_organizationRoleName
- The name of the IAM role that is used to access resources through
Organizations.
$sel:organizationalUnits:WorkspaceDescription'
, workspaceDescription_organizationalUnits
- 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.
$sel:permissionType:WorkspaceDescription'
, workspaceDescription_permissionType
- 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
$sel:stackSetName:WorkspaceDescription'
, workspaceDescription_stackSetName
- The name of the CloudFormation stack set that is used to generate IAM
roles to be used for this workspace.
$sel:tags:WorkspaceDescription'
, workspaceDescription_tags
- The list of tags associated with the workspace.
$sel:vpcConfiguration:WorkspaceDescription'
, workspaceDescription_vpcConfiguration
- The configuration for connecting to data sources in a private VPC
(Amazon Virtual Private Cloud).
$sel:workspaceRoleArn:WorkspaceDescription'
, workspaceDescription_workspaceRoleArn
- The IAM role that grants permissions to the Amazon Web Services
resources that the workspace will view data from. This role must already
exist.
$sel:authentication:WorkspaceDescription'
, workspaceDescription_authentication
- A structure that describes whether the workspace uses SAML, IAM Identity
Center, or both methods for user authentication.
$sel:created:WorkspaceDescription'
, workspaceDescription_created
- The date that the workspace was created.
$sel:dataSources:WorkspaceDescription'
, workspaceDescription_dataSources
- 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.
$sel:endpoint:WorkspaceDescription'
, workspaceDescription_endpoint
- The URL that users can use to access the Grafana console in the
workspace.
$sel:grafanaVersion:WorkspaceDescription'
, workspaceDescription_grafanaVersion
- The version of Grafana supported in this workspace.
$sel:id:WorkspaceDescription'
, workspaceDescription_id
- The unique ID of this workspace.
$sel:modified:WorkspaceDescription'
, workspaceDescription_modified
- The most recent date that the workspace was modified.
$sel:status:WorkspaceDescription'
, workspaceDescription_status
- The current status of the workspace.
WorkspaceSummary
data WorkspaceSummary Source #
A structure that contains some information about one workspace in the account.
See: newWorkspaceSummary
smart constructor.
WorkspaceSummary' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe [NotificationDestinationType]) (Maybe (HashMap Text Text)) AuthenticationSummary POSIX Text Text Text POSIX WorkspaceStatus |
Instances
:: AuthenticationSummary | |
-> UTCTime | |
-> Text | |
-> Text | |
-> Text | |
-> UTCTime | |
-> WorkspaceStatus | |
-> WorkspaceSummary |
Create a value of WorkspaceSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:WorkspaceSummary'
, workspaceSummary_description
- The customer-entered description of the workspace.
$sel:name:WorkspaceSummary'
, workspaceSummary_name
- The name of the workspace.
$sel:notificationDestinations:WorkspaceSummary'
, workspaceSummary_notificationDestinations
- 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.
$sel:tags:WorkspaceSummary'
, workspaceSummary_tags
- The list of tags associated with the workspace.
$sel:authentication:WorkspaceSummary'
, workspaceSummary_authentication
- A structure containing information about the authentication methods used
in the workspace.
$sel:created:WorkspaceSummary'
, workspaceSummary_created
- The date that the workspace was created.
$sel:endpoint:WorkspaceSummary'
, workspaceSummary_endpoint
- The URL endpoint to use to access the Grafana console in the workspace.
$sel:grafanaVersion:WorkspaceSummary'
, workspaceSummary_grafanaVersion
- The Grafana version that the workspace is running.
$sel:id:WorkspaceSummary'
, workspaceSummary_id
- The unique ID of the workspace.
$sel:modified:WorkspaceSummary'
, workspaceSummary_modified
- The most recent date that the workspace was modified.
$sel:status:WorkspaceSummary'
, workspaceSummary_status
- The current status of the workspace.