Updates the alias of an existing workspace.
Parameters:
-
workspace_id
(WorkspaceId)
–
The ID of the workspace to update.
-
alias
(Optional[WorkspaceAlias], default:
None
)
–
The new alias for the workspace. It does not need to be unique.
Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.
-
client_token
(Optional[IdempotencyToken], default:
None
)
–
A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
Raises:
Source code in docs_src/capo_amp/_services/async_amp.py
| async def update_workspace_alias(
self,
workspace_id: "capo_amp.types.workspace_id.WorkspaceId",
*,
config_overrides: Optional[AsyncampClientConfig] = None,
alias: Optional["capo_amp.types.workspace_alias.WorkspaceAlias"] = None,
client_token: Optional[
"capo_amp.types.idempotency_token.IdempotencyToken"
] = None,
) -> None:
"""<p>Updates the alias of an existing workspace. </p>
Args:
workspace_id: <p>The ID of the workspace to update.</p>
alias: <p>The new alias for the workspace. It does not need to be unique.</p> <p>Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.</p>
client_token: <p>A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.</p>
Raises:
capo_amp.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
capo_amp.errors.conflict_exception.ConflictException: <p>The request would cause an inconsistent state.</p>
capo_amp.errors.internal_server_exception.InternalServerException: <p>An unexpected error occurred during the processing of the request.</p>
capo_amp.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request references a resources that doesn't exist.</p>
capo_amp.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>Completing the request would cause a service quota to be exceeded.</p>
capo_amp.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_amp.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
capo_amp.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_amp.types.update_workspace_alias_request.UpdateWorkspaceAliasRequest]",
) -> AsyncOperationResponse[None]:
import capo_amp._operations.amazon_prometheus_service.update_workspace_alias
(
output,
http_response,
) = await capo_amp._operations.amazon_prometheus_service.update_workspace_alias.async_update_workspace_alias(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("UpdateWorkspaceAlias")
)
input_: capo_amp.types.update_workspace_alias_request.UpdateWorkspaceAliasRequest = {
"workspace_id": workspace_id
}
if alias is not None:
input_["alias"] = alias
if client_token is None:
client_token = str(uuid.uuid4())
input_["client_token"] = client_token
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|