Amazon Systems Manager Systems Manager Resource Data Sync API

openapi: 3.2.0
info:
  title: Amazon Simple Systems Manager (SSM) Resource Data Sync API
  version: '2014-11-06'
  description: Generated from AWS's published Smithy model for Amazon Simple Systems Manager (SSM). 4 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: Resource Data Sync
paths:
  /#CreateResourceDataSync:
    post:
      operationId: CreateResourceDataSync
      summary: Create Resource Data Sync
      description: 'A resource data sync helps you view data from multiple sources in a single location. Amazon Web Services Systems Manager offers two types of resource data sync: SyncToDestination and SyncFromSource. You can configure Systems Manager Inventory to use the SyncToDestination type to synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Creating a resource data sync for Inventory in the Amazon Web Services Systems Manager User Guide. You can configure Systems Manager Explorer to use the SyncFromSource type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a single Amazon S3 bucket. This type can synchronize OpsItems and OpsData from multiple Amazon Web Services accounts and Amazon Web Services Regions or EntireOrganization by using Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide. A resource data sync is an asynchronous operation that returns immediately. After a successful initial'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateResourceDataSyncResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: ResourceDataSyncAlreadyExistsException; ResourceDataSyncCountExceededException; ResourceDataSyncInvalidConfigurationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceDataSyncAlreadyExistsException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.CreateResourceDataSync
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateResourceDataSyncRequest'
      tags:
      - Resource Data Sync
  /#DeleteResourceDataSync:
    post:
      operationId: DeleteResourceDataSync
      summary: Delete Resource Data Sync
      description: Deletes a resource data sync configuration. After the configuration is deleted, changes to data on managed nodes are no longer synced to or from the target. Deleting a sync configuration doesn't delete data.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteResourceDataSyncResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: ResourceDataSyncInvalidConfigurationException; ResourceDataSyncNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceDataSyncInvalidConfigurationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.DeleteResourceDataSync
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteResourceDataSyncRequest'
      tags:
      - Resource Data Sync
  /#ListResourceDataSync:
    post:
      operationId: ListResourceDataSync
      summary: List Resource Data Sync
      description: Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed. The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListResourceDataSyncResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: InvalidNextToken; ResourceDataSyncInvalidConfigurationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidNextToken'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.ListResourceDataSync
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListResourceDataSyncRequest'
      tags:
      - Resource Data Sync
  /#UpdateResourceDataSync:
    post:
      operationId: UpdateResourceDataSync
      summary: Update Resource Data Sync
      description: Update a resource data sync. After you create a resource data sync for a Region, you can't change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can't edit that sync later and choose the Include all accounts from my Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one. This API operation only supports a resource data sync that was created with a SyncFromSource SyncType.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateResourceDataSyncResult'
        '500':
          description: InternalServerError
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '400':
          description: ResourceDataSyncConflictException; ResourceDataSyncInvalidConfigurationException; ResourceDataSyncNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ResourceDataSyncConflictException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AmazonSSM.UpdateResourceDataSync
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateResourceDataSyncRequest'
      tags:
      - Resource Data Sync
