{ "swagger": "2.0", "info": { "title": "Microsoft.AwsConnector", "version": "2024-12-01", "description": "Microsoft.AwsConnector Resource Provider management API.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "RdsExportTasks" } ], "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.AwsConnector/rdsExportTasks": { "get": { "operationId": "RdsExportTasks_ListBySubscription", "tags": [ "RdsExportTasks" ], "description": "List RdsExportTask resources by subscription ID", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RdsExportTaskListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RdsExportTasks_ListBySubscription": { "$ref": "./examples/RdsExportTasks_ListBySubscription.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/rdsExportTasks": { "get": { "operationId": "RdsExportTasks_ListByResourceGroup", "tags": [ "RdsExportTasks" ], "description": "List RdsExportTask resources by resource group", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RdsExportTaskListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RdsExportTasks_ListByResourceGroup": { "$ref": "./examples/RdsExportTasks_ListByResourceGroup.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AwsConnector/rdsExportTasks/{name}": { "get": { "operationId": "RdsExportTasks_Get", "tags": [ "RdsExportTasks" ], "description": "Get a RdsExportTask", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of RdsExportTask", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RdsExportTask" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RdsExportTasks_Get": { "$ref": "./examples/RdsExportTasks_Get.json" } } }, "put": { "operationId": "RdsExportTasks_CreateOrReplace", "tags": [ "RdsExportTasks" ], "description": "Create a RdsExportTask. Please note that end user resource creation is currently restricted, but it will be enabled in the future.", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of RdsExportTask", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" }, { "name": "resource", "in": "body", "description": "Resource create parameters.", "required": true, "schema": { "$ref": "#/definitions/RdsExportTask" } } ], "responses": { "200": { "description": "Resource 'RdsExportTask' update operation succeeded", "schema": { "$ref": "#/definitions/RdsExportTask" } }, "201": { "description": "Resource 'RdsExportTask' create operation succeeded", "schema": { "$ref": "#/definitions/RdsExportTask" }, "headers": { "Azure-AsyncOperation": { "type": "string", "description": "A link to the status monitor" }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RdsExportTasks_CreateOrReplace": { "$ref": "./examples/RdsExportTasks_CreateOrReplace.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "x-ms-long-running-operation": true }, "patch": { "operationId": "RdsExportTasks_Update", "tags": [ "RdsExportTasks" ], "description": "Update a RdsExportTask", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of RdsExportTask", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" }, { "name": "properties", "in": "body", "description": "The resource properties to be updated.", "required": true, "schema": { "$ref": "#/definitions/RdsExportTaskTagsUpdate" } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/RdsExportTask" } }, "202": { "description": "Resource update request accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RdsExportTasks_Update": { "$ref": "./examples/RdsExportTasks_Update.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "RdsExportTasks_Delete", "tags": [ "RdsExportTasks" ], "description": "Delete a RdsExportTask", "parameters": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "name", "in": "path", "description": "Name of RdsExportTask", "required": true, "type": "string", "pattern": "^(?=.{0,259}[^\\s.]$)(?!.*[<>%&\\?/#])" } ], "responses": { "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "RdsExportTasks_Delete": { "$ref": "./examples/RdsExportTasks_Delete.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } } }, "definitions": { "AwsRdsExportTaskProperties": { "type": "object", "description": "Definition of awsRdsExportTask", "properties": { "exportOnly": { "type": "array", "description": "

The data exported from the snapshot or cluster.

Valid Values:

", "items": { "type": "string" } }, "exportTaskIdentifier": { "type": "string", "description": "

A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.

" }, "failureCause": { "type": "string", "description": "

The reason the export failed, if it failed.

" }, "iamRoleArn": { "type": "string", "description": "

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.

" }, "kmsKeyId": { "type": "string", "description": "

The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.

" }, "percentProgress": { "type": "integer", "format": "int32", "description": "

The progress of the snapshot or cluster export task as a percentage.

" }, "s3Bucket": { "type": "string", "description": "

The Amazon S3 bucket where the snapshot or cluster is exported to.

" }, "s3Prefix": { "type": "string", "description": "

The Amazon S3 bucket prefix that is the file name and path of the exported data.

" }, "snapshotTime": { "type": "string", "format": "date-time", "description": "

The time when the snapshot was created.

" }, "sourceArn": { "type": "string", "description": "

The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

" }, "sourceType": { "$ref": "#/definitions/ExportSourceTypeEnumValue", "description": "

The type of source for the export.

" }, "status": { "type": "string", "description": "

The progress status of the export task. The status can be one of the following:

" }, "taskEndTime": { "type": "string", "format": "date-time", "description": "

The time when the snapshot or cluster export task ended.

" }, "taskStartTime": { "type": "string", "format": "date-time", "description": "

The time when the snapshot or cluster export task started.

" }, "totalExtractedDataInGB": { "type": "integer", "format": "int32", "description": "

The total amount of data exported, in gigabytes.

" }, "warningMessage": { "type": "string", "description": "

A warning about the snapshot or cluster export task.

" } } }, "ExportSourceType": { "type": "string", "description": "ExportSourceType enum", "enum": [ "CLUSTER", "SNAPSHOT" ], "x-ms-enum": { "name": "ExportSourceType", "modelAsString": true, "values": [ { "name": "CLUSTER", "value": "CLUSTER", "description": "ExportSourceType enum CLUSTER" }, { "name": "SNAPSHOT", "value": "SNAPSHOT", "description": "ExportSourceType enum SNAPSHOT" } ] } }, "ExportSourceTypeEnumValue": { "type": "object", "description": "Definition of ExportSourceTypeEnumValue", "properties": { "value": { "$ref": "#/definitions/ExportSourceType", "description": "Property value" } } }, "ProvisioningState": { "type": "string", "description": "The provisioning state of a resource.", "enum": [ "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted" ], "x-ms-enum": { "name": "ProvisioningState", "modelAsString": true, "values": [ { "name": "Succeeded", "value": "Succeeded", "description": "Resource has been created." }, { "name": "Failed", "value": "Failed", "description": "Resource creation failed." }, { "name": "Canceled", "value": "Canceled", "description": "Resource creation was canceled." }, { "name": "Provisioning", "value": "Provisioning", "description": "The resource is being provisioned" }, { "name": "Updating", "value": "Updating", "description": "The resource is updating" }, { "name": "Deleting", "value": "Deleting", "description": "The resource is being deleted" }, { "name": "Accepted", "value": "Accepted", "description": "The resource create request has been accepted" } ] }, "readOnly": true }, "RdsExportTask": { "type": "object", "description": "A Microsoft.AwsConnector resource", "properties": { "properties": { "$ref": "#/definitions/RdsExportTaskProperties", "description": "The resource-specific properties for this resource." } }, "allOf": [ { "$ref": "../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource" } ] }, "RdsExportTaskListResult": { "type": "object", "description": "The response of a RdsExportTask list operation.", "properties": { "value": { "type": "array", "description": "The RdsExportTask items on this page", "items": { "$ref": "#/definitions/RdsExportTask" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "RdsExportTaskProperties": { "type": "object", "description": "Definition of RdsExportTask", "properties": { "awsProperties": { "$ref": "#/definitions/AwsRdsExportTaskProperties", "description": "AWS Properties" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsTags": { "type": "object", "description": "AWS Tags", "additionalProperties": { "type": "string" } }, "provisioningState": { "$ref": "#/definitions/ProvisioningState", "description": "The status of the last operation.", "readOnly": true } } }, "RdsExportTaskTagsUpdate": { "type": "object", "description": "The type used for updating tags in RdsExportTask resources.", "properties": { "tags": { "type": "object", "description": "Resource tags.", "additionalProperties": { "type": "string" } } } } }, "parameters": {} }