types

package
v1.28.0 Latest Latest
Warning

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

 Go to latest Published: Sep 20, 2024 License: Apache-2.0 Imports: 4 Imported by: 8

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AlertManagerDefinitionDescription added in v1.6.0 

type AlertManagerDefinitionDescription struct {

	// The date and time that the alert manager definition was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The actual alert manager definition.
	//
	// For details about the alert manager definition, see [AlertManagedDefinitionData].
	//
	// [AlertManagedDefinitionData]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html
	//
	// This member is required.
	Data []byte

	// The date and time that the alert manager definition was most recently changed.
	//
	// This member is required.
	ModifiedAt *time.Time

	// A structure that displays the current status of the alert manager definition..
	//
	// This member is required.
	Status *AlertManagerDefinitionStatus
	// contains filtered or unexported fields
}

The details of an alert manager definition.

type AlertManagerDefinitionStatus added in v1.6.0 

type AlertManagerDefinitionStatus struct {

	// The current status of the alert manager.
	//
	// This member is required.
	StatusCode AlertManagerDefinitionStatusCode

	// If there is a failure, the reason for the failure.
	StatusReason *string
	// contains filtered or unexported fields
}

The status of the alert manager.

type AlertManagerDefinitionStatusCode added in v1.6.0 

type AlertManagerDefinitionStatusCode string
const (
	// Definition is being created. Update/Deletion is disallowed until definition is
	// ACTIVE and workspace status is ACTIVE.
	AlertManagerDefinitionStatusCodeCreating AlertManagerDefinitionStatusCode = "CREATING"
	// Definition has been created/updated. Update/Deletion is disallowed until
	// definition is ACTIVE and workspace status is ACTIVE.
	AlertManagerDefinitionStatusCodeActive AlertManagerDefinitionStatusCode = "ACTIVE"
	// Definition is being updated. Update/Deletion is disallowed until definition is
	// ACTIVE and workspace status is ACTIVE.
	AlertManagerDefinitionStatusCodeUpdating AlertManagerDefinitionStatusCode = "UPDATING"
	// Definition is being deleting. Update/Deletion is disallowed until definition is
	// ACTIVE and workspace status is ACTIVE.
	AlertManagerDefinitionStatusCodeDeleting AlertManagerDefinitionStatusCode = "DELETING"
	// Definition creation failed.
	AlertManagerDefinitionStatusCodeCreationFailed AlertManagerDefinitionStatusCode = "CREATION_FAILED"
	// Definition update failed.
	AlertManagerDefinitionStatusCodeUpdateFailed AlertManagerDefinitionStatusCode = "UPDATE_FAILED"
)

Enum values for AlertManagerDefinitionStatusCode

func (AlertManagerDefinitionStatusCode) Values added in v1.6.0 

func (AlertManagerDefinitionStatusCode) Values() []AlertManagerDefinitionStatusCode

Values returns all known values for AlertManagerDefinitionStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AmpConfiguration added in v1.20.0 

type AmpConfiguration struct {

	// ARN of the Amazon Managed Service for Prometheus workspace.
	//
	// This member is required.
	WorkspaceArn *string
	// contains filtered or unexported fields
}

The AmpConfiguration structure defines the Amazon Managed Service for Prometheus instance a scraper should send metrics to.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The request would cause an inconsistent state.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type Destination added in v1.20.0 

type Destination interface {
	// contains filtered or unexported methods
}

Where to send the metrics from a scraper.

The following types satisfy this interface: 

DestinationMemberAmpConfiguration
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/amp/types"
)

