openapi: 3.2.0 info: title: CoreStack External Aws Ssm API version: 1.0.0 termsOfService: http://corestack.io/ license: name: CoreStack Inc License url: http://corestack.io/licenses/LICENSE-2.0.html description: Manage AWS SSM servers: - url: / tags: - name: AwsSsm description: Manage AWS SSM paths: /v1/runbook/{tenant_id}/AWS/document/{document_id}/versions/batch: parameters: - name: tenant_id in: path required: true schema: type: string - name: document_id in: path required: true schema: type: string post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Generated content: application/json: schema: $ref: '#/components/schemas/AwsSsmDocumentVersionBatchResponse' summary: Batch Document versions description: List document version batches operationId: DocumentVersionsBatch security: - auth_token: [] tags: - AwsSsm requestBody: content: application/json: schema: $ref: '#/components/schemas/RecordIdentityBatchRequest' required: true /v1/runbook/{tenant_id}/AWS/document/{document_id}/versions/history: parameters: - name: tenant_id in: path required: true schema: type: string - name: document_id in: path required: true schema: type: string get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Fetched content: application/json: schema: type: array items: $ref: '#/components/schemas/AwsSsmListDocumentVersion' summary: List Document versions description: List all document versions operationId: DocumentVersionsList security: - auth_token: [] tags: - AwsSsm /v1/runbook/{tenant_id}/AWS/document/{document_type}/filters: parameters: - name: tenant_id in: path required: true schema: type: string - name: document_type in: path required: true schema: type: string get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Generated content: application/json: schema: $ref: '#/components/schemas/AwsSsmDocumentFilter' summary: List document filters description: List Document Filters operationId: ListDocumentFilters security: - auth_token: [] tags: - AwsSsm /v1/runbook/{tenant_id}/AWS/documents/batch: parameters: - name: tenant_id in: path required: true schema: type: string post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Fetched content: application/json: schema: $ref: '#/components/schemas/AwsSsmDocumentsBatchResponse' summary: Batch SSM Documents description: List all SSM document batches operationId: DocumentBatch security: - auth_token: [] tags: - AwsSsm requestBody: content: application/json: schema: $ref: '#/components/schemas/RecordIdentityBatchRequest' required: true /v1/runbook/{tenant_id}/AWS/documents/execution/batch: parameters: - name: tenant_id in: path required: true schema: type: string post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Generated content: application/json: schema: $ref: '#/components/schemas/AwsSsmDocumentExecutionBatchResponse' summary: Batch executions description: List all document execution batches operationId: ExecutionBatch security: - auth_token: [] tags: - AwsSsm requestBody: content: application/json: schema: $ref: '#/components/schemas/RecordIdentityBatchRequest' required: true /v1/runbook/{tenant_id}/AWS/documents/execution/list: parameters: - name: tenant_id in: path required: true schema: type: string post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Generated content: application/json: schema: $ref: '#/components/schemas/ListResponse' summary: List executions description: List all document executions operationId: ExecutionList security: - auth_token: [] tags: - AwsSsm requestBody: content: application/json: schema: $ref: '#/components/schemas/AwsSsmListDocumentExecutionRequest' required: true /v1/runbook/{tenant_id}/AWS/documents/list: parameters: - name: tenant_id in: path required: true schema: type: string post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Fetched content: application/json: schema: $ref: '#/components/schemas/ListResponse' summary: List Documents description: List all SSM Documents operationId: DocumentList security: - auth_token: [] tags: - AwsSsm requestBody: content: application/json: schema: $ref: '#/components/schemas/AwsSsmListDocumentsRequest' required: true /v1/runbook/{tenant_id}/AWS/documents/sync: parameters: - name: tenant_id in: path required: true schema: type: string post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Fetched content: application/json: schema: $ref: '#/components/schemas/AwsSsmDocumentSyncResponse' summary: Manual document sync description: Sync SSM Documents for mentioned cloud accounts operationId: DocumentSync security: - auth_token: [] tags: - AwsSsm requestBody: content: application/json: schema: $ref: '#/components/schemas/AwsSsmDocumentSyncRequest' required: true /v1/runbook/{tenant_id}/AWS/execution/filters/{document_type}: parameters: - name: tenant_id in: path required: true schema: type: string - name: document_type in: path required: true schema: type: string get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Generated content: application/json: schema: $ref: '#/components/schemas/AwsSsmExecutionFilter' summary: List execution filters description: List Execution Filters operationId: listExecutionFilters security: - auth_token: [] tags: - AwsSsm /v1/runbook/{tenant_id}/AWS/execution/group/batch: parameters: - name: tenant_id in: path required: true schema: type: string post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Generated content: application/json: schema: $ref: '#/components/schemas/AwsSsmExecutionGroupBatchResponse' summary: Batch execution job groups description: List all document execution group batches operationId: ExecutionGroupsBatch security: - auth_token: [] tags: - AwsSsm requestBody: content: application/json: schema: $ref: '#/components/schemas/RecordIdentityBatchRequest' required: true /v1/runbook/{tenant_id}/AWS/execution/group/list: parameters: - name: tenant_id in: path required: true schema: type: string post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Fetched content: application/json: schema: $ref: '#/components/schemas/ListResponse' summary: List execution job groups description: List all document execution groups operationId: ExecutionGroupsList security: - auth_token: [] tags: - AwsSsm requestBody: content: application/json: schema: $ref: '#/components/schemas/AwsSsmListExecutionGroupRequest' required: true components: schemas: AwsSsmDocumentFilter: allOf: - $ref: '#/components/schemas/AwsSsmBaseDocumentFilter' - properties: owners: type: array description: The AWS user that created the document. items: type: string categories: type: array description: The classification of a document to help you identify and categorize its use. items: type: string platform_types: type: array description: The list of operating system (OS) platforms compatible with available SSM documents. items: type: string filters: description: Account filters for the tags $ref: '#/components/schemas/AwsSsmDocumentQueryFilters' type: object x-cs-type-name: AwsSsmDocumentFilter AwsSsmJobGroup: properties: sysId: type: string description: Id of the Group Executions status: type: string description: Status of the Job Group example: in_progress enum: - in_progress - completed x-cs-enum-type: AwsSsmJobGroupStatus document_id: type: string description: Document id from the ssm_docs collection document_version: type: string description: Document version id from the ssm_docs_version collection document_type: type: string description: Type of the document example: Command enum: - Command - Automation x-cs-enum-type: AwsSsmJobGroupDocumentType created_at: type: string format: date-time description: The date when the job was fetched created_by: type: string description: Name of the user who executed the document updated_at: type: string format: date-time description: Date when the document was last updated updated_by: type: string description: Name of the user who updated the execution change_id: type: string description: Service Now tracking id type: object AwsSsmBaseExecution: required: - flavor properties: inputs: type: object additionalProperties: type: string targets: type: array description: Details of the target. items: $ref: '#/components/schemas/AwsSsmTarget' max_concurrency: type: string max_errors: type: string description: The maximum number of errors allowed without the command failing. discriminator: propertyName: flavor type: object x-cs-subtypes: - subtype_model: AwsSsmCommandExecution subtype_name: AwsSsmCommandExecution - subtype_model: AwsSsmAutomationExecution subtype_name: AwsSsmAutomationExecution AwsSsmTarget: properties: key: type: string description: Type of the target resource for execution of command document values: type: array description: Target resource details items: type: string type: object AwsSsmDocumentPermissionDetail: properties: account_ids: type: array description: 'AWS account ids ' items: type: string account_sharing_info: type: array description: AWS account details items: $ref: '#/components/schemas/AwsSsmDocumentAccountShared' type: object AwsSsmDocumentQueryFilters: properties: regions: type: array description: Regions based on the available documents (all if missing) items: type: string owners: type: array description: The AWS user that created the document (all if missing) items: type: string categories: type: array description: The classification of a document to help you identify and categorize its use (all if missing) items: type: string type: object AwsSsmExecutionFilters: properties: group_job_ids: type: array description: List of group job ids. items: type: string parent_job_ids: type: array description: List of parent job ids. items: type: string cloud_account_ids: type: array description: List of ids of the cloud account. items: type: string regions: type: array description: region of the document to be executed. items: type: string document_ids: type: array description: Name of the document. items: type: string document_types: type: array description: Type of the executed document items: type: string executed_by: type: array description: IAM ARN of the user who executed the document items: type: string status: type: string description: Status of the Automation Execution example: Pending enum: - Pending - InProgress - Waiting - Success - TimedOut - Cancelling - Cancelled - Failed - PendingApproval - Approved - Rejected - Scheduled - RunbookInProgress - PendingChangeCalendarOverride - ChangeCalendarOverrideApproved - ChangeCalendarOverrideRejected - CompletedWithSuccess - CompletedWithFailure x-cs-enum-type: AwsSsmAutomationExecutionStatus text_query: type: string description: Text query for Document Executions list. Search by Execution Id and Document Name query_filter: $ref: '#/components/schemas/QueryOperator' type: object AwsSsmCloudAccount: properties: id: type: string description: Id of the cloud account. name: type: string description: Name of the cloud account. sync_status: $ref: '#/components/schemas/AwsSsmCloudAccountSyncDetails' type: object AwsSsmListDocumentsRequestContext: required: - document_types properties: cloud_account_ids: type: array description: id of the cloud accounts. items: type: string regions: type: array description: region of the document to be executed. items: type: string document_names: type: array description: Name of the document. items: type: string owners: type: array description: Owner of the SSM document. items: type: string platform_types: type: array description: Platform types supported for the document. items: type: string document_types: type: array description: Type of the document. items: type: string text_query: type: string description: Text query for SSM Documents List. Search by Document Name, Category and Owner query_filter: $ref: '#/components/schemas/QueryOperator' type: object AwsSsmParameter: properties: name: type: string description: The name of the parameter type: type: string description: Type of the parameter of automation documents example: StringMap enum: - StringMap - MapList - Integer - Boolean - String - StringList - AWS_EC2_Instance_Id - AWS_IAM_Role_Arn - AWS_S3_Bucket_Name x-cs-enum-type: AwsSsmDocumentParameterType description: type: string description: The description of the parameters default_value: type: string description: The default values for the parameters min_items: type: integer description: Minimum number items in parameter max_items: type: integer description: Maximum number items in parameter allowed_values: type: array description: List of allowed values items: type: string display_type: type: string description: Type of display items allowed_pattern: type: string description: Regex patterns of the parameter min_chars: type: integer description: Minimum number of characters in the parameters max_chars: type: integer description: Maximum number of characters in the parameters type: object AwsSsmListDocumentsSortCriteria: required: - column properties: column: type: string example: name enum: - name x-cs-enum-type: AwsSsmListDocumentsSortColumn ascending: type: boolean type: object AwsSsmDocumentsBatchResponse: properties: results: type: object description: Map from identifier to response model additionalProperties: $ref: '#/components/schemas/AwsSsmDocument' type: object AwsSsmDocumentExecutionBatchResponse: properties: results: type: object description: Map from identifier to response model additionalProperties: $ref: '#/components/schemas/AwsSsmJob' type: object ModelError: required: - message properties: message: type: string description: Error response message. type: object AwsSsmListDocumentsRequest: properties: list_context: description: Optional list context $ref: '#/components/schemas/ListContext' sort: type: array description: Sort criteria items: $ref: '#/components/schemas/AwsSsmListDocumentsSortCriteria' filters: description: Filters for the request $ref: '#/components/schemas/AwsSsmListDocumentsRequestContext' type: object AwsSsmBaseDocumentFilter: required: - flavor properties: cloud_account_details: type: array description: Id and name of the cloud accounts. items: $ref: '#/components/schemas/AwsSsmCloudAccount' regions: type: array description: Regions based on the available documents. items: type: string discriminator: propertyName: flavor type: object x-cs-subtypes: - subtype_model: AwsSsmExecutionFilter subtype_name: AwsSsmExecutionFilter - subtype_model: AwsSsmAutomationFilter subtype_name: AwsSsmAutomationFilter - subtype_model: AwsSsmCommandFilter subtype_name: AwsSsmCommandFilter - subtype_model: AwsSsmDocumentFilter subtype_name: AwsSsmDocumentFilter AwsSsmExecutionGroupBatchResponse: properties: results: type: object description: Map from identifier to response model additionalProperties: $ref: '#/components/schemas/AwsSsmJobGroup' type: object AwsSsmDocument: properties: sysId: type: string description: Id of the document. name: type: string description: Name of the document. categories: type: array description: Category of the document. items: type: string document_type: type: string description: Type of the document. owner: type: string description: Owner of the document. os_types: type: array description: Platform of the document can be executed. items: type: string scope: type: string description: Scope of the SSM document. cloud_account_id: type: string description: For private, self type of documents the cloud account id will be mapped region: type: string description: For non global document region based mapping will be there document_creation_time: type: string format: date-time description: Time of document creation latest_version: type: string description: Latest version of the document default_version: type: string description: The default version document_version: type: string description: Current document version that is viewing status: type: string description: Status of the document example: Creating enum: - Creating - Active - Updating - Deleting - Failed - Deleted x-cs-enum-type: AwsSsmAutomationDocumentStatus tags: type: array description: Tag key and Value pair available for the document items: $ref: '#/components/schemas/AwsSsmDocumentTag' permission_details: description: Permission details of the Document. $ref: '#/components/schemas/AwsSsmDocumentPermissionDetail' created_at: type: string format: date-time description: Time of the document synced with system. updated_at: type: string format: date-time description: last synced time of the document. type: object RecordIdentityBatchRequest: properties: ids: type: array items: $ref: '#/components/schemas/RecordIdentity' type: object RecordIdentity: properties: sysId: type: string description: Unique Identifier of the tracked item lastUpdate: type: string format: date-time description: Last update of the tracked item table: type: string description: Context of the tracked item type: object AwsSsmListDocumentExecutionRequest: properties: list_context: description: Optional list context $ref: '#/components/schemas/ListContext' sort: type: array description: Sort criteria items: $ref: '#/components/schemas/AwsSsmListDocumentExecutionsSortCriteria' filters: description: Filters for the request $ref: '#/components/schemas/AwsSsmExecutionFilters' type: object AwsSsmDocumentVersion: properties: content: type: string description: A structure that includes attributes that describe a document attachment document_version: type: string description: The document version document_format: type: string description: The document format, either JSON or YAML description: type: string description: A description of the document document_id: type: string description: Document ID of SSM docs document_creation_time: type: string format: date-time description: The date the SSM document was created hash: type: string description: The cryptographic hash value of the document content. hash_type: type: string description: The hash algorithm used to calculate the hash value example: Sha256 enum: - Sha256 - Sha1 x-cs-enum-type: AwsSsmHashType schema_version: type: string description: The schema version target_type: type: string description: The target type defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance parameters: type: array description: Parameters specified in a Systems Manager document that run on the server items: $ref: '#/components/schemas/AwsSsmParameter' os_types: type: array description: The list of operating system (OS) platforms items: type: string attachment_contents: type: array description: A description of the document attachments, including names, locations, sizes items: $ref: '#/components/schemas/AwsSsmContentAttachmentDetail' type: object AwsSsmDocumentVersionDetails: allOf: - $ref: '#/components/schemas/AwsSsmDocumentVersion' - properties: sysId: type: string document_creation_time: type: string format: date-time type: object ListContext: properties: batch_size: type: integer description: Max number of ids in the response batch_offset: type: integer description: Offset of batches into the results. First batch is 0 total: type: integer description: Total number of results type: object AwsSsmDocumentTag: properties: key: type: string description: Name for the tag key value: type: string description: Value for the respective tag key type: object AwsSsmListExecutionGroupRequest: properties: list_context: description: Optional list context $ref: '#/components/schemas/ListContext' sort: type: array description: Sort criteria items: $ref: '#/components/schemas/AwsSsmListDocumentExecutionGroupsSortCriteria' filters: description: Filters for the request $ref: '#/components/schemas/AwsSsmExecutionGroupFilters' type: object AwsSsmContentAttachmentDetail: properties: name: type: string description: The name of an attachment. size: type: integer description: The size of an attachment in bytes. hash: type: string description: The cryptographic hash value of the document content. hash_type: type: string description: The hash algorithm used to calculate the hash value example: Sha256 enum: - Sha256 - Sha1 x-cs-enum-type: AwsSsmHashType url: type: string description: The URL location of the attachment content. type: object AwsSsmListDocumentExecutionGroupsSortCriteria: required: - column properties: column: type: string example: created_at enum: - created_at x-cs-enum-type: AwsSsmListDocumentExecutionGroupsSortColumn ascending: type: boolean type: object QueryOperator: required: - __type properties: {} discriminator: propertyName: __type type: object x-cs-subtypes: - subtype_model: QueryOperatorTrue subtype_name: QueryOperatorTrue - subtype_model: QueryOperatorFalse subtype_name: QueryOperatorFalse - subtype_model: QueryOperatorBinary subtype_name: QueryOperatorBinary - subtype_model: QueryOperatorBinaryLogic subtype_name: QueryOperatorBinaryLogic - subtype_model: QueryOperatorNary subtype_name: QueryOperatorNary - subtype_model: QueryOperatorNaryLogic subtype_name: QueryOperatorNaryLogic - subtype_model: QueryOperatorComparator subtype_name: QueryOperatorComparator - subtype_model: QueryOperatorComparatorLogic subtype_name: QueryOperatorComparatorLogic - subtype_model: QueryOperatorUnary subtype_name: QueryOperatorUnary - subtype_model: QueryOperatorUnaryNot subtype_name: QueryOperatorUnaryNot - subtype_model: QueryOperatorBinaryForGraph subtype_name: QueryOperatorBinaryForGraph - subtype_model: QueryOperatorBinaryLogicForGraph subtype_name: QueryOperatorBinaryLogicForGraph - subtype_model: QueryOperatorNaryForGraph subtype_name: QueryOperatorNaryForGraph - subtype_model: QueryOperatorNaryLogicForGraph subtype_name: QueryOperatorNaryLogicForGraph - subtype_model: QueryOperatorUnaryForGraph subtype_name: QueryOperatorUnaryForGraph - subtype_model: QueryOperatorUnaryNotForGraph subtype_name: QueryOperatorUnaryNotForGraph - subtype_model: ServiceAccountQueryOperator subtype_name: ServiceAccountQueryOperator - subtype_model: TenantQueryOperator subtype_name: TenantQueryOperator - subtype_model: DescendantServiceAccountQueryOperator subtype_name: DescendantServiceAccountQueryOperator - subtype_model: DescendantServiceAccountInTenantQueryOperator subtype_name: DescendantServiceAccountInTenantQueryOperator - subtype_model: TenantTagKeyQueryOperator subtype_name: TenantTagKeyQueryOperator - subtype_model: TenantTagKeyValueQueryOperator subtype_name: TenantTagKeyValueQueryOperator - subtype_model: LocationQueryOperator subtype_name: LocationQueryOperator - subtype_model: AvailabilityZoneQueryOperator subtype_name: AvailabilityZoneQueryOperator - subtype_model: BillingSourceQueryOperator subtype_name: BillingSourceQueryOperator - subtype_model: CurrencyQueryOperator subtype_name: CurrencyQueryOperator - subtype_model: ProductCategoryQueryOperator subtype_name: ProductCategoryQueryOperator - subtype_model: ProductFamilyQueryOperator subtype_name: ProductFamilyQueryOperator - subtype_model: ProductServiceCodeQueryOperator subtype_name: ProductServiceCodeQueryOperator - subtype_model: ProductSkuQueryOperator subtype_name: ProductSkuQueryOperator - subtype_model: PublisherQueryOperator subtype_name: PublisherQueryOperator - subtype_model: ResourceCategoryQueryOperator subtype_name: ResourceCategoryQueryOperator - subtype_model: ResourceIdQueryOperator subtype_name: ResourceIdQueryOperator - subtype_model: ResourceGroupQueryOperator subtype_name: ResourceGroupQueryOperator - subtype_model: ResourceNameQueryOperator subtype_name: ResourceNameQueryOperator - subtype_model: ResourceOperationQueryOperator subtype_name: ResourceOperationQueryOperator - subtype_model: ResourceQueryExtraPresence subtype_name: ResourceQueryExtraPresence - subtype_model: ResourceQueryExtraKey subtype_name: ResourceQueryExtraKey - subtype_model: ScopeContainsTenantQueryOperator subtype_name: ScopeContainsTenantQueryOperator - subtype_model: ScopeContainsServiceAccountQueryOperator subtype_name: ScopeContainsServiceAccountQueryOperator - subtype_model: ScopeIsQueryOperator subtype_name: ScopeIsQueryOperator - subtype_model: ServiceCategoryQueryOperator subtype_name: ServiceCategoryQueryOperator - subtype_model: ServiceTypeQueryOperator subtype_name: ServiceTypeQueryOperator - subtype_model: CompartmentNameQueryOperator subtype_name: CompartmentNameQueryOperator - subtype_model: ResourceQueryExtraKeyValue subtype_name: ResourceQueryExtraKeyValue - subtype_model: WorkFlowIdQueryOperator subtype_name: WorkFlowIdQueryOperator - subtype_model: RecommendationSubClassificationQueryOperator subtype_name: RecommendationSubClassificationQueryOperator - subtype_model: ServiceNowCmdbQuerySyncLogResourceId subtype_name: ServiceNowCmdbQuerySyncLogResourceId - subtype_model: ServiceNowCmdbQuerySyncLogResourceType subtype_name: ServiceNowCmdbQuerySyncLogResourceType - subtype_model: ServiceNowCmdbQuerySyncLogAction subtype_name: ServiceNowCmdbQuerySyncLogAction - subtype_model: ServiceNowCmdbQuerySyncLogStatus subtype_name: ServiceNowCmdbQuerySyncLogStatus - subtype_model: ServiceNowCmdbQuerySyncLogService subtype_name: ServiceNowCmdbQuerySyncLogService - subtype_model: ServiceAccountNativeDetailsQueryOperator subtype_name: ServiceAccountNativeDetailsQueryOperator - subtype_model: ServiceAccountStatusQueryOperator subtype_name: ServiceAccountStatusQueryOperator - subtype_model: ServiceAccountTagKeyQueryOperator subtype_name: ServiceAccountTagKeyQueryOperator - subtype_model: ServiceAccountTagKeyRegexQueryOperator subtype_name: ServiceAccountTagKeyRegexQueryOperator - subtype_model: ServiceAccountTagKeyValueQueryOperator subtype_name: ServiceAccountTagKeyValueQueryOperator - subtype_model: ApplicableHealthMetricsQueryOperator subtype_name: ApplicableHealthMetricsQueryOperator - subtype_model: EpssScoreRangeQueryOperator subtype_name: EpssScoreRangeQueryOperator - subtype_model: CvssMetricScoreRangeQueryOperator subtype_name: CvssMetricScoreRangeQueryOperator - subtype_model: GraphionScoreRangeQueryOperator subtype_name: GraphionScoreRangeQueryOperator - subtype_model: AppSecopsApplicationIdQueryOperator subtype_name: AppSecopsApplicationIdQueryOperator - subtype_model: AppSecopsPortfolioIdQueryOperator subtype_name: AppSecopsPortfolioIdQueryOperator - subtype_model: AppSecopsProjectIdQueryOperator subtype_name: AppSecopsProjectIdQueryOperator - subtype_model: AppSecopsSbomComponentIdQueryOperator subtype_name: AppSecopsSbomComponentIdQueryOperator - subtype_model: AppSecopsSbomVersionIdQueryOperator subtype_name: AppSecopsSbomVersionIdQueryOperator - subtype_model: AppSecopsComponentProductQueryOperator subtype_name: AppSecopsComponentProductQueryOperator - subtype_model: AppSecopsSbomComponentTypeQueryOperator subtype_name: AppSecopsSbomComponentTypeQueryOperator - subtype_model: AppSecopsSbomVersionSubmittedByQueryOperator subtype_name: AppSecopsSbomVersionSubmittedByQueryOperator - subtype_model: AppSecopsSbomVersionSubmittedDateQueryOperator subtype_name: AppSecopsSbomVersionSubmittedDateQueryOperator - subtype_model: AppSecopsSbomVersionBuildIdQueryOperator subtype_name: AppSecopsSbomVersionBuildIdQueryOperator - subtype_model: AppSecopsSbomNameQueryOperator subtype_name: AppSecopsSbomNameQueryOperator - subtype_model: AppSecopsCveIdQueryOperator subtype_name: AppSecopsCveIdQueryOperator - subtype_model: AppSecopsEpssScoreQueryOperator subtype_name: AppSecopsEpssScoreQueryOperator - subtype_model: AppSecopsCvssScoreQueryOperator subtype_name: AppSecopsCvssScoreQueryOperator - subtype_model: AppSecopsGraphionScoreQueryOperator subtype_name: AppSecopsGraphionScoreQueryOperator - subtype_model: SecopsVulnerabilitySeverityQueryOperator subtype_name: SecopsVulnerabilitySeverityQueryOperator - subtype_model: AppSecopsIsKnownExploitedVulnerabilityQueryOperator subtype_name: AppSecopsIsKnownExploitedVulnerabilityQueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricAttackVectorV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricAttackVectorV31QueryOperator - subtype_model: AppSecopsFixAvailableQueryOperator subtype_name: AppSecopsFixAvailableQueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricAttackComplexityV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricAttackComplexityV31QueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricPrivilegesRequiredV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricPrivilegesRequiredV31QueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricScopeV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricScopeV31QueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityUserInteractionV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityUserInteractionV31QueryOperator - subtype_model: AppSecopsVulnerabilityImpactMetricConfidentialityImpactV31QueryOperator subtype_name: AppSecopsVulnerabilityImpactMetricConfidentialityImpactV31QueryOperator - subtype_model: AppSecopsVulnerabilityImpactMetricIntegrityImpactV31QueryOperator subtype_name: AppSecopsVulnerabilityImpactMetricIntegrityImpactV31QueryOperator - subtype_model: AppSecopsVulnerabilityImpactMetricAvailabilityImpactV31QueryOperator subtype_name: AppSecopsVulnerabilityImpactMetricAvailabilityImpactV31QueryOperator - subtype_model: AppSecopsContainerFindingsSBOMVersionIdsQueryOperator subtype_name: AppSecopsContainerFindingsSBOMVersionIdsQueryOperator - subtype_model: AppSecopsContainerFindingsCategoryQueryOperator subtype_name: AppSecopsContainerFindingsCategoryQueryOperator - subtype_model: AppSecopsContainerFindingsExecutionPhaseQueryOperator subtype_name: AppSecopsContainerFindingsExecutionPhaseQueryOperator - subtype_model: AppSecopsContainerFindingsSeverityQueryOperator subtype_name: AppSecopsContainerFindingsSeverityQueryOperator - subtype_model: AppSecopsContainerFindingsStatusQueryOperator subtype_name: AppSecopsContainerFindingsStatusQueryOperator - subtype_model: DimensionSourceQueryOperator subtype_name: DimensionSourceQueryOperator - subtype_model: DimensionQueryOperator subtype_name: DimensionQueryOperator - subtype_model: ResourceTypeQueryOperator subtype_name: ResourceTypeQueryOperator - subtype_model: PodIdRegexQueryOperator subtype_name: PodIdRegexQueryOperator - subtype_model: PodNameRegexQueryOperator subtype_name: PodNameRegexQueryOperator - subtype_model: ContainerIdRegexQueryOperator subtype_name: ContainerIdRegexQueryOperator - subtype_model: PodNamesQueryOperator subtype_name: PodNamesQueryOperator - subtype_model: PodIdsQueryOperator subtype_name: PodIdsQueryOperator - subtype_model: UtilizationTypeQueryOperator subtype_name: UtilizationTypeQueryOperator - subtype_model: ResourceIdRegexQueryOperator subtype_name: ResourceIdRegexQueryOperator - subtype_model: ResourceNameRegexQueryOperator subtype_name: ResourceNameRegexQueryOperator - subtype_model: ExtrasValueRegexQueryOperator subtype_name: ExtrasValueRegexQueryOperator - subtype_model: TagKeyValueRegexQueryOperator subtype_name: TagKeyValueRegexQueryOperator - subtype_model: ResourceQueryTagKeyKind subtype_name: ResourceQueryTagKeyKind - subtype_model: ResourceQueryTagKeyValuesKind subtype_name: ResourceQueryTagKeyValuesKind - subtype_model: TagKeyStringValueRegexQueryOperator subtype_name: TagKeyStringValueRegexQueryOperator - subtype_model: TagKindStringKeyRegexQueryOperator subtype_name: TagKindStringKeyRegexQueryOperator - subtype_model: ServiceAccountNameRegexQueryOperator subtype_name: ServiceAccountNameRegexQueryOperator - subtype_model: TenantNameRegexQueryOperator subtype_name: TenantNameRegexQueryOperator - subtype_model: PlatFormAccountQueryOperator subtype_name: PlatFormAccountQueryOperator - subtype_model: BillingLineItemTypeQueryOperator subtype_name: BillingLineItemTypeQueryOperator - subtype_model: BillingEntityQueryOperator subtype_name: BillingEntityQueryOperator - subtype_model: LineItemDescriptionQueryOperator subtype_name: LineItemDescriptionQueryOperator - subtype_model: LineItemDescriptionRegexQueryOperator subtype_name: LineItemDescriptionRegexQueryOperator - subtype_model: MeterSubCategoryQueryOperator subtype_name: MeterSubCategoryQueryOperator - subtype_model: PricingCategoryQueryOperator subtype_name: PricingCategoryQueryOperator - subtype_model: PricingPurchaseOptionQueryOperator subtype_name: PricingPurchaseOptionQueryOperator - subtype_model: TagKeyRegexQueryOperator subtype_name: TagKeyRegexQueryOperator - subtype_model: BillingLineItemTypeRegexQueryOperator subtype_name: BillingLineItemTypeRegexQueryOperator - subtype_model: ResourceGroupRegexQueryOperator subtype_name: ResourceGroupRegexQueryOperator - subtype_model: ResourceCategoryRegexQueryOperator subtype_name: ResourceCategoryRegexQueryOperator - subtype_model: ProductCategoryRegexQueryOperator subtype_name: ProductCategoryRegexQueryOperator - subtype_model: BillingEntityRegexQueryOperator subtype_name: BillingEntityRegexQueryOperator - subtype_model: ResourceOperationRegexQueryOperator subtype_name: ResourceOperationRegexQueryOperator - subtype_model: ResourceQueryFieldPresence subtype_name: ResourceQueryFieldPresence - subtype_model: AssessmentRunReportDetailQuerySection subtype_name: AssessmentRunReportDetailQuerySection - subtype_model: AssessmentRunReportSummaryQuerySection subtype_name: AssessmentRunReportSummaryQuerySection - subtype_model: AssessmentQueryAssessmentName subtype_name: AssessmentQueryAssessmentName - subtype_model: AssessmentQueryAssessmentOwner subtype_name: AssessmentQueryAssessmentOwner - subtype_model: AssessmentQueryAssessmentApprover subtype_name: AssessmentQueryAssessmentApprover - subtype_model: AssessmentQueryWorkload subtype_name: AssessmentQueryWorkload - subtype_model: AssessmentQueryFramework subtype_name: AssessmentQueryFramework - subtype_model: AssessmentQueryPillar subtype_name: AssessmentQueryPillar - subtype_model: AssessmentViewQueryNature subtype_name: AssessmentViewQueryNature - subtype_model: AssessmentViewQueryQuestionRisk subtype_name: AssessmentViewQueryQuestionRisk - subtype_model: AssessmentViewQueryBestPracticeRisk subtype_name: AssessmentViewQueryBestPracticeRisk - subtype_model: AssessmentViewQueryQuestionStatus subtype_name: AssessmentViewQueryQuestionStatus - subtype_model: AssessmentViewQueryBestPracticeStatus subtype_name: AssessmentViewQueryBestPracticeStatus - subtype_model: AssessmentViewQueryOwner subtype_name: AssessmentViewQueryOwner - subtype_model: AssessmentViewQueryAssignedTo subtype_name: AssessmentViewQueryAssignedTo - subtype_model: AssessmentViewQueryComment subtype_name: AssessmentViewQueryComment - subtype_model: AssessmentReportQueryAssessmentName subtype_name: AssessmentReportQueryAssessmentName - subtype_model: AssessmentReportQueryFramework subtype_name: AssessmentReportQueryFramework - subtype_model: AssessmentReportQueryReportType subtype_name: AssessmentReportQueryReportType - subtype_model: AssessmentReportQueryWorkloadId subtype_name: AssessmentReportQueryWorkloadId - subtype_model: ScheduleQueryName subtype_name: ScheduleQueryName - subtype_model: ScheduleQueryCreatedBy subtype_name: ScheduleQueryCreatedBy - subtype_model: ScheduleQueryEmailRecipients subtype_name: ScheduleQueryEmailRecipients - subtype_model: ScheduleQueryRecurrence subtype_name: ScheduleQueryRecurrence - subtype_model: ScheduleQueryReportType subtype_name: ScheduleQueryReportType - subtype_model: ScheduleQueryNextGenReportType subtype_name: ScheduleQueryNextGenReportType - subtype_model: ScheduleQueryAssessmentAgentReportType subtype_name: ScheduleQueryAssessmentAgentReportType - subtype_model: AutomationTemplateQueryEngineType subtype_name: AutomationTemplateQueryEngineType - subtype_model: AutomationTemplateQueryRepoType subtype_name: AutomationTemplateQueryRepoType - subtype_model: AutomationTemplateQueryService subtype_name: AutomationTemplateQueryService - subtype_model: AutomationTemplateQueryTenant subtype_name: AutomationTemplateQueryTenant - subtype_model: AwsSecurityHubFindingQueryLocation subtype_name: AwsSecurityHubFindingQueryLocation - subtype_model: AwsSecurityHubFindingQuerySeverity subtype_name: AwsSecurityHubFindingQuerySeverity - subtype_model: AwsSecurityHubFindingQueryProductName subtype_name: AwsSecurityHubFindingQueryProductName - subtype_model: AwsSecurityHubFindingQueryResource subtype_name: AwsSecurityHubFindingQueryResource - subtype_model: AwsSecurityHubFindingQueryCloudAccount subtype_name: AwsSecurityHubFindingQueryCloudAccount - subtype_model: AwsSecurityHubFindingQueryRecordState subtype_name: AwsSecurityHubFindingQueryRecordState - subtype_model: AwsSsmDocumentQueryCloudAccount subtype_name: AwsSsmDocumentQueryCloudAccount - subtype_model: AwsSsmDocumentQueryRegion subtype_name: AwsSsmDocumentQueryRegion - subtype_model: AwsSsmDocumentQueryOwner subtype_name: AwsSsmDocumentQueryOwner - subtype_model: AwsSsmDocumentQueryCategory subtype_name: AwsSsmDocumentQueryCategory - subtype_model: AwsSsmDocumentQueryStatus subtype_name: AwsSsmDocumentQueryStatus - subtype_model: AwsSsmDocumentQueryName subtype_name: AwsSsmDocumentQueryName - subtype_model: AwsSsmDocumentQueryExecutedBy subtype_name: AwsSsmDocumentQueryExecutedBy - subtype_model: ComplianceURIQueryOperator subtype_name: ComplianceURIQueryOperator - subtype_model: DurationInMonthsQueryOperator subtype_name: DurationInMonthsQueryOperator - subtype_model: UniqueIdQueryOperator subtype_name: UniqueIdQueryOperator - subtype_model: ThreatVulnerabilityStatusQueryOperator subtype_name: ThreatVulnerabilityStatusQueryOperator - subtype_model: ThreatVulnerabilitySeverityQueryOperator subtype_name: ThreatVulnerabilitySeverityQueryOperator - subtype_model: ThreatVulnerabilityIssueTypeQueryOperator subtype_name: ThreatVulnerabilityIssueTypeQueryOperator - subtype_model: ThreatIntentQueryOperator subtype_name: ThreatIntentQueryOperator - subtype_model: VulnerabilityReferenceIdQueryOperator subtype_name: VulnerabilityReferenceIdQueryOperator - subtype_model: CostAnomalyStatusQueryOperator subtype_name: CostAnomalyStatusQueryOperator - subtype_model: CurrencyExchangeConfigurationQuerySourceCurrency subtype_name: CurrencyExchangeConfigurationQuerySourceCurrency - subtype_model: CurrencyExchangeConfigurationQueryTargetCurrency subtype_name: CurrencyExchangeConfigurationQueryTargetCurrency - subtype_model: CurrencyExchangeConfigurationQueryScope subtype_name: CurrencyExchangeConfigurationQueryScope - subtype_model: MetricValuesOperator subtype_name: MetricValuesOperator - subtype_model: PatchReadinessStatusQueryOperator subtype_name: PatchReadinessStatusQueryOperator - subtype_model: MasterAccountBillingQueryMasterAccounts subtype_name: MasterAccountBillingQueryMasterAccounts - subtype_model: MasterAccountBillingQueryTenants subtype_name: MasterAccountBillingQueryTenants - subtype_model: MasterAccountBillingQueryUsers subtype_name: MasterAccountBillingQueryUsers - subtype_model: MasterAccountBillingQueryConversations subtype_name: MasterAccountBillingQueryConversations - subtype_model: MasterAccountBillingQueryTransactionType subtype_name: MasterAccountBillingQueryTransactionType - subtype_model: PolicyResourceRecommendationStatusQueryOperator subtype_name: PolicyResourceRecommendationStatusQueryOperator - subtype_model: PolicyResourceRecommendationPolicyIdsQueryOperator subtype_name: PolicyResourceRecommendationPolicyIdsQueryOperator - subtype_model: PolicyResourceRecommendationSeverityQueryOperator subtype_name: PolicyResourceRecommendationSeverityQueryOperator - subtype_model: PolicyRecommendationClassificationQueryOperator subtype_name: PolicyRecommendationClassificationQueryOperator - subtype_model: InfraResourceTrendResourceChangeStatusQueryOperator subtype_name: InfraResourceTrendResourceChangeStatusQueryOperator - subtype_model: VmAgentsQueryOsTypes subtype_name: VmAgentsQueryOsTypes - subtype_model: VmAgentsQueryInstantState subtype_name: VmAgentsQueryInstantState - subtype_model: VmAgentsQueryQualysStatus subtype_name: VmAgentsQueryQualysStatus - subtype_model: VmAgentsQueryCrowdStrikeStatus subtype_name: VmAgentsQueryCrowdStrikeStatus - subtype_model: VmAgentsQuerySplunkStatus subtype_name: VmAgentsQuerySplunkStatus - subtype_model: StacksMarketplaceStackQueryArchived subtype_name: StacksMarketplaceStackQueryArchived - subtype_model: StacksMarketplaceStackQueryAutoApproved subtype_name: StacksMarketplaceStackQueryAutoApproved - subtype_model: StacksMarketplaceStackQueryOwner subtype_name: StacksMarketplaceStackQueryOwner - subtype_model: StacksMarketplaceStackQueryName subtype_name: StacksMarketplaceStackQueryName - subtype_model: StacksMarketplaceStackQueryProduct subtype_name: StacksMarketplaceStackQueryProduct - subtype_model: StacksMarketplaceDeploymentQueryName subtype_name: StacksMarketplaceDeploymentQueryName - subtype_model: StacksMarketplaceDeploymentQueryStack subtype_name: StacksMarketplaceDeploymentQueryStack - subtype_model: StacksMarketplaceDeploymentQueryAccount subtype_name: StacksMarketplaceDeploymentQueryAccount - subtype_model: StacksMarketplaceDeploymentQueryRegion subtype_name: StacksMarketplaceDeploymentQueryRegion - subtype_model: StacksMarketplaceStackDeploymentQueryExecutionStatus subtype_name: StacksMarketplaceStackDeploymentQueryExecutionStatus - subtype_model: MetricNameQueryOperator subtype_name: MetricNameQueryOperator - subtype_model: ResourceQueryCategory subtype_name: ResourceQueryCategory - subtype_model: ResourceQueryLocation subtype_name: ResourceQueryLocation - subtype_model: ResourceQueryResource subtype_name: ResourceQueryResource - subtype_model: ResourceQueryResourceGroup subtype_name: ResourceQueryResourceGroup - subtype_model: ResourceQueryResourceName subtype_name: ResourceQueryResourceName - subtype_model: ResourceQueryResourceType subtype_name: ResourceQueryResourceType - subtype_model: ResourceQueryTagPresence subtype_name: ResourceQueryTagPresence - subtype_model: ResourceQueryTagKey subtype_name: ResourceQueryTagKey - subtype_model: ResourceQueryTagKeyValue subtype_name: ResourceQueryTagKeyValue - subtype_model: WorkloadQueryWorkloadName subtype_name: WorkloadQueryWorkloadName - subtype_model: WorkloadQueryWorkloadOwner subtype_name: WorkloadQueryWorkloadOwner - subtype_model: WorkloadQueryCloud subtype_name: WorkloadQueryCloud - subtype_model: WorkloadQueryCloudAccount subtype_name: WorkloadQueryCloudAccount - subtype_model: WorkloadQueryWorkloadType subtype_name: WorkloadQueryWorkloadType - subtype_model: WorkloadQueryWorkloadId subtype_name: WorkloadQueryWorkloadId AwsSsmDocumentVersionBatchResponse: properties: results: type: object description: Map from identifier to response model additionalProperties: $ref: '#/components/schemas/AwsSsmDocumentVersionDetails' type: object ListResponse: properties: results: type: array description: List of result identifiers items: type: string next_list_context: description: List context $ref: '#/components/schemas/ListContext' type: object AwsSsmDocumentSyncRequest: properties: cloud_account_ids: type: array description: List of ids of the cloud account for manual document sync. items: type: string type: object AwsSsmDocumentAccountShared: properties: account_id: type: string description: AWS Account Id to which the Document is shared. shared_document_version: type: string description: Version of the document which is shared with other accounts. type: object AwsSsmDocumentSyncResponse: properties: allowed_cloud_accounts: type: array description: List of cloud account ids for which manual sync triggered. items: type: string denied_cloud_accounts: type: array description: List of cloud account ids for which user may not have access or invalid id items: type: string type: object AwsSsmJob: properties: sysId: type: string description: Id of the Job Execution group_job_id: type: string description: ID of the group job. parent_job_id: type: string description: ID of the parent job if the execution document is child. cloud_account_id: type: string description: ID of the cloud account for which document is executed. region: type: string description: AWS region where the document is executed. execution_id: type: string description: Automation or command document execution id. execution_start_time: type: string format: date-time description: Start time of document execution. execution_end_time: type: string format: date-time description: End time of document execution. status: type: string description: Status of the Automation Execution example: Pending enum: - Pending - InProgress - Waiting - Success - TimedOut - Cancelling - Cancelled - Failed - PendingApproval - Approved - Rejected - Scheduled - RunbookInProgress - PendingChangeCalendarOverride - ChangeCalendarOverrideApproved - ChangeCalendarOverrideRejected - CompletedWithSuccess - CompletedWithFailure x-cs-enum-type: AwsSsmAutomationExecutionStatus document_name: type: string description: Name of the document that is executed execution_parameters: description: Input parameter details of the execution $ref: '#/components/schemas/AwsSsmBaseExecution' type: object AwsSsmListDocumentExecutionsSortCriteria: required: - column properties: column: type: string example: created_at enum: - created_at x-cs-enum-type: AwsSsmListDocumentExecutionsSortColumn ascending: type: boolean type: object AwsSsmExecutionQueryFilters: properties: status: type: array description: status of the execution (all if missing) items: type: string document_names: type: array description: The name of the document (all if missing) items: type: string executed_by: type: array description: IAM ARN of the user who executed the document (all if missing) items: type: string type: object AwsSsmExecutionFilter: allOf: - $ref: '#/components/schemas/AwsSsmBaseDocumentFilter' - properties: executed_by: type: array description: Document executed by items: type: string document_names: type: array description: Name of the Automation/Command document items: type: string filters: description: Query filters for the execution $ref: '#/components/schemas/AwsSsmExecutionQueryFilters' type: object x-cs-type-name: AwsSsmExecutionFilter AwsSsmExecutionGroupFilters: properties: cloud_account_ids: type: array description: List of ids of the cloud account. items: type: string regions: type: array description: region of the document to be executed. items: type: string document_ids: type: array description: Name of the document. items: type: string document_types: type: array description: Type of the executed document items: type: string executed_by: type: array description: IAM ARN of the user who executed the document items: type: string status: type: string description: Status of the Automation Execution example: Pending enum: - Pending - InProgress - Waiting - Success - TimedOut - Cancelling - Cancelled - Failed - PendingApproval - Approved - Rejected - Scheduled - RunbookInProgress - PendingChangeCalendarOverride - ChangeCalendarOverrideApproved - ChangeCalendarOverrideRejected - CompletedWithSuccess - CompletedWithFailure x-cs-enum-type: AwsSsmAutomationExecutionStatus text_query: type: string description: Text query for Document Executions list. Search by Execution Id and Document Name type: object AwsSsmListDocumentVersion: properties: sysId: type: string document_version: type: string description: Version of the Systems Manager Document document_creation_time: type: string format: date-time type: object AwsSsmCloudAccountSyncDetails: properties: initiated_at: type: string format: date-time description: Time when the document sync is started completed_at: type: string format: date-time description: Time when the document sync is completed sync_type: type: string description: Type of the document sync example: automation enum: - automation - manual x-cs-enum-type: AwsSsmDocumentSyncType sync_status: type: string description: Status of the sync for the particular cloud account type: object securitySchemes: auth_token: type: apiKey in: header name: X-Auth-Token