openapi: 3.0.0 info: version: '2016-04-12' x-release: v4 title: AWS X-Ray CreateGroup API description: Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces. x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: xray x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/xray-2016-04-12.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://xray.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS X-Ray multi-region endpoint - url: https://xray.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The AWS X-Ray multi-region endpoint - url: http://xray.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS X-Ray endpoint for China (Beijing) and China (Ningxia) - url: https://xray.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The AWS X-Ray endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: CreateGroup paths: /CreateGroup: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: CreateGroup description: 'Creates a group resource with a name and a filter expression. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateGroupResult' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ThrottledException content: application/json: schema: $ref: '#/components/schemas/ThrottledException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - GroupName properties: GroupName: description: The case-sensitive name of the new group. Default is a reserved name and names must be unique. type: string minLength: 1 maxLength: 32 FilterExpression: description: The filter expression defining criteria by which to group traces. type: string InsightsConfiguration: description: The structure containing configurations related to insights. type: object properties: InsightsEnabled: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: Set the InsightsEnabled value to true to enable insights or false to disable insights. NotificationsEnabled: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true. Tags: description: '

A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

' type: array items: $ref: '#/components/schemas/Tag' minItems: 0 maxItems: 200 summary: Amazon X-Ray Create Group tags: - CreateGroup components: schemas: ThrottledException: {} Group: type: object properties: GroupName: allOf: - $ref: '#/components/schemas/String' - description: The unique case-sensitive name of the group. GroupARN: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) of the group generated based on the GroupName. FilterExpression: allOf: - $ref: '#/components/schemas/String' - description: The filter expression defining the parameters to include traces. InsightsConfiguration: allOf: - $ref: '#/components/schemas/InsightsConfiguration' - description:

The structure containing configurations related to insights.

description: Details and metadata for a group. InvalidRequestException: {} CreateGroupResult: type: object properties: Group: allOf: - $ref: '#/components/schemas/Group' - description: The group that was created. Contains the name of the group that was created, the Amazon Resource Name (ARN) of the group that was generated based on the group name, the filter expression, and the insight configuration that was assigned to the group. Tag: type: object required: - Key - Value properties: Key: allOf: - $ref: '#/components/schemas/TagKey' - description: 'A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / ' Value: allOf: - $ref: '#/components/schemas/TagValue' - description: 'An optional tag value, such as Production or test-only. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : / ' description: '

A map that contains tag keys and tag values to attach to an Amazon Web Services X-Ray group or sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

' TagValue: type: string minLength: 0 maxLength: 256 String: type: string InsightsConfiguration: type: object properties: InsightsEnabled: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: Set the InsightsEnabled value to true to enable insights or false to disable insights. NotificationsEnabled: allOf: - $ref: '#/components/schemas/NullableBoolean' - description: Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true. description: The structure containing configurations related to insights. NullableBoolean: type: boolean TagKey: type: string minLength: 1 maxLength: 128 parameters: X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/xray/