Policy: AWS > Well-Architected Tool > AWS Well-Architected Framework > Reliability > REL 03. How do you design your workload service architecture? > Provide service contracts per API

Service contracts are documented agreements between teams on service integration and include a machine-readable API definition, rate limits, and performance expectations. A versioning strategy allows clients to continue using the existing API and migrate their applications to the newer API when they are ready. Deployment can happen anytime, as long as the contract is not violated. The service provider team can use the technology stack of their choice to satisfy the API contract. Similarly, the service consumer can use their own technology.

See Provide service contracts per API for more information.

Resource Types

This policy targets the following resource types:

AWS > Well-Architected Tool > AWS Well-Architected Framework

Primary Policy

This policy is used with the following primary policy:

AWS > Well-Architected Tool > AWS Well-Architected Framework > Reliability > REL 03. How do you design your workload service architecture?

Controls

Policy Specification

Schema Type	`string`
Default	`Skip`
Valid Values [YAML]	`Skip` `True` `False`

In Your Workspace

Policy Settings by Type report

Developers

Category URI

tmod:@turbot/turbot#/control/categories/other

Policy Type URI

tmod:@turbot/aws-wellarchitected-framework#/policy/types/rel03ApiContracts

GraphQL

query policyType(id: "tmod:@turbot/aws-wellarchitected-framework#/policy/types/rel03ApiContracts") { … }

query policySettings(filter: "policyTypeId:'tmod:@turbot/aws-wellarchitected-framework#/policy/types/rel03ApiContracts'") { … }

query policyValues(filter: "policyTypeId:'tmod:@turbot/aws-wellarchitected-framework#/policy/types/rel03ApiContracts'") { … }

CLI

Get Policy Type

turbot graphql policy-type --id "tmod:@turbot/aws-wellarchitected-framework#/policy/types/rel03ApiContracts"

Get Policy Settings

turbot graphql policy-settings --filter "policyTypeId:tmod:@turbot/aws-wellarchitected-framework#/policy/types/rel03ApiContracts"