func main() {
	var union types.Destination
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.DestinationMemberAmpConfiguration:
		_ = v.Value // Value is types.AmpConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type DestinationMemberAmpConfiguration added in v1.20.0 

type DestinationMemberAmpConfiguration struct {
	Value AmpConfiguration
	// contains filtered or unexported fields
}

The Amazon Managed Service for Prometheusworkspace to send metrics to.

type EksConfiguration added in v1.20.0 

type EksConfiguration struct {

	// ARN of the Amazon EKS cluster.
	//
	// This member is required.
	ClusterArn *string

	// A list of subnet IDs for the Amazon EKS cluster VPC configuration.
	//
	// This member is required.
	SubnetIds []string

	// A list of the security group IDs for the Amazon EKS cluster VPC configuration.
	SecurityGroupIds []string
	// contains filtered or unexported fields
}

The EksConfiguration structure describes the connection to the Amazon EKS cluster from which a scraper collects metrics.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

An unexpected error occurred during the processing of the request.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type LoggingConfigurationMetadata added in v1.15.0 

type LoggingConfigurationMetadata struct {

	// The date and time that the logging configuration was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The ARN of the CloudWatch log group to which the vended log data will be
	// published.
	//
	// This member is required.
	LogGroupArn *string

	// The date and time that the logging configuration was most recently changed.
	//
	// This member is required.
	ModifiedAt *time.Time

	// The current status of the logging configuration.
	//
	// This member is required.
	Status *LoggingConfigurationStatus

	// The ID of the workspace the logging configuration is for.
	//
	// This member is required.
	Workspace *string
	// contains filtered or unexported fields
}

Contains information about the logging configuration.

type LoggingConfigurationStatus added in v1.15.0 

type LoggingConfigurationStatus struct {

	// The current status of the logging configuration.
	//
	// This member is required.
	StatusCode LoggingConfigurationStatusCode

	// If failed, the reason for the failure.
	StatusReason *string
	// contains filtered or unexported fields
}

The status of the logging configuration.

type LoggingConfigurationStatusCode added in v1.15.0 

type LoggingConfigurationStatusCode string
const (
	// Logging configuration is being created. Update/Deletion is disallowed until
	// logging configuration is ACTIVE and workspace status is ACTIVE.
	LoggingConfigurationStatusCodeCreating LoggingConfigurationStatusCode = "CREATING"
	// Logging configuration has been created/updated. Update/Deletion is disallowed
	// until logging configuration is ACTIVE and workspace status is ACTIVE.
	LoggingConfigurationStatusCodeActive LoggingConfigurationStatusCode = "ACTIVE"
	// Logging configuration is being updated. Update/Deletion is disallowed until
	// logging configuration is ACTIVE and workspace status is ACTIVE.
	LoggingConfigurationStatusCodeUpdating LoggingConfigurationStatusCode = "UPDATING"
	// Logging configuration is being deleting. Update/Deletion is disallowed until
	// logging configuration is ACTIVE and workspace status is ACTIVE.
	LoggingConfigurationStatusCodeDeleting LoggingConfigurationStatusCode = "DELETING"
	// Logging configuration creation failed.
	LoggingConfigurationStatusCodeCreationFailed LoggingConfigurationStatusCode = "CREATION_FAILED"
	// Logging configuration update failed.
	LoggingConfigurationStatusCodeUpdateFailed LoggingConfigurationStatusCode = "UPDATE_FAILED"
)

Enum values for LoggingConfigurationStatusCode

func (LoggingConfigurationStatusCode) Values added in v1.15.0 

func (LoggingConfigurationStatusCode) Values() []LoggingConfigurationStatusCode

Values returns all known values for LoggingConfigurationStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The request references a resources that doesn't exist.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type RuleGroupsNamespaceDescription added in v1.6.0 

type RuleGroupsNamespaceDescription struct {

	// The ARN of the rule groups namespace.
	//
	// This member is required.
	Arn *string

	// The date and time that the rule groups namespace was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The rule groups file used in the namespace.
	//
	// For details about the rule groups namespace structure, see [RuleGroupsNamespaceData].
	//
	// [RuleGroupsNamespaceData]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html
	//
	// This member is required.
	Data []byte

	// The date and time that the rule groups namespace was most recently changed.
	//
	// This member is required.
	ModifiedAt *time.Time

	// The name of the rule groups namespace.
	//
	// This member is required.
	Name *string

	// The current status of the rule groups namespace.
	//
	// This member is required.
	Status *RuleGroupsNamespaceStatus

	// The list of tag keys and values that are associated with the rule groups
	// namespace.
	Tags map[string]string
	// contains filtered or unexported fields
}

The details about one rule groups namespace.

type RuleGroupsNamespaceStatus added in v1.6.0 

type RuleGroupsNamespaceStatus struct {

	// The current status of the namespace.
	//
	// This member is required.
	StatusCode RuleGroupsNamespaceStatusCode

	// The reason for the failure, if any.
	StatusReason *string
	// contains filtered or unexported fields
}

The status information about a rule groups namespace.

type RuleGroupsNamespaceStatusCode added in v1.6.0 

type RuleGroupsNamespaceStatusCode string
const (
	// Namespace is being created. Update/Deletion is disallowed until namespace is
	// ACTIVE and workspace status is ACTIVE.
	RuleGroupsNamespaceStatusCodeCreating RuleGroupsNamespaceStatusCode = "CREATING"
	// Namespace has been created/updated. Update/Deletion is disallowed until
	// namespace is ACTIVE and workspace status is ACTIVE.
	RuleGroupsNamespaceStatusCodeActive RuleGroupsNamespaceStatusCode = "ACTIVE"
	// Namespace is being updated. Update/Deletion is disallowed until namespace is
	// ACTIVE and workspace status is ACTIVE.
	RuleGroupsNamespaceStatusCodeUpdating RuleGroupsNamespaceStatusCode = "UPDATING"
	// Namespace is being deleting. Update/Deletion is disallowed until namespace is
	// ACTIVE and workspace status is ACTIVE.
	RuleGroupsNamespaceStatusCodeDeleting RuleGroupsNamespaceStatusCode = "DELETING"
	// Namespace creation failed.
	RuleGroupsNamespaceStatusCodeCreationFailed RuleGroupsNamespaceStatusCode = "CREATION_FAILED"
	// Namespace update failed.
	RuleGroupsNamespaceStatusCodeUpdateFailed RuleGroupsNamespaceStatusCode = "UPDATE_FAILED"
)

Enum values for RuleGroupsNamespaceStatusCode

func (RuleGroupsNamespaceStatusCode) Values added in v1.6.0 

func (RuleGroupsNamespaceStatusCode) Values() []RuleGroupsNamespaceStatusCode

Values returns all known values for RuleGroupsNamespaceStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type RuleGroupsNamespaceSummary added in v1.6.0 

type RuleGroupsNamespaceSummary struct {

	// The ARN of the rule groups namespace.
	//
	// This member is required.
	Arn *string

	// The date and time that the rule groups namespace was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The date and time that the rule groups namespace was most recently changed.
	//
	// This member is required.
	ModifiedAt *time.Time

	// The name of the rule groups namespace.
	//
	// This member is required.
	Name *string

	// A structure that displays the current status of the rule groups namespace.
	//
	// This member is required.
	Status *RuleGroupsNamespaceStatus

	// The list of tag keys and values that are associated with the rule groups
	// namespace.
	Tags map[string]string
	// contains filtered or unexported fields
}

The high-level information about a rule groups namespace. To retrieve more information, use DescribeRuleGroupsNamespace .

type ScrapeConfiguration added in v1.20.0 

type ScrapeConfiguration interface {
	// contains filtered or unexported methods
}

A scrape configuration for a scraper, base 64 encoded. For more information, see Scraper configurationin the Amazon Managed Service for Prometheus User Guide.

The following types satisfy this interface: 

ScrapeConfigurationMemberConfigurationBlob
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/amp/types"
)

