---
title: "POST /services"
method: POST
path: "/services"
---

# POST /services

`POST /services`

Creates a service. A service is any software application that can run on instances containers, or serverless functions within an account or virtual private cloud (VPC).

For more information, see [Services](https://docs.aws.amazon.com/vpc-lattice/latest/ug/services.html) in the _Amazon VPC Lattice User Guide_.

## Request body

- object
  - `clientToken` string — A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.
  - `name` string, required — The name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.
  - `tags` object — The tags for the service.
  - `customDomainName` string — The custom domain name of the service.
  - `certificateArn` string — The Amazon Resource Name (ARN) of the certificate.
  - `authType` 'NONE' | 'AWS_IAM' — <p>The type of IAM policy.</p> <ul> <li> <p> <code>NONE</code>: The resource does not use an IAM policy. This is the default.</p> </li> <li> <p> <code>AWS_IAM</code>: The resource uses an IAM policy. When this type is used, auth is enabled and an auth policy is required.</p> </li> </ul>
  - `idleTimeoutSeconds` integer — The amount of time, in seconds, that a connection can remain idle (no data sent) before VPC Lattice closes it. The valid range is 60 to 600 seconds. If you don't specify a value, the default is 60 seconds. This setting does not change the maximum connection duration of 10 minutes; connections are still closed when they reach that limit.

## Response `201`

Success

- CreateServiceResponse
  - `id` string — The ID of the service.
  - `arn` string — The Amazon Resource Name (ARN) of the service.
  - `name` string — The name of the service.
  - `customDomainName` string — The custom domain name of the service.
  - `certificateArn` string — The Amazon Resource Name (ARN) of the certificate.
  - `status` 'ACTIVE' | 'CREATE_IN_PROGRESS' | 'DELETE_IN_PROGRESS' | 'CREATE_FAILED' | 'DELETE_FAILED' — The status. If the status is <code>CREATE_FAILED</code>, you must delete and recreate the service.
  - `authType` 'NONE' | 'AWS_IAM' — The type of IAM policy.
  - `idleTimeoutSeconds` integer — The amount of time, in seconds, that a connection can remain idle before VPC Lattice closes it.
  - `dnsEntry` object — The public DNS name of the service.
    - `domainName` string — The domain name of the service.
    - `hostedZoneId` string — The ID of the hosted zone.

## Other responses

- `480` — ValidationException
- `481` — AccessDeniedException
- `482` — ConflictException
- `483` — ResourceNotFoundException
- `484` — ThrottlingException
- `485` — ServiceQuotaExceededException
- `486` — InternalServerException

---

[API](https://skmtc.net/aws/apis/vpc-lattice.md) · [All operations](https://skmtc.net/aws/apis/vpc-lattice/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/vpc-lattice/versions/bbec5439e0f7/schema)