The #X Amz Target=DirectoryService 20150416.DescribeUpdateDirectory API from Amazon Directory Service — 1 operation(s) for #x amz target=directoryservice 20150416.describeupdatedirectory.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/amazon-directory-service-x-amz-target-directoryservice-20150416-describeupdatedirectory-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
version: 1.0.0
x-release: v4
title: 'AWS Directory Service #X Amz Target=DirectoryService 20150416.AcceptSharedDirectory #X Amz Target=DirectoryService 20150416.AcceptSharedDirectory #X Amz Target=DirectoryService 20150416.DescribeUpdateDirectory #X Amz Target=DirectoryService 20150416.DescribeUpdateDirectory #X Amz Target=DirectoryService 20150416.DescribeUpdateDirectory API'
description: <fullname>Directory Service</fullname> <p>Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active Directory. This guide provides detailed information about Directory Service operations, data types, parameters, and errors. For information about Directory Services features, see <a href="https://aws.amazon.com/directoryservice/">Directory Service</a> and the <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html">Directory Service Administration Guide</a>.</p> <note> <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p> </note>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: ds
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/ds-2015-04-16.normal.json
converter:
url: https://github.com/mermade/aws2openapi
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://ds.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Directory Service multi-region endpoint
- url: https://ds.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Directory Service multi-region endpoint
- url: http://ds.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Directory Service endpoint for China (Beijing) and China (Ningxia)
- url: https://ds.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Directory Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=DirectoryService 20150416.DescribeUpdateDirectory'
paths:
/#X-Amz-Target=DirectoryService_20150416.DescribeUpdateDirectory:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeUpdateDirectory
description: ' Describes the updates of a directory for a particular update type. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeUpdateDirectoryResult'
'480':
description: DirectoryDoesNotExistException
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryDoesNotExistException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: ClientException
content:
application/json:
schema:
$ref: '#/components/schemas/ClientException'
'484':
description: ServiceException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceException'
'485':
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeUpdateDirectoryRequest'
parameters:
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- DirectoryService_20150416.DescribeUpdateDirectory
tags:
- '#X Amz Target=DirectoryService 20150416.DescribeUpdateDirectory'
components:
schemas:
ClientException: {}
OSUpdateSettings:
type: object
properties:
OSVersion:
allOf:
- $ref: '#/components/schemas/OSVersion'
- description: ' OS version that the directory needs to be updated to. '
description: ' OS version that the directory needs to be updated to. '
UpdateStatus:
type: string
enum:
- Updated
- Updating
- UpdateFailed
InvalidNextTokenException: {}
InvalidParameterException: {}
ServiceException: {}
DescribeUpdateDirectoryResult:
type: object
properties:
UpdateActivities:
allOf:
- $ref: '#/components/schemas/UpdateActivities'
- description: ' The list of update activities on a directory for the requested update type. '
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: ' If not null, more results are available. Pass this value for the <code>NextToken</code> parameter. '
UpdateStatusReason:
type: string
NextToken:
type: string
OSVersion:
type: string
enum:
- SERVER_2012
- SERVER_2019
UpdateInfoEntry:
type: object
properties:
Region:
allOf:
- $ref: '#/components/schemas/RegionName'
- description: ' The name of the Region. '
Status:
allOf:
- $ref: '#/components/schemas/UpdateStatus'
- description: ' The status of the update performed on the directory. '
StatusReason:
allOf:
- $ref: '#/components/schemas/UpdateStatusReason'
- description: ' The reason for the current status of the update type activity. '
InitiatedBy:
allOf:
- $ref: '#/components/schemas/InitiatedBy'
- description: ' This specifies if the update was initiated by the customer or by the service team. '
NewValue:
allOf:
- $ref: '#/components/schemas/UpdateValue'
- description: ' The new value of the target setting. '
PreviousValue:
allOf:
- $ref: '#/components/schemas/UpdateValue'
- description: ' The old value of the target setting. '
StartTime:
allOf:
- $ref: '#/components/schemas/StartDateTime'
- description: ' The start time of the <code>UpdateDirectorySetup</code> for the particular type. '
LastUpdatedDateTime:
allOf:
- $ref: '#/components/schemas/LastUpdatedDateTime'
- description: ' The last updated date and time of a particular directory setting. '
description: ' An entry of update information related to a requested update type. '
DirectoryId:
type: string
pattern: ^d-[0-9a-f]{10}$
UpdateValue:
type: object
properties:
OSUpdateSettings:
allOf:
- $ref: '#/components/schemas/OSUpdateSettings'
- description: ' The OS update related settings. '
description: ' The value for a given type of <code>UpdateSettings</code>. '
DescribeUpdateDirectoryRequest:
type: object
required:
- DirectoryId
- UpdateType
title: DescribeUpdateDirectoryRequest
properties:
DirectoryId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: ' The unique identifier of the directory. '
UpdateType:
allOf:
- $ref: '#/components/schemas/UpdateType'
- description: ' The type of updates you want to describe for the directory. '
RegionName:
allOf:
- $ref: '#/components/schemas/RegionName'
- description: ' The name of the Region. '
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: ' The <code>DescribeUpdateDirectoryResult</code>. NextToken value from a previous call to <a>DescribeUpdateDirectory</a>. Pass null if this is the first call. '
UpdateActivities:
type: array
items:
$ref: '#/components/schemas/UpdateInfoEntry'
LastUpdatedDateTime:
type: string
format: date-time
RegionName:
type: string
minLength: 8
maxLength: 32
DirectoryDoesNotExistException: {}
AccessDeniedException: {}
StartDateTime:
type: string
format: date-time
InitiatedBy:
type: string
UpdateType:
type: string
enum:
- OS
parameters:
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/ds/
x-hasEquivalentPaths: true