func main() {
	var union types.ScrapeConfiguration
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ScrapeConfigurationMemberConfigurationBlob:
		_ = v.Value // Value is []byte

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type ScrapeConfigurationMemberConfigurationBlob added in v1.20.0 

type ScrapeConfigurationMemberConfigurationBlob struct {
	Value []byte
	// contains filtered or unexported fields
}

The base 64 encoded scrape configuration file.

type ScraperDescription added in v1.20.0 

type ScraperDescription struct {

	// The Amazon Resource Name (ARN) of the scraper.
	//
	// This member is required.
	Arn *string

	// The date and time that the scraper was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The Amazon Managed Service for Prometheus workspace the scraper sends metrics
	// to.
	//
	// This member is required.
	Destination Destination

	// The date and time that the scraper was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

	// The Amazon Resource Name (ARN) of the IAM role that provides permissions for
	// the scraper to discover and collect metrics on your behalf.
	//
	// This member is required.
	RoleArn *string

	// The configuration file in use by the scraper.
	//
	// This member is required.
	ScrapeConfiguration ScrapeConfiguration

	// The ID of the scraper.
	//
	// This member is required.
	ScraperId *string

	// The Amazon EKS cluster from which the scraper collects metrics.
	//
	// This member is required.
	Source Source

	// A structure that contains the current status of the scraper.
	//
	// This member is required.
	Status *ScraperStatus

	// (Optional) A name associated with the scraper.
	Alias *string

	// If there is a failure, the reason for the failure.
	StatusReason *string

	// (Optional) The list of tag keys and values associated with the scraper.
	Tags map[string]string
	// contains filtered or unexported fields
}

The ScraperDescription structure contains the full details about one scraper in your account.

type ScraperStatus added in v1.20.0 

type ScraperStatus struct {

	// The current status of the scraper.
	//
	// This member is required.
	StatusCode ScraperStatusCode
	// contains filtered or unexported fields
}

The ScraperStatus structure contains status information about the scraper.

type ScraperStatusCode added in v1.20.0 

type ScraperStatusCode string
const (
	// Scraper is being created. Deletion is disallowed until status is ACTIVE.
	ScraperStatusCodeCreating ScraperStatusCode = "CREATING"
	// Scraper has been created and is usable.
	ScraperStatusCodeActive ScraperStatusCode = "ACTIVE"
	// Scraper is being deleted. Deletions are allowed only when status is ACTIVE.
	ScraperStatusCodeDeleting ScraperStatusCode = "DELETING"
	// Scraper creation failed.
	ScraperStatusCodeCreationFailed ScraperStatusCode = "CREATION_FAILED"
	// Scraper deletion failed.
	ScraperStatusCodeDeletionFailed ScraperStatusCode = "DELETION_FAILED"
)

Enum values for ScraperStatusCode

func (ScraperStatusCode) Values added in v1.20.0 

func (ScraperStatusCode) Values() []ScraperStatusCode

Values returns all known values for ScraperStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ScraperSummary added in v1.20.0 

type ScraperSummary struct {

	// The Amazon Resource Name (ARN) of the scraper.
	//
	// This member is required.
	Arn *string

	// The date and time that the scraper was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The Amazon Managed Service for Prometheus workspace the scraper sends metrics
	// to.
	//
	// This member is required.
	Destination Destination

	// The date and time that the scraper was last modified.
	//
	// This member is required.
	LastModifiedAt *time.Time

	// The Amazon Resource Name (ARN) of the IAM role that provides permissions for
	// the scraper to discover and collect metrics on your behalf.
	//
	// This member is required.
	RoleArn *string

	// The ID of the scraper.
	//
	// This member is required.
	ScraperId *string

	// The Amazon EKS cluster from which the scraper collects metrics.
	//
	// This member is required.
	Source Source

	// A structure that contains the current status of the scraper.
	//
	// This member is required.
	Status *ScraperStatus

	// (Optional) A name associated with the scraper.
	Alias *string

	// If there is a failure, the reason for the failure.
	StatusReason *string

	// (Optional) The list of tag keys and values associated with the scraper.
	Tags map[string]string
	// contains filtered or unexported fields
}

The ScraperSummary structure contains a summary of the details about one scraper in your account.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	ServiceCode  *string
	QuotaCode    *string
	// contains filtered or unexported fields
}

