How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon Well-Architected Tool ShareInvitations API

The ShareInvitations API from Amazon Well-Architected Tool — 2 operation(s) for shareinvitations.

Amazon Well-Architected Tool ShareInvitations API is one of 13 APIs that Amazon Well-Architected Tool publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include ShareInvitations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, pricing, a JSON-LD context, and 1 JSON Schema.

This API exposes 2 operations across 2 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://wellarchitected.{region}.amazonaws.com, https://wellarchitected.{region}.amazonaws.com, http://wellarchitected.{region}.amazonaws.com.cn, https://wellarchitected.{region}.amazonaws.com.cn.

2 operations 2 paths 24 schemas 1 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://wellarchitected.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon Well-Architected Tool ShareInvitations API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

ShareInvitations 2
GET
/shareInvitations
Amazon Well-Architected Tool List Share Invitations
ListShareInvitations 13 params → 200480481482483
PATCH
/shareInvitations/{ShareInvitationId}
Amazon Well-Architected Tool Update Share Invitation
UpdateShareInvitation 8 params body → 200480481482483484485

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are ShareInvitationSummary (11 properties), ShareInvitation (6 properties), ListShareInvitationsOutput (2 properties), UpdateShareInvitationOutput (1 property). Each schema is shown below with its type and property counts.

ThrottlingException
LensArn
string
SharedWith
string
The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.
InternalServerException
AccessDeniedException
ShareInvitationId
string
ListShareInvitationsOutput
object
Input for List Share Invitations
2 properties
ShareInvitationSummaries
array
ShareInvitation
object
The share invitation.
6 properties
ConflictException
ValidationException
AwsAccountId
string
An Amazon Web Services account ID.
WorkloadId
string
The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.
WorkloadName
string
The name of the workload. The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking f…
ShareInvitationSummary
object
A share invitation summary return object.
11 properties
ShareResourceType
string
PermissionType
string
Permission granted on a share request.
NextToken
string
The token to use to retrieve the next set of results.
UpdateShareInvitationOutput
object
1 property
ResourceNotFoundException
LensName
string
The full name of the lens.
ProfileArn
string
LensAlias
string
The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as serverless , or the lens ARN, such as arn:aws:wellarchit…
ProfileName
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-well-architected-tool-shareinvitations-api-openapi.yml Raw ↑

Other APIs Amazon Well-Architected Tool publishes across the network.

Amazon Well-Architected Tool ConsolidatedReport#Format API
Amazon Well-Architected Tool Global Settings API
Amazon Well-Architected Tool ImportLens API
Amazon Well-Architected Tool Lenses API
Amazon Well-Architected Tool Notifications API
Amazon Well-Architected Tool ProfileNotifications API
Amazon Well-Architected Tool Profiles API
Amazon Well-Architected Tool ProfileSummaries API
Amazon Well-Architected Tool ProfileTemplate API
Amazon Well-Architected Tool Tags API
Amazon Well-Architected Tool Workloads API
Amazon Well-Architected Tool WorkloadsSummaries API
Where this information came from

This is an independent, third-party profile of Amazon Well-Architected Tool ShareInvitations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.