Amp

This page documents function available when using the Amp module, created with @service Amp.

Index

Documentation

Main.Amp.create_alert_manager_definitionMethod
create_alert_manager_definition(data, workspace_id)
create_alert_manager_definition(data, workspace_id, params::Dict{String,<:Any})

Create an alert manager definition.

Arguments

  • data: The alert manager definition data.
  • workspace_id: The ID of the workspace in which to create the alert manager definition.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
Main.Amp.create_logging_configurationMethod
create_logging_configuration(log_group_arn, workspace_id)
create_logging_configuration(log_group_arn, workspace_id, params::Dict{String,<:Any})

Create logging configuration.

Arguments

  • log_group_arn: The ARN of the CW log group to which the vended log data will be published.
  • workspace_id: The ID of the workspace to vend logs to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
Main.Amp.create_rule_groups_namespaceMethod
create_rule_groups_namespace(data, name, workspace_id)
create_rule_groups_namespace(data, name, workspace_id, params::Dict{String,<:Any})

Create a rule group namespace.

Arguments

  • data: The namespace data that define the rule groups.
  • name: The rule groups namespace name.
  • workspace_id: The ID of the workspace in which to create the rule group namespace.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
  • "tags": Optional, user-provided tags for this rule groups namespace.
Main.Amp.create_workspaceMethod
create_workspace()
create_workspace(params::Dict{String,<:Any})

Creates a new AMP workspace.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alias": An optional user-assigned alias for this workspace. This alias is for user reference and does not need to be unique.
  • "clientToken": Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
  • "tags": Optional, user-provided tags for this workspace.
Main.Amp.delete_alert_manager_definitionMethod
delete_alert_manager_definition(workspace_id)
delete_alert_manager_definition(workspace_id, params::Dict{String,<:Any})

Deletes an alert manager definition.

Arguments

  • workspace_id: The ID of the workspace in which to delete the alert manager definition.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
Main.Amp.delete_logging_configurationMethod
delete_logging_configuration(workspace_id)
delete_logging_configuration(workspace_id, params::Dict{String,<:Any})

Delete logging configuration.

Arguments

  • workspace_id: The ID of the workspace to vend logs to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
Main.Amp.delete_rule_groups_namespaceMethod
delete_rule_groups_namespace(name, workspace_id)
delete_rule_groups_namespace(name, workspace_id, params::Dict{String,<:Any})

Delete a rule groups namespace.

Arguments

  • name: The rule groups namespace name.
  • workspace_id: The ID of the workspace to delete rule group definition.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
Main.Amp.delete_workspaceMethod
delete_workspace(workspace_id)
delete_workspace(workspace_id, params::Dict{String,<:Any})

Deletes an AMP workspace.

Arguments

  • workspace_id: The ID of the workspace to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
Main.Amp.describe_alert_manager_definitionMethod
describe_alert_manager_definition(workspace_id)
describe_alert_manager_definition(workspace_id, params::Dict{String,<:Any})

Describes an alert manager definition.

Arguments

  • workspace_id: The ID of the workspace to describe.
Main.Amp.describe_logging_configurationMethod
describe_logging_configuration(workspace_id)
describe_logging_configuration(workspace_id, params::Dict{String,<:Any})

Describes logging configuration.

Arguments

  • workspace_id: The ID of the workspace to vend logs to.
Main.Amp.describe_rule_groups_namespaceMethod
describe_rule_groups_namespace(name, workspace_id)
describe_rule_groups_namespace(name, workspace_id, params::Dict{String,<:Any})

Describe a rule groups namespace.

Arguments

  • name: The rule groups namespace.
  • workspace_id: The ID of the workspace to describe.
Main.Amp.describe_workspaceMethod
describe_workspace(workspace_id)
describe_workspace(workspace_id, params::Dict{String,<:Any})

Describes an existing AMP workspace.

Arguments

  • workspace_id: The ID of the workspace to describe.
Main.Amp.list_rule_groups_namespacesMethod
list_rule_groups_namespaces(workspace_id)
list_rule_groups_namespaces(workspace_id, params::Dict{String,<:Any})

Lists rule groups namespaces.

Arguments

  • workspace_id: The ID of the workspace.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": Maximum results to return in response (default=100, maximum=1000).
  • "name": Optional filter for rule groups namespace name. Only the rule groups namespace that begin with this value will be returned.
  • "nextToken": Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListRuleGroupsNamespaces request.
Main.Amp.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Lists the tags you have assigned to the resource.

Arguments

  • resource_arn: The ARN of the resource.
Main.Amp.list_workspacesMethod
list_workspaces()
list_workspaces(params::Dict{String,<:Any})

Lists all AMP workspaces, including workspaces being created or deleted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alias": Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.
  • "maxResults": Maximum results to return in response (default=100, maximum=1000).
  • "nextToken": Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.
Main.Amp.put_alert_manager_definitionMethod
put_alert_manager_definition(data, workspace_id)
put_alert_manager_definition(data, workspace_id, params::Dict{String,<:Any})

Update an alert manager definition.

Arguments

  • data: The alert manager definition data.
  • workspace_id: The ID of the workspace in which to update the alert manager definition.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
Main.Amp.put_rule_groups_namespaceMethod
put_rule_groups_namespace(data, name, workspace_id)
put_rule_groups_namespace(data, name, workspace_id, params::Dict{String,<:Any})

Update a rule groups namespace.

Arguments

  • data: The namespace data that define the rule groups.
  • name: The rule groups namespace name.
  • workspace_id: The ID of the workspace in which to update the rule group namespace.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
Main.Amp.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Creates tags for the specified resource.

Arguments

  • resource_arn: The ARN of the resource.
  • tags:
Main.Amp.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Deletes tags from the specified resource.

Arguments

  • resource_arn: The ARN of the resource.
  • tag_keys: One or more tag keys
Main.Amp.update_logging_configurationMethod
update_logging_configuration(log_group_arn, workspace_id)
update_logging_configuration(log_group_arn, workspace_id, params::Dict{String,<:Any})

Update logging configuration.

Arguments

  • log_group_arn: The ARN of the CW log group to which the vended log data will be published.
  • workspace_id: The ID of the workspace to vend logs to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
Main.Amp.update_workspace_aliasMethod
update_workspace_alias(workspace_id)
update_workspace_alias(workspace_id, params::Dict{String,<:Any})

Updates an AMP workspace alias.

Arguments

  • workspace_id: The ID of the workspace being updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "alias": The new alias of the workspace.
  • "clientToken": Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.