Struct WorkspaceDescription

#[non_exhaustive]
pub struct WorkspaceDescription {
    pub workspace_id: String,
    pub alias: Option<String>,
    pub arn: String,
    pub status: Option<WorkspaceStatus>,
    pub prometheus_endpoint: Option<String>,
    pub created_at: DateTime,
    pub tags: Option<HashMap<String, String>>,
    pub kms_key_arn: Option<String>,
}

The full details about one Amazon Managed Service for Prometheus workspace in your account.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

workspace_id: String

The unique ID for the workspace. For example, ws-example1-1234-abcd-5678-ef90abcd1234.

alias: Option<String>

The alias that is assigned to this workspace to help identify it. It does not need to be unique.

arn: String

The ARN of the workspace. For example, arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234.

status: Option<WorkspaceStatus>

The current status of the workspace.

prometheus_endpoint: Option<String>

The Prometheus endpoint available for this workspace. For example, https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/.

created_at: DateTime

The date and time that the workspace was created.

tags: Option<HashMap<String, String>>

The list of tag keys and values that are associated with the workspace.

kms_key_arn: Option<String>

(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

Implementations

impl WorkspaceDescription

pub fn workspace_id(&self) -> &str

The unique ID for the workspace. For example, ws-example1-1234-abcd-5678-ef90abcd1234.

pub fn alias(&self) -> Option<&str>

The alias that is assigned to this workspace to help identify it. It does not need to be unique.

pub fn arn(&self) -> &str

The ARN of the workspace. For example, arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234.

pub fn status(&self) -> Option<&WorkspaceStatus>

The current status of the workspace.

pub fn prometheus_endpoint(&self) -> Option<&str>

The Prometheus endpoint available for this workspace. For example, https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/.

pub fn created_at(&self) -> &DateTime

The date and time that the workspace was created.

pub fn tags(&self) -> Option<&HashMap<String, String>>

The list of tag keys and values that are associated with the workspace.

pub fn kms_key_arn(&self) -> Option<&str>

(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

impl WorkspaceDescription

pub fn builder() -> WorkspaceDescriptionBuilder

Creates a new builder-style object to manufacture WorkspaceDescription.

Trait Implementations

impl Clone for WorkspaceDescription

fn clone(&self) -> WorkspaceDescription

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WorkspaceDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for WorkspaceDescription

fn eq(&self, other: &WorkspaceDescription) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WorkspaceDescription