Amazon Systems Manager Systems Manager Cloud Connector API
The Systems Manager Cloud Connector API from Amazon Systems Manager — 6 operation(s) for systems manager cloud connector.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-systems-manager:amazon-systems-manager-cloud-connector-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Amazon Simple Systems Manager (SSM) Cloud Connector API
version: '2014-11-06'
description: Generated from AWS's published Smithy model for Amazon Simple Systems Manager (SSM). 6 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://ssm.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
tags:
- name: Cloud Connector
paths:
/#CreateCloudConnector:
post:
operationId: CreateCloudConnector
summary: Create Cloud Connector
description: Creates a cloud connector that establishes a connection between Systems Manager and a third-party cloud environment.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateCloudConnectorResult'
'400':
description: ConflictException; ServiceQuotaExceededException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerError
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerError'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonSSM.CreateCloudConnector
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/CreateCloudConnectorRequest'
tags:
- Cloud Connector
/#DeleteCloudConnector:
post:
operationId: DeleteCloudConnector
summary: Delete Cloud Connector
description: Deletes a cloud connector.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteCloudConnectorResult'
'400':
description: ConflictException; ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerError
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerError'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonSSM.DeleteCloudConnector
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DeleteCloudConnectorRequest'
tags:
- Cloud Connector
/#GetCloudConnector:
post:
operationId: GetCloudConnector
summary: Get Cloud Connector
description: Returns detailed information about a cloud connector.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/GetCloudConnectorResult'
'500':
description: InternalServerError
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerError'
'400':
description: ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonSSM.GetCloudConnector
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/GetCloudConnectorRequest'
tags:
- Cloud Connector
/#ListCloudConnectors:
post:
operationId: ListCloudConnectors
summary: List Cloud Connectors
description: Returns a list of cloud connectors in the current Amazon Web Services account and Amazon Web Services Region.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListCloudConnectorsResult'
'500':
description: InternalServerError
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerError'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonSSM.ListCloudConnectors
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ListCloudConnectorsRequest'
tags:
- Cloud Connector
/#UpdateCloudConnector:
post:
operationId: UpdateCloudConnector
summary: Update Cloud Connector
description: Updates an existing cloud connector with new configuration details.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UpdateCloudConnectorResult'
'400':
description: ConflictException; ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerError
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerError'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonSSM.UpdateCloudConnector
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/UpdateCloudConnectorRequest'
tags:
- Cloud Connector
/#ValidateCloudConnector:
post:
operationId: ValidateCloudConnector
summary: Validate Cloud Connector
description: Validates the configuration and connectivity of a cloud connector.
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ValidateCloudConnectorResult'
'500':
description: InternalServerError
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerError'
'400':
description: ResourceNotFoundException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AmazonSSM.ValidateCloudConnector
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/ValidateCloudConnectorRequest'
tags:
- Cloud Connector
components:
schemas:
GetCloudConnectorRequest:
type: object
properties:
CloudConnectorId:
type: string
description: The ID of the cloud connector to retrieve information about.
required:
- CloudConnectorId
ResourceNotFoundException:
type: object
properties:
Message:
type: string
Tag:
type: object
properties:
Key:
type: string
description: The name of the tag.
Value:
type: string
description: The value of the tag.
required:
- Key
- Value
AzureSubscription:
type: object
properties:
Id:
type: string
description: The ID of the Azure subscription.
DisplayName:
type: string
description: The display name of the Azure subscription.
required:
- Id
AzureConfiguration:
type: object
properties:
TenantId:
type: string
description: The ID of the Azure tenant.
TenantDisplayName:
type: string
description: The display name of the Azure tenant.
ApplicationId:
type: string
description: The ID of the Azure application registration used for authentication.
ApplicationDisplayName:
type: string
description: The display name of the Azure application registration.
Targets:
$ref: '#/components/schemas/ConfigurationTargets'
required:
- TenantId
- ApplicationId
CreateCloudConnectorRequest:
type: object
properties:
DisplayName:
type: string
description: A friendly name for the cloud connector.
RoleArn:
type: string
description: The Amazon Resource Name (ARN) of the IAM role that the cloud connector uses to communicate with the third-party cloud environment.
Description:
type: string
description: A description for the cloud connector.
Configuration:
$ref: '#/components/schemas/CloudConnectorConfiguration'
ConfigConnectorArn:
type: string
description: The ARN of the Amazon Web Services Config connector associated with this cloud connector.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment.
required:
- DisplayName
- RoleArn
- Configuration
- ConfigConnectorArn
CloudConnectorSummary:
type: object
properties:
CloudConnectorId:
type: string
description: The ID of the cloud connector.
DisplayName:
type: string
description: The friendly name of the cloud connector.
Description:
type: string
description: The description of the cloud connector.
RoleArn:
type: string
description: The ARN of the IAM role used by the cloud connector.
CreatedAt:
type: string
format: date-time
description: The date and time the cloud connector was created.
UpdatedAt:
type: string
format: date-time
description: The date and time the cloud connector was last updated.
DeleteCloudConnectorRequest:
type: object
properties:
CloudConnectorId:
type: string
description: The ID of the cloud connector to delete.
required:
- CloudConnectorId
GetCloudConnectorResult:
type: object
properties:
CloudConnectorArn:
type: string
description: The ARN of the cloud connector.
DisplayName:
type: string
description: The friendly name of the cloud connector.
Description:
type: string
description: The description of the cloud connector.
RoleArn:
type: string
description: The ARN of the IAM role used by the cloud connector.
Configuration:
$ref: '#/components/schemas/CloudConnectorConfiguration'
ConfigConnectorArn:
type: string
description: The ARN of the Amazon Web Services Config connector associated with this cloud connector.
CreatedAt:
type: string
format: date-time
description: The date and time the cloud connector was created.
UpdatedAt:
type: string
format: date-time
description: The date and time the cloud connector was last updated.
InternalServerError:
type: object
properties:
Message:
type: string
UpdateCloudConnectorResult:
type: object
properties:
CloudConnectorId:
type: string
description: The ID of the cloud connector that was updated.
CloudConnectorFilter:
type: object
properties:
FilterKey:
type: string
enum:
- SubscriptionId
- TenantId
description: The name of the filter key.
FilterValues:
type: array
items:
type: string
description: 'The filter values. Valid values for each filter key are as follows: SubscriptionId The Azure subscription ID to filter by. To return only tenant-level connectors, specify NONE. TenantId The Azure tenant ID to filter by. Filters the results to connectors that target the specified tenant.'
ValidateCloudConnectorResult:
type: object
properties:
ValidationFindings:
type: array
items:
$ref: '#/components/schemas/ValidationFinding'
description: A list of validation findings for the cloud connector.
NextToken:
type: string
description: The token to use when requesting the next set of items.
ValidationFindingScope:
type: object
properties:
Type:
type: string
enum:
- azure:tenant
- azure:subscription
description: The type of the resource scope.
Id:
type: string
description: The ID of the resource within the scope.
ListCloudConnectorsRequest:
type: object
properties:
MaxResults:
type: integer
description: The maximum number of items to return for this call.
NextToken:
type: string
description: The token for the next set of items to return. (You received this token from a previous call.)
Filters:
type: array
items:
$ref: '#/components/schemas/CloudConnectorFilter'
description: One or more filters to limit the cloud connectors returned in the response.
CreateCloudConnectorResult:
type: object
properties:
CloudConnectorId:
type: string
description: The ID of the cloud connector that was created.
UpdateCloudConnectorRequest:
type: object
properties:
CloudConnectorId:
type: string
description: The ID of the cloud connector to update.
DisplayName:
type: string
description: A new friendly name for the cloud connector.
Configuration:
$ref: '#/components/schemas/CloudConnectorConfiguration'
Description:
type: string
description: A new description for the cloud connector.
required:
- CloudConnectorId
ConflictException:
type: object
properties:
Message:
type: string
CloudConnectorConfiguration:
type: object
properties:
AzureConfiguration:
$ref: '#/components/schemas/AzureConfiguration'
description: Exactly one member is set.
ValidateCloudConnectorRequest:
type: object
properties:
CloudConnectorId:
type: string
description: The ID of the cloud connector to validate.
MaxResults:
type: integer
description: The maximum number of validation findings to return.
NextToken:
type: string
description: The token for the next set of items to return. (You received this token from a previous call.)
required:
- CloudConnectorId
ListCloudConnectorsResult:
type: object
properties:
CloudConnectors:
type: array
items:
$ref: '#/components/schemas/CloudConnectorSummary'
description: A list of cloud connector summary objects.
NextToken:
type: string
description: The token to use when requesting the next set of items.
ConfigurationTargets:
type: object
properties:
Subscriptions:
type: array
items:
$ref: '#/components/schemas/AzureSubscription'
description: A list of Azure subscriptions to target.
description: Exactly one member is set.
ValidationFinding:
type: object
properties:
Type:
type: string
enum:
- INFO
- WARN
- ERROR
description: The type of the validation finding.
Code:
type: string
enum:
- TargetInaccessible
- TargetUnusable
- TargetStateWarning
- AwsRoleAssumptionFailed
- WebIdentityTokenFailed
- OutboundWebIdentityFederationDisabled
- ProviderCredentialCreationFailed
- TenantSummary
- SubscriptionAccessible
description: A code that identifies the specific validation finding.
Message:
type: string
description: A message that describes the validation finding.
ProviderMessage:
type: string
description: A message from the third-party cloud provider related to the validation finding.
Scope:
$ref: '#/components/schemas/ValidationFindingScope'
DeleteCloudConnectorResult:
type: object
properties:
CloudConnectorId:
type: string
description: The ID of the cloud connector that was deleted.
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: ssm
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/ssm/service/2014-11-06/ssm-2014-11-06.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)