Struct aws_sdk_grafana::Client
source · pub struct Client { /* private fields */ }
Expand description
Client for Amazon Managed Grafana
Client for invoking operations on Amazon Managed Grafana. Each operation on Amazon Managed Grafana is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_grafana::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Config
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_grafana::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the ListTagsForResource
operation has
a Client::list_tags_for_resource
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.list_tags_for_resource()
.resource_arn("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
source§impl Client
impl Client
sourcepub fn associate_license(&self) -> AssociateLicenseFluentBuilder
pub fn associate_license(&self) -> AssociateLicenseFluentBuilder
Constructs a fluent builder for the AssociateLicense
operation.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe ID of the workspace to associate the license with.
license_type(LicenseType)
/set_license_type(Option<LicenseType>)
:
required: trueThe type of license to associate with the workspace.
Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials.
grafana_token(impl Into<String>)
/set_grafana_token(Option<String>)
:
required: falseA token from Grafana Labs that ties your Amazon Web Services account with a Grafana Labs account. For more information, see Register with Grafana Labs.
- On success, responds with
AssociateLicenseOutput
with field(s):workspace(Option<WorkspaceDescription>)
:A structure containing data about the workspace.
- On failure, responds with
SdkError<AssociateLicenseError>
source§impl Client
impl Client
sourcepub fn create_workspace(&self) -> CreateWorkspaceFluentBuilder
pub fn create_workspace(&self) -> CreateWorkspaceFluentBuilder
Constructs a fluent builder for the CreateWorkspace
operation.
- The fluent builder is configurable:
account_access_type(AccountAccessType)
/set_account_access_type(Option<AccountAccessType>)
:
required: trueSpecifies 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 theworkspaceOrganizationalUnits
parameter.client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
organization_role_name(impl Into<String>)
/set_organization_role_name(Option<String>)
:
required: falseThe 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.
permission_type(PermissionType)
/set_permission_type(Option<PermissionType>)
:
required: trueWhen creating a workspace through the Amazon Web Services API, CLI or Amazon Web Services CloudFormation, you must manage IAM roles and provision the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.
You must also specify a
workspaceRoleArn
for a role that you will manage for the workspace to use when accessing those datasources and notification channels.The ability for Amazon Managed Grafana to create and update IAM roles on behalf of the user is supported only in the Amazon Managed Grafana console, where this value may be set to
SERVICE_MANAGED
.Use only the
CUSTOMER_MANAGED
permission type when creating a workspace with the API, CLI or Amazon Web Services CloudFormation.For more information, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels.
stack_set_name(impl Into<String>)
/set_stack_set_name(Option<String>)
:
required: falseThe name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
workspace_data_sources(DataSourceType)
/set_workspace_data_sources(Option<Vec::<DataSourceType>>)
:
required: falseThis parameter is for internal use only, and should not be used.
workspace_description(impl Into<String>)
/set_workspace_description(Option<String>)
:
required: falseA 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}$
workspace_name(impl Into<String>)
/set_workspace_name(Option<String>)
:
required: falseThe name for the workspace. It does not have to be unique.
workspace_notification_destinations(NotificationDestinationType)
/set_workspace_notification_destinations(Option<Vec::<NotificationDestinationType>>)
:
required: falseSpecify 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.
workspace_organizational_units(impl Into<String>)
/set_workspace_organizational_units(Option<Vec::<String>>)
:
required: falseSpecifies 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.
workspace_role_arn(impl Into<String>)
/set_workspace_role_arn(Option<String>)
:
required: falseSpecified the IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from, including both data sources and notification channels. You are responsible for managing the permissions for this role as new data sources or notification channels are added.
authentication_providers(AuthenticationProviderTypes)
/set_authentication_providers(Option<Vec::<AuthenticationProviderTypes>>)
:
required: trueSpecifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseThe list of tags associated with the workspace.
vpc_configuration(VpcConfiguration)
/set_vpc_configuration(Option<VpcConfiguration>)
:
required: falseThe configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
Connecting to a private VPC is not yet available in the Asia Pacific (Seoul) Region (ap-northeast-2).
configuration(impl Into<String>)
/set_configuration(Option<String>)
:
required: falseThe configuration string for the workspace that you create. For more information about the format and configuration options available, see Working in your Grafana workspace.
network_access_control(NetworkAccessConfiguration)
/set_network_access_control(Option<NetworkAccessConfiguration>)
:
required: falseConfiguration for network access to your workspace.
When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.
If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.
grafana_version(impl Into<String>)
/set_grafana_version(Option<String>)
:
required: falseSpecifies the version of Grafana to support in the new workspace. If not specified, defaults to the latest version (for example, 9.4).
To get a list of supported versions, use the
ListVersions
operation.
- On success, responds with
CreateWorkspaceOutput
with field(s):workspace(Option<WorkspaceDescription>)
:A structure containing data about the workspace that was created.
- On failure, responds with
SdkError<CreateWorkspaceError>
source§impl Client
impl Client
sourcepub fn create_workspace_api_key(&self) -> CreateWorkspaceApiKeyFluentBuilder
pub fn create_workspace_api_key(&self) -> CreateWorkspaceApiKeyFluentBuilder
Constructs a fluent builder for the CreateWorkspaceApiKey
operation.
- The fluent builder is configurable:
key_name(impl Into<String>)
/set_key_name(Option<String>)
:
required: trueSpecifies the name of the key. Keynames must be unique to the workspace.
key_role(impl Into<String>)
/set_key_role(Option<String>)
:
required: trueSpecifies the permission level of the key.
Valid values:
VIEWER
|EDITOR
|ADMIN
seconds_to_live(i32)
/set_seconds_to_live(Option<i32>)
:
required: trueSpecifies the time in seconds until the key expires. Keys can be valid for up to 30 days.
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe ID of the workspace to create an API key.
- On success, responds with
CreateWorkspaceApiKeyOutput
with field(s):key_name(String)
:The name of the key that was created.
key(String)
:The key token. Use this value as a bearer token to authenticate HTTP requests to the workspace.
workspace_id(String)
:The ID of the workspace that the key is valid for.
- On failure, responds with
SdkError<CreateWorkspaceApiKeyError>
source§impl Client
impl Client
sourcepub fn delete_workspace(&self) -> DeleteWorkspaceFluentBuilder
pub fn delete_workspace(&self) -> DeleteWorkspaceFluentBuilder
Constructs a fluent builder for the DeleteWorkspace
operation.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe ID of the workspace to delete.
- On success, responds with
DeleteWorkspaceOutput
with field(s):workspace(Option<WorkspaceDescription>)
:A structure containing information about the workspace that was deleted.
- On failure, responds with
SdkError<DeleteWorkspaceError>
source§impl Client
impl Client
sourcepub fn delete_workspace_api_key(&self) -> DeleteWorkspaceApiKeyFluentBuilder
pub fn delete_workspace_api_key(&self) -> DeleteWorkspaceApiKeyFluentBuilder
Constructs a fluent builder for the DeleteWorkspaceApiKey
operation.
- The fluent builder is configurable:
key_name(impl Into<String>)
/set_key_name(Option<String>)
:
required: trueThe name of the API key to delete.
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe ID of the workspace to delete.
- On success, responds with
DeleteWorkspaceApiKeyOutput
with field(s):key_name(String)
:The name of the key that was deleted.
workspace_id(String)
:The ID of the workspace where the key was deleted.
- On failure, responds with
SdkError<DeleteWorkspaceApiKeyError>
source§impl Client
impl Client
sourcepub fn describe_workspace(&self) -> DescribeWorkspaceFluentBuilder
pub fn describe_workspace(&self) -> DescribeWorkspaceFluentBuilder
Constructs a fluent builder for the DescribeWorkspace
operation.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe ID of the workspace to display information about.
- On success, responds with
DescribeWorkspaceOutput
with field(s):workspace(Option<WorkspaceDescription>)
:A structure containing information about the workspace.
- On failure, responds with
SdkError<DescribeWorkspaceError>
source§impl Client
impl Client
sourcepub fn describe_workspace_authentication(
&self
) -> DescribeWorkspaceAuthenticationFluentBuilder
pub fn describe_workspace_authentication( &self ) -> DescribeWorkspaceAuthenticationFluentBuilder
Constructs a fluent builder for the DescribeWorkspaceAuthentication
operation.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe ID of the workspace to return authentication information about.
- On success, responds with
DescribeWorkspaceAuthenticationOutput
with field(s):authentication(Option<AuthenticationDescription>)
:A structure containing information about the authentication methods used in the workspace.
- On failure, responds with
SdkError<DescribeWorkspaceAuthenticationError>
source§impl Client
impl Client
sourcepub fn describe_workspace_configuration(
&self
) -> DescribeWorkspaceConfigurationFluentBuilder
pub fn describe_workspace_configuration( &self ) -> DescribeWorkspaceConfigurationFluentBuilder
Constructs a fluent builder for the DescribeWorkspaceConfiguration
operation.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe ID of the workspace to get configuration information for.
- On success, responds with
DescribeWorkspaceConfigurationOutput
with field(s):configuration(String)
: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.
grafana_version(Option<String>)
:The supported Grafana version for the workspace.
- On failure, responds with
SdkError<DescribeWorkspaceConfigurationError>
source§impl Client
impl Client
sourcepub fn disassociate_license(&self) -> DisassociateLicenseFluentBuilder
pub fn disassociate_license(&self) -> DisassociateLicenseFluentBuilder
Constructs a fluent builder for the DisassociateLicense
operation.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe ID of the workspace to remove the Grafana Enterprise license from.
license_type(LicenseType)
/set_license_type(Option<LicenseType>)
:
required: trueThe type of license to remove from the workspace.
- On success, responds with
DisassociateLicenseOutput
with field(s):workspace(Option<WorkspaceDescription>)
:A structure containing information about the workspace.
- On failure, responds with
SdkError<DisassociateLicenseError>
source§impl Client
impl Client
sourcepub fn list_permissions(&self) -> ListPermissionsFluentBuilder
pub fn list_permissions(&self) -> ListPermissionsFluentBuilder
Constructs a fluent builder for the ListPermissions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to include in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to use when requesting the next set of results. You received this token from a previous
ListPermissions
operation.user_type(UserType)
/set_user_type(Option<UserType>)
:
required: false(Optional) If you specify
SSO_USER
, then only the permissions of IAM Identity Center users are returned. If you specifySSO_GROUP
, only the permissions of IAM Identity Center groups are returned.user_id(impl Into<String>)
/set_user_id(Option<String>)
:
required: false(Optional) Limits the results to only the user that matches this ID.
group_id(impl Into<String>)
/set_group_id(Option<String>)
:
required: false(Optional) Limits the results to only the group that matches this ID.
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe ID of the workspace to list permissions for. This parameter is required.
- On success, responds with
ListPermissionsOutput
with field(s):next_token(Option<String>)
:The token to use in a subsequent
ListPermissions
operation to return the next set of results.permissions(Vec::<PermissionEntry>)
:The permissions returned by the operation.
- On failure, responds with
SdkError<ListPermissionsError>
source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource the list of tags are associated with.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:The list of tags that are associated with the resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
source§impl Client
impl Client
sourcepub fn list_versions(&self) -> ListVersionsFluentBuilder
pub fn list_versions(&self) -> ListVersionsFluentBuilder
Constructs a fluent builder for the ListVersions
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to include in the response.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token to use when requesting the next set of results. You receive this token from a previous
ListVersions
operation.workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: falseThe ID of the workspace to list the available upgrade versions. If not included, lists all versions of Grafana that are supported for
CreateWorkspace
.
- On success, responds with
ListVersionsOutput
with field(s):next_token(Option<String>)
:The token to use in a subsequent
ListVersions
operation to return the next set of results.grafana_versions(Option<Vec::<String>>)
:The Grafana versions available to create. If a workspace ID is included in the request, the Grafana versions to which this workspace can be upgraded.
- On failure, responds with
SdkError<ListVersionsError>
source§impl Client
impl Client
sourcepub fn list_workspaces(&self) -> ListWorkspacesFluentBuilder
pub fn list_workspaces(&self) -> ListWorkspacesFluentBuilder
Constructs a fluent builder for the ListWorkspaces
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of workspaces to include in the results.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseThe token for the next set of workspaces to return. (You receive this token from a previous
ListWorkspaces
operation.)
- On success, responds with
ListWorkspacesOutput
with field(s):workspaces(Vec::<WorkspaceSummary>)
:An array of structures that contain some information about the workspaces in the account.
next_token(Option<String>)
:The token to use when requesting the next set of workspaces.
- On failure, responds with
SdkError<ListWorkspacesError>
source§impl Client
impl Client
sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource the tag is associated with.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueThe 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.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
source§impl Client
impl Client
sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe ARN of the resource the tag association is removed from.
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe key values of the tag to be removed from the resource.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
source§impl Client
impl Client
sourcepub fn update_permissions(&self) -> UpdatePermissionsFluentBuilder
pub fn update_permissions(&self) -> UpdatePermissionsFluentBuilder
Constructs a fluent builder for the UpdatePermissions
operation.
- The fluent builder is configurable:
update_instruction_batch(UpdateInstruction)
/set_update_instruction_batch(Option<Vec::<UpdateInstruction>>)
:
required: trueAn array of structures that contain the permission updates to make.
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe ID of the workspace to update.
- On success, responds with
UpdatePermissionsOutput
with field(s):errors(Vec::<UpdateError>)
:An array of structures that contain the errors from the operation, if any.
- On failure, responds with
SdkError<UpdatePermissionsError>
source§impl Client
impl Client
sourcepub fn update_workspace(&self) -> UpdateWorkspaceFluentBuilder
pub fn update_workspace(&self) -> UpdateWorkspaceFluentBuilder
Constructs a fluent builder for the UpdateWorkspace
operation.
- The fluent builder is configurable:
account_access_type(AccountAccessType)
/set_account_access_type(Option<AccountAccessType>)
:
required: falseSpecifies 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 theworkspaceOrganizationalUnits
parameter.organization_role_name(impl Into<String>)
/set_organization_role_name(Option<String>)
:
required: falseThe name of an IAM role that already exists to use to access resources through Organizations. This can only be used with a workspace that has the
permissionType
set toCUSTOMER_MANAGED
.permission_type(PermissionType)
/set_permission_type(Option<PermissionType>)
:
required: falseUse this parameter if you want to change a workspace from
SERVICE_MANAGED
toCUSTOMER_MANAGED
. This allows you to manage the permissions that the workspace uses to access datasources and notification channels. If the workspace is in a member Amazon Web Services 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 chooseCUSTOMER_MANAGED
.If you specify this as
CUSTOMER_MANAGED
, you must also specify aworkspaceRoleArn
that the workspace will use for accessing Amazon Web Services resources.For more information on the role and permissions needed, see Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels
Do not use this to convert a
CUSTOMER_MANAGED
workspace toSERVICE_MANAGED
. Do not include this parameter if you want to leave the workspace asSERVICE_MANAGED
.You can convert a
CUSTOMER_MANAGED
workspace toSERVICE_MANAGED
using the Amazon Managed Grafana console. For more information, see Managing permissions for data sources and notification channels.stack_set_name(impl Into<String>)
/set_stack_set_name(Option<String>)
:
required: falseThe name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.
workspace_data_sources(DataSourceType)
/set_workspace_data_sources(Option<Vec::<DataSourceType>>)
:
required: falseThis parameter is for internal use only, and should not be used.
workspace_description(impl Into<String>)
/set_workspace_description(Option<String>)
:
required: falseA description for the workspace. This is used only to help you identify this workspace.
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe ID of the workspace to update.
workspace_name(impl Into<String>)
/set_workspace_name(Option<String>)
:
required: falseA new name for the workspace to update.
workspace_notification_destinations(NotificationDestinationType)
/set_workspace_notification_destinations(Option<Vec::<NotificationDestinationType>>)
:
required: falseSpecify 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.
workspace_organizational_units(impl Into<String>)
/set_workspace_organizational_units(Option<Vec::<String>>)
:
required: falseSpecifies 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.
workspace_role_arn(impl Into<String>)
/set_workspace_role_arn(Option<String>)
:
required: falseSpecifies an IAM role that grants permissions to Amazon Web Services resources that the workspace accesses, such as data sources and notification channels. If this workspace has
permissionType
CUSTOMER_MANAGED
, then this role is required.vpc_configuration(VpcConfiguration)
/set_vpc_configuration(Option<VpcConfiguration>)
:
required: falseThe configuration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to.
remove_vpc_configuration(bool)
/set_remove_vpc_configuration(Option<bool>)
:
required: falseWhether to remove the VPC configuration from the workspace.
Setting this to
true
and providing avpcConfiguration
to set will return an error.network_access_control(NetworkAccessConfiguration)
/set_network_access_control(Option<NetworkAccessConfiguration>)
:
required: falseThe configuration settings for network access to your workspace.
When this is configured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization will still be required.
If this is not configured, or is removed, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.
remove_network_access_configuration(bool)
/set_remove_network_access_configuration(Option<bool>)
:
required: falseWhether to remove the network access configuration from the workspace.
Setting this to
true
and providing anetworkAccessControl
to set will return an error.If you remove this configuration by setting this to
true
, then all IP addresses and VPC endpoints will be allowed. Standard Grafana authentication and authorization will still be required.
- On success, responds with
UpdateWorkspaceOutput
with field(s):workspace(Option<WorkspaceDescription>)
:A structure containing data about the workspace that was created.
- On failure, responds with
SdkError<UpdateWorkspaceError>
source§impl Client
impl Client
sourcepub fn update_workspace_authentication(
&self
) -> UpdateWorkspaceAuthenticationFluentBuilder
pub fn update_workspace_authentication( &self ) -> UpdateWorkspaceAuthenticationFluentBuilder
Constructs a fluent builder for the UpdateWorkspaceAuthentication
operation.
- The fluent builder is configurable:
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe ID of the workspace to update the authentication for.
authentication_providers(AuthenticationProviderTypes)
/set_authentication_providers(Option<Vec::<AuthenticationProviderTypes>>)
:
required: trueSpecifies whether this workspace uses SAML 2.0, IAM Identity Center, or both to authenticate users for using the Grafana console within a workspace. For more information, see User authentication in Amazon Managed Grafana.
saml_configuration(SamlConfiguration)
/set_saml_configuration(Option<SamlConfiguration>)
:
required: falseIf 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
andEditor
roles in the workspace.
- On success, responds with
UpdateWorkspaceAuthenticationOutput
with field(s):authentication(Option<AuthenticationDescription>)
:A structure that describes the user authentication for this workspace after the update is made.
- On failure, responds with
SdkError<UpdateWorkspaceAuthenticationError>
source§impl Client
impl Client
sourcepub fn update_workspace_configuration(
&self
) -> UpdateWorkspaceConfigurationFluentBuilder
pub fn update_workspace_configuration( &self ) -> UpdateWorkspaceConfigurationFluentBuilder
Constructs a fluent builder for the UpdateWorkspaceConfiguration
operation.
- The fluent builder is configurable:
configuration(impl Into<String>)
/set_configuration(Option<String>)
:
required: trueThe new configuration string for the workspace. For more information about the format and configuration options available, see Working in your Grafana workspace.
workspace_id(impl Into<String>)
/set_workspace_id(Option<String>)
:
required: trueThe ID of the workspace to update.
grafana_version(impl Into<String>)
/set_grafana_version(Option<String>)
:
required: falseSpecifies the version of Grafana to support in the workspace. If not specified, keeps the current version of the workspace.
Can only be used to upgrade (for example, from 8.4 to 9.4), not downgrade (for example, from 9.4 to 8.4).
To know what versions are available to upgrade to for a specific workspace, see the ListVersions operation.
- On success, responds with
UpdateWorkspaceConfigurationOutput
- On failure, responds with
SdkError<UpdateWorkspaceConfigurationError>
source§impl Client
impl Client
sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
source§impl Client
impl Client
sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more