Completing the request would cause a service quota to be exceeded.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type Source added in v1.20.0 

type Source interface {
	// contains filtered or unexported methods
}

The source of collected metrics for a scraper.

The following types satisfy this interface: 

SourceMemberEksConfiguration
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/amp/types"
)

func main() {
	var union types.Source
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.SourceMemberEksConfiguration:
		_ = v.Value // Value is types.EksConfiguration

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

Output:

type SourceMemberEksConfiguration added in v1.20.0 

type SourceMemberEksConfiguration struct {
	Value EksConfiguration
	// contains filtered or unexported fields
}

The Amazon EKS cluster from which a scraper collects metrics.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	ServiceCode       *string
	QuotaCode         *string
	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type UnknownUnionMember added in v1.20.0 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason    ValidationExceptionReason
	FieldList []ValidationExceptionField
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by an Amazon Web Services service.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField 

type ValidationExceptionField struct {

	// A message describing why the field caused an exception.
	//
	// This member is required.
	Message *string

	// The name of the field that caused an exception.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Information about a field passed into a request that resulted in an exception.

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "UNKNOWN_OPERATION"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "CANNOT_PARSE"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FIELD_VALIDATION_FAILED"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "OTHER"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WorkspaceDescription 

type WorkspaceDescription struct {

	// The ARN of the workspace.
	//
	// This member is required.
	Arn *string

	// The date and time that the workspace was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The current status of the workspace.
	//
	// This member is required.
	Status *WorkspaceStatus

	// The unique ID for the workspace.
	//
	// This member is required.
	WorkspaceId *string

	// The alias that is assigned to this workspace to help identify it. It may not be
	// unique.
	Alias *string

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

	// The Prometheus endpoint available for this workspace.
	PrometheusEndpoint *string

	// The list of tag keys and values that are associated with the workspace.
	Tags map[string]string
	// contains filtered or unexported fields
}

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

type WorkspaceStatus 

type WorkspaceStatus struct {

	// The current status of the workspace.
	//
	// This member is required.
	StatusCode WorkspaceStatusCode
	// contains filtered or unexported fields
}

The status of the workspace.

type WorkspaceStatusCode 

type WorkspaceStatusCode string
const (
	// Workspace is being created. Deletion is disallowed until status is ACTIVE.
	WorkspaceStatusCodeCreating WorkspaceStatusCode = "CREATING"
	// Workspace has been created and is usable.
	WorkspaceStatusCodeActive WorkspaceStatusCode = "ACTIVE"
	// Workspace is being updated. Updates are allowed only when status is ACTIVE.
	WorkspaceStatusCodeUpdating WorkspaceStatusCode = "UPDATING"
	// Workspace is being deleted. Deletions are allowed only when status is ACTIVE.
	WorkspaceStatusCodeDeleting WorkspaceStatusCode = "DELETING"
	// Workspace creation failed. Refer to WorkspaceStatus.failureReason for more
	// details.
	WorkspaceStatusCodeCreationFailed WorkspaceStatusCode = "CREATION_FAILED"
)

Enum values for WorkspaceStatusCode

func (WorkspaceStatusCode) Values 

func (WorkspaceStatusCode) Values() []WorkspaceStatusCode

Values returns all known values for WorkspaceStatusCode. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WorkspaceSummary 

type WorkspaceSummary struct {

	// The ARN of the workspace.
	//
	// This member is required.
	Arn *string

	// The date and time that the workspace was created.
	//
	// This member is required.
	CreatedAt *time.Time

	// The current status of the workspace.
	//
	// This member is required.
	Status *WorkspaceStatus

	// The unique ID for the workspace.
	//
	// This member is required.
	WorkspaceId *string

	// The alias that is assigned to this workspace to help identify it. It may not be
	// unique.
	Alias *string

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

	// The list of tag keys and values that are associated with the workspace.
	Tags map[string]string
	// contains filtered or unexported fields
}

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.