Aws enum

aws.* attribute keys from the OpenTelemetry semantic-conventions attribute registry.

Inheritance
Implemented types
Available extensions

Values

awsBedrockGuardrailId → const Aws

The unique identifier of the AWS Bedrock Guardrail. A guardrail helps safeguard and prevent unwanted behavior from model responses or user messages.

Examples: sgi5gkybzqak

Stability: development

const Aws('aws.bedrock.guardrail.id')
awsBedrockKnowledgeBaseId → const Aws

The unique identifier of the AWS Bedrock Knowledge base. A knowledge base is a bank of information that can be queried by models to generate more relevant responses and augment prompts.

Examples: XFWUPB9PAW

Stability: development

const Aws('aws.bedrock.knowledge_base.id')
awsDynamodbAttributeDefinitions → const Aws

The JSON-serialized value of each item in the AttributeDefinitions request field.

Examples: ["{ \"AttributeName\": \"string\", \"AttributeType\": \"string\" }"]

Stability: development

const Aws('aws.dynamodb.attribute_definitions')
awsDynamodbAttributesToGet → const Aws

The value of the AttributesToGet request parameter.

Examples: ["lives", "id"]

Stability: development

const Aws('aws.dynamodb.attributes_to_get')
awsDynamodbConsistentRead → const Aws

The value of the ConsistentRead request parameter.

Stability: development

const Aws('aws.dynamodb.consistent_read')
awsDynamodbConsumedCapacity → const Aws

The JSON-serialized value of each item in the ConsumedCapacity response field.

Examples: ["{ \"CapacityUnits\": number, \"GlobalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"LocalSecondaryIndexes\": { \"string\" : { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }, \"ReadCapacityUnits\": number, \"Table\": { \"CapacityUnits\": number, \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number }, \"TableName\": \"string\", \"WriteCapacityUnits\": number }"]

Stability: development

const Aws('aws.dynamodb.consumed_capacity')
awsDynamodbCount → const Aws

The value of the Count response parameter.

Examples: 10

Stability: development

const Aws('aws.dynamodb.count')
awsDynamodbExclusiveStartTable → const Aws

The value of the ExclusiveStartTableName request parameter.

Examples: Users, CatsTable

Stability: development

const Aws('aws.dynamodb.exclusive_start_table')
awsDynamodbGlobalSecondaryIndexUpdates → const Aws

The JSON-serialized value of each item in the GlobalSecondaryIndexUpdates request field.

Examples: ["{ \"Create\": { \"IndexName\": \"string\", \"KeySchema\": [ { \"AttributeName\": \"string\", \"KeyType\": \"string\" } ], \"Projection\": { \"NonKeyAttributes\": [ \"string\" ], \"ProjectionType\": \"string\" }, \"ProvisionedThroughput\": { \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }"]

Stability: development

const Aws('aws.dynamodb.global_secondary_index_updates')
awsDynamodbGlobalSecondaryIndexes → const Aws

The JSON-serialized value of each item of the GlobalSecondaryIndexes request field

Examples: ["{ \"IndexName\": \"string\", \"KeySchema\": [ { \"AttributeName\": \"string\", \"KeyType\": \"string\" } ], \"Projection\": { \"NonKeyAttributes\": [ \"string\" ], \"ProjectionType\": \"string\" }, \"ProvisionedThroughput\": { \"ReadCapacityUnits\": number, \"WriteCapacityUnits\": number } }"]

Stability: development

const Aws('aws.dynamodb.global_secondary_indexes')
awsDynamodbIndexName → const Aws

The value of the IndexName request parameter.

Examples: name_to_group

Stability: development

const Aws('aws.dynamodb.index_name')
awsDynamodbItemCollectionMetrics → const Aws

The JSON-serialized value of the ItemCollectionMetrics response field.