components:
  schemas:
    DeleteResourceDataSyncRequest:
      type: object
      properties:
        SyncName:
          type: string
          description: The name of the configuration to delete.
        SyncType:
          type: string
          description: Specify the type of resource data sync to delete.
      required:
      - SyncName
    ResourceDataSyncS3Destination:
      type: object
      properties:
        BucketName:
          type: string
          description: The name of the S3 bucket where the aggregated data is stored.
        Prefix:
          type: string
          description: An Amazon S3 prefix for the bucket.
        SyncFormat:
          type: string
          enum:
          - JsonSerDe
          description: 'A supported sync format. The following format is currently supported: JsonSerDe'
        Region:
          type: string
          description: The Amazon Web Services Region with the S3 bucket targeted by the resource data sync.
        AWSKMSKeyARN:
          type: string
          description: The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.
        DestinationDataSharing:
          $ref: '#/components/schemas/ResourceDataSyncDestinationDataSharing'
      required:
      - BucketName
      - SyncFormat
      - Region
    ResourceDataSyncSource:
      type: object
      properties:
        SourceType:
          type: string
          description: The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in Organizations) or SingleAccountMultiRegions.
        AwsOrganizationsSource:
          $ref: '#/components/schemas/ResourceDataSyncAwsOrganizationsSource'
        SourceRegions:
          type: array
          items:
            type: string
          description: The SyncSource Amazon Web Services Regions included in the resource data sync.
        IncludeFutureRegions:
          type: boolean
          description: Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.
        EnableAllOpsDataSources:
          type: boolean
          description: When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in your organization (or in the selected organization units). For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.
      required:
      - SourceType
      - SourceRegions
    UpdateResourceDataSyncRequest:
      type: object
      properties:
        SyncName:
          type: string
          description: The name of the resource data sync you want to update.
        SyncType:
          type: string
          description: The type of resource data sync. The supported SyncType is SyncFromSource.
        SyncSource:
          $ref: '#/components/schemas/ResourceDataSyncSource'
      required:
      - SyncName
      - SyncType
      - SyncSource
    ResourceDataSyncSourceWithState:
      type: object
      properties:
        SourceType:
          type: string
          description: The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in Organizations) or singleAccountMultiRegions.
        AwsOrganizationsSource:
          $ref: '#/components/schemas/ResourceDataSyncAwsOrganizationsSource'
        SourceRegions:
          type: array
          items:
            type: string
          description: The SyncSource Amazon Web Services Regions included in the resource data sync.
        IncludeFutureRegions:
          type: boolean
          description: Whether to automatically synchronize and aggregate data from new Amazon Web Services Regions when those Regions come online.
        State:
          type: string
          description: 'The data type name for including resource data sync state. There are four sync states: OrganizationNotExists: Your organization doesn''t exist. NoPermissions: The system can''t locate the service-linked role. This role is automatically created when a user creates a resource data sync in Explorer. InvalidOrganizationalUnit: You specified or selected an invalid unit in the resource data sync configuration. TrustedAccessDisabled: You disabled Systems Manager access in the organization in Organizations.'
        EnableAllOpsDataSources:
          type: boolean
          description: When you create a resource data sync, if you choose one of the Organizations options, then Systems Manager automatically enables all OpsData sources in the selected Amazon Web Services Regions for all Amazon Web Services accounts in your organization (or in the selected organization units). For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the Amazon Web Services Systems Manager User Guide.
    CreateResourceDataSyncResult:
      type: object
      properties: {}
    ResourceDataSyncDestinationDataSharing:
      type: object
      properties:
        DestinationDataSharingType:
          type: string
          description: The sharing data type. Only Organization is supported.
    DeleteResourceDataSyncResult:
      type: object
      properties: {}
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
    ResourceDataSyncAwsOrganizationsSource:
      type: object
      properties:
        OrganizationSourceType:
          type: string
          description: If an Amazon Web Services organization is present, this is either OrganizationalUnits or EntireOrganization. For OrganizationalUnits, the data is aggregated from a set of organization units. For EntireOrganization, the data is aggregated from the entire Amazon Web Services organization.
        OrganizationalUnits:
          type: array
          items:
            $ref: '#/components/schemas/ResourceDataSyncOrganizationalUnit'
          description: The Organizations organization units included in the sync.
      required:
      - OrganizationSourceType
    ListResourceDataSyncResult:
      type: object
      properties:
        ResourceDataSyncItems:
          type: array
          items:
            $ref: '#/components/schemas/ResourceDataSyncItem'
          description: A list of your current resource data sync configurations and their statuses.
        NextToken:
          type: string
          description: The token for the next set of items to return. Use this token to get the next set of results.
    ResourceDataSyncAlreadyExistsException:
      type: object
      properties:
        SyncName:
          type: string
    ListResourceDataSyncRequest:
      type: object
      properties:
        SyncType:
          type: string
          description: View a list of resource data syncs according to the sync type. Specify SyncToDestination to view resource data syncs that synchronize data to an Amazon S3 bucket. Specify SyncFromSource to view resource data syncs from Organizations or from multiple Amazon Web Services Regions.
        NextToken:
          type: string
          description: A token to start the list. Use this token to get the next set of results.
        MaxResults:
          type: integer
          description: The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
    CreateResourceDataSyncRequest:
      type: object
      properties:
        SyncName:
          type: string
          description: A name for the configuration.
        S3Destination:
          $ref: '#/components/schemas/ResourceDataSyncS3Destination'
        SyncType:
          type: string
          description: Specify SyncToDestination to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify SyncToDestination, you must provide a value for S3Destination. Specify SyncFromSource to synchronize data from a single account and multiple Regions, or multiple Amazon Web Services accounts and Amazon Web Services Regions, as listed in Organizations for Explorer. If you specify SyncFromSource, you must provide a value for SyncSource. The default value is SyncToDestination.
        SyncSource:
          $ref: '#/components/schemas/ResourceDataSyncSource'
      required:
      - SyncName
    UpdateResourceDataSyncResult:
      type: object
      properties: {}
    ResourceDataSyncInvalidConfigurationException:
      type: object
      properties:
        Message:
          type: string
    ResourceDataSyncConflictException:
      type: object
      properties:
        Message:
          type: string
    InvalidNextToken:
      type: object
      properties:
        Message:
          type: string
    ResourceDataSyncOrganizationalUnit:
      type: object
      properties:
        OrganizationalUnitId:
          type: string
          description: The Organizations unit ID data source for the sync.
    ResourceDataSyncItem:
      type: object
      properties:
        SyncName:
          type: string
          description: The name of the resource data sync.
        SyncType:
          type: string
          description: The type of resource data sync. If SyncType is SyncToDestination, then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from Organizations or from multiple Amazon Web Services Regions.
        SyncSource:
          $ref: '#/components/schemas/ResourceDataSyncSourceWithState'
        S3Destination:
          $ref: '#/components/schemas/ResourceDataSyncS3Destination'
        LastSyncTime:
          type: string
          format: date-time
          description: The last time the configuration attempted to sync (UTC).
        LastSuccessfulSyncTime:
          type: string
          format: date-time
          description: The last time the sync operations returned a status of SUCCESSFUL (UTC).
        SyncLastModifiedTime:
          type: string
          format: date-time
          description: The date and time the resource data sync was changed.
        LastStatus:
          type: string
          enum:
          - Successful
          - Failed
          - InProgress
          description: The status reported by the last sync.
        SyncCreatedTime:
          type: string
          format: date-time
          description: The date and time the configuration was created (UTC).
        LastSyncStatusMessage:
          type: string
          description: The status message details reported by the last sync.
  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)