Amazon Comprehend · JSON Structure

Openapi.Yml Vpc Config Structure

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see Amazon VPC.

Type: object Properties: 2 Required: 2
Machine LearningNatural Language ProcessingNLPText Analysis

VpcConfig is a JSON Structure definition published by Amazon Comprehend, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

SecurityGroupIds Subnets

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-comprehend/refs/heads/main/json-structure/openapi.yml-vpc-config-structure.json",
  "name": "VpcConfig",
  "description": " Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html\">Amazon VPC</a>. ",
  "type": "object",
  "properties": {
    "SecurityGroupIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SecurityGroupIds"
        },
        {
          "description": "The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you\u2019ll be accessing on the VPC. This ID number is preceded by \"sg-\", for instance: \"sg-03b388029b0a285ea\". For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html\">Security Groups for your VPC</a>. "
        }
      ]
    },
    "Subnets": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Subnets"
        },
        {
          "description": "The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC\u2019s Region. This ID number is preceded by \"subnet-\", for instance: \"subnet-04ccf456919e69055\". For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html\">VPCs and Subnets</a>. "
        }
      ]
    }
  },
  "required": [
    "SecurityGroupIds",
    "Subnets"
  ]
}