Examples: { "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] }

Stability: development

const Aws('aws.dynamodb.item_collection_metrics')
awsDynamodbLimit → const Aws

The value of the Limit request parameter.

Examples: 10

Stability: development

const Aws('aws.dynamodb.limit')
awsDynamodbLocalSecondaryIndexes → const Aws

The JSON-serialized value of each item of the LocalSecondaryIndexes request field.

Examples: ["{ \"IndexArn\": \"string\", \"IndexName\": \"string\", \"IndexSizeBytes\": number, \"ItemCount\": number, \"KeySchema\": [ { \"AttributeName\": \"string\", \"KeyType\": \"string\" } ], \"Projection\": { \"NonKeyAttributes\": [ \"string\" ], \"ProjectionType\": \"string\" } }"]

Stability: development

const Aws('aws.dynamodb.local_secondary_indexes')
awsDynamodbProjection → const Aws

The value of the ProjectionExpression request parameter.

Examples: Title, Title, Price, Color, Title, Description, RelatedItems, ProductReviews

Stability: development

const Aws('aws.dynamodb.projection')
awsDynamodbProvisionedReadCapacity → const Aws

The value of the ProvisionedThroughput.ReadCapacityUnits request parameter.

Examples: 1.0, 2.0

Stability: development

const Aws('aws.dynamodb.provisioned_read_capacity')
awsDynamodbProvisionedWriteCapacity → const Aws

The value of the ProvisionedThroughput.WriteCapacityUnits request parameter.

Examples: 1.0, 2.0

Stability: development

const Aws('aws.dynamodb.provisioned_write_capacity')
awsDynamodbScanForward → const Aws

The value of the ScanIndexForward request parameter.

Stability: development

const Aws('aws.dynamodb.scan_forward')
awsDynamodbScannedCount → const Aws

The value of the ScannedCount response parameter.

Examples: 50

Stability: development

const Aws('aws.dynamodb.scanned_count')
awsDynamodbSegment → const Aws

The value of the Segment request parameter.

Examples: 10

Stability: development

const Aws('aws.dynamodb.segment')
awsDynamodbSelect → const Aws

The value of the Select request parameter.

Examples: ALL_ATTRIBUTES, COUNT

Stability: development

const Aws('aws.dynamodb.select')
awsDynamodbTableCount → const Aws

The number of items in the TableNames response parameter.

Examples: 20

Stability: development

const Aws('aws.dynamodb.table_count')
awsDynamodbTableNames → const Aws

The keys in the RequestItems object field.

Examples: ["Users", "Cats"]

Stability: development

const Aws('aws.dynamodb.table_names')
awsDynamodbTotalSegments → const Aws

The value of the TotalSegments request parameter.

Examples: 100

Stability: development

const Aws('aws.dynamodb.total_segments')
awsEcsClusterArn → const Aws

The ARN of an ECS cluster .

Examples: arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster

Stability: development

const Aws('aws.ecs.cluster.arn')
awsEcsContainerArn → const Aws

The Amazon Resource Name (ARN) of an ECS container instance .

Examples: arn:aws:ecs:us-west-1:123456789123:container/32624152-9086-4f0e-acae-1a75b14fe4d9

Stability: development

const Aws('aws.ecs.container.arn')
awsEcsLaunchtype → const Aws

The launch type for an ECS task.

Stability: development

const Aws('aws.ecs.launchtype')
awsEcsTaskArn → const Aws

The ARN of a running ECS task .

Examples: arn:aws:ecs:us-west-1:123456789123:task/10838bed-421f-43ef-870a-f43feacbbb5b, arn:aws:ecs:us-west-1:123456789123:task/my-cluster/task-id/23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd

Stability: development

const Aws('aws.ecs.task.arn')
awsEcsTaskFamily → const Aws

The family name of the ECS task definition used to create the ECS task.

Examples: opentelemetry-family

Stability: development

const Aws('aws.ecs.task.family')
awsEcsTaskId → const Aws

The ID of a running ECS task. The ID MUST be extracted from task.arn .

Examples: 10838bed-421f-43ef-870a-f43feacbbb5b, 23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd

Stability: development

const Aws('aws.ecs.task.id')
awsEcsTaskRevision → const Aws

The revision for the task definition used to create the ECS task.

Examples: 8, 26

Stability: development

const Aws('aws.ecs.task.revision')
awsEksClusterArn → const Aws

The ARN of an EKS cluster.

Examples: arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster

Stability: development

const Aws('aws.eks.cluster.arn')
awsExtendedRequestId → const Aws

The AWS extended request ID as returned in the response header x-amz-id-2.

Examples: wzHcyEWfmOGDIE5QOhTAqFDoDWP3y8IUvpNINCwL9N4TEHbUw0/gZJ+VZTmCNCWR7fezEN3eCiQ=

Stability: development

const Aws('aws.extended_request_id')
awsKinesisStreamName → const Aws

The name of the AWS Kinesis stream the request refers to. Corresponds to the --stream-name parameter of the Kinesis describe-stream operation.

Examples: some-stream-name

Stability: development

const Aws('aws.kinesis.stream_name')
awsLambdaInvokedArn → const Aws

The full invoked ARN as provided on the Context passed to the function (Lambda-Runtime-Invoked-Function-Arn header on the /runtime/invocation/next applicable).

Examples: arn:aws:lambda:us-east-1:123456:function:myfunction:myalias

Stability: development

const Aws('aws.lambda.invoked_arn')
awsLambdaResourceMappingId → const Aws

The UUID of the AWS Lambda EvenSource Mapping . An event source is mapped to a lambda function. It's contents are read by Lambda and used to trigger a function. This isn't available in the lambda execution context or the lambda runtime environment. This is going to be populated by the AWS SDK for each language when that UUID is present. Some of these operations are Create/Delete/Get/List/Update EventSourceMapping.

Examples: 587ad24b-03b9-4413-8202-bbd56b36e5b7

Stability: development

const Aws('aws.lambda.resource_mapping.id')
awsLogGroupArns → const Aws

The Amazon Resource Name(s) (ARN) of the AWS log group(s).

Examples: ["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*"]

Stability: development

const Aws('aws.log.group.arns')
awsLogGroupNames → const Aws

The name(s) of the AWS log group(s) an application is writing to.

Examples: ["/aws/lambda/my-function", "opentelemetry-service"]

Stability: development

const Aws('aws.log.group.names')
awsLogStreamArns → const Aws

The ARN(s) of the AWS log stream(s).

Examples: ["arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]

Stability: development

const Aws('aws.log.stream.arns')
awsLogStreamNames → const Aws

The name(s) of the AWS log stream(s) an application is writing to.

Examples: ["logs/main/10838bed-421f-43ef-870a-f43feacbbb5b"]

Stability: development

const Aws('aws.log.stream.names')
awsRequestId → const Aws

The AWS request ID as returned in the response headers x-amzn-requestid, x-amzn-request-id or x-amz-request-id.

Examples: 79b9da39-b7ae-508a-a6bc-864b2829c622, C9ER4AJX75574TDJ

Stability: development

const Aws('aws.request_id')
awsS3Bucket → const Aws

The S3 bucket name the request refers to. Corresponds to the --bucket parameter of the S3 API operations.

Examples: some-bucket-name

Stability: development

const Aws('aws.s3.bucket')
awsS3CopySource → const Aws

The source object (in the form bucket/key) for the copy operation.

Examples: someFile.yml

Stability: development

const Aws('aws.s3.copy_source')
awsS3Delete → const Aws

The delete request container that specifies the objects to be deleted.

Examples: Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean

Stability: development

const Aws('aws.s3.delete')
awsS3Key → const Aws

The S3 object key the request refers to. Corresponds to the --key parameter of the S3 API operations.

Examples: someFile.yml

Stability: development

const Aws('aws.s3.key')
awsS3PartNumber → const Aws

The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000.

Examples: 3456

Stability: development

const Aws('aws.s3.part_number')
awsS3UploadId → const Aws

Upload ID that identifies the multipart upload.

Examples: dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ

Stability: development

const Aws('aws.s3.upload_id')
awsSecretsmanagerSecretArn → const Aws

The ARN of the Secret stored in the Secrets Manager

Examples: arn:aws:secretsmanager:us-east-1:123456789012:secret:SecretName-6RandomCharacters

Stability: development

const Aws('aws.secretsmanager.secret.arn')
awsSnsTopicArn → const Aws

The ARN of the AWS SNS Topic. An Amazon SNS topic is a logical access point that acts as a communication channel.

Examples: arn:aws:sns:us-east-1:123456789012:mystack-mytopic-NZJ5JSMVGFIE

Stability: development

const Aws('aws.sns.topic.arn')
awsSqsQueueUrl → const Aws

The URL of the AWS SQS Queue. It's a unique identifier for a queue in Amazon Simple Queue Service (SQS) and is used to access the queue and perform actions on it.

Examples: https://sqs.us-east-1.amazonaws.com/123456789012/MyQueue

Stability: development

const Aws('aws.sqs.queue.url')
awsStepFunctionsActivityArn → const Aws

The ARN of the AWS Step Functions Activity.

Examples: arn:aws:states:us-east-1:123456789012:activity:get-greeting

Stability: development

const Aws('aws.step_functions.activity.arn')
awsStepFunctionsStateMachineArn → const Aws

The ARN of the AWS Step Functions State Machine.

Examples: arn:aws:states:us-east-1:123456789012:stateMachine:myStateMachine:1

Stability: development

const Aws('aws.step_functions.state_machine.arn')

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
key → String
The attribute key string as defined in the OpenTelemetry specification.
final
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMapEntry(Object value) → MapEntry<String, Object>

Available on OTelSemantic, provided by the OTelSemanticExtension extension

Converts this semantic attribute and its value to a MapEntry.
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<Aws>
A constant List of the values in this enum, in order of their declaration.