View the Project on GitHub elements-storage/elements-sdk-swift
All URIs are relative to https://elements.local
Method | HTTP request | Description |
---|---|---|
createAWSAccount | POST /api/2/aws-accounts | |
deleteAWSAccount | DELETE /api/2/aws-accounts/{id} | |
getAWSAccount | GET /api/2/aws-accounts/{id} | |
getAWSAccountBuckets | GET /api/2/aws-accounts/{id}/buckets | |
getAWSAccountSNSTopics | GET /api/2/aws-accounts/{id}/sns/topics | |
getAllAWSAccounts | GET /api/2/aws-accounts | |
patchAWSAccount | PATCH /api/2/aws-accounts/{id} | |
testAWSAccountCredentials | POST /api/2/aws-accounts/test-credentials | |
updateAWSAccount | PUT /api/2/aws-accounts/{id} |
open class func createAWSAccount( aWSAccount: AWSAccount) -> Promise<AWSAccount>
tasks:manage
(read) / system:admin-access
(write)// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let aWSAccount = AWSAccount(id: 123, name: "name_example", accessKeyId: "accessKeyId_example", secretAccessKey: "secretAccessKey_example", endpointUrl: "endpointUrl_example", defaultRegion: "defaultRegion_example") // AWSAccount |
AWSAPI.createAWSAccount(aWSAccount: aWSAccount).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
aWSAccount | AWSAccount |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func deleteAWSAccount( id: Int) -> Promise<Void>
tasks:manage
(read) / system:admin-access
(write)// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let id = 987 // Int | A unique integer value identifying this AWS Account.
AWSAPI.deleteAWSAccount(id: id).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this AWS Account. |
Void (empty response body)
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getAWSAccount( id: Int) -> Promise<AWSAccount>
tasks:manage
(read) / system:admin-access
(write)// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let id = 987 // Int | A unique integer value identifying this AWS Account.
AWSAPI.getAWSAccount(id: id).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this AWS Account. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getAWSAccountBuckets( id: Int) -> Promise<ListBuckets>
tasks:manage
(read) / system:admin-access
(write)// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let id = 987 // Int | A unique integer value identifying this AWS Account.
AWSAPI.getAWSAccountBuckets(id: id).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this AWS Account. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getAWSAccountSNSTopics( id: Int) -> Promise<ListTopics>
tasks:manage
(read) / system:admin-access
(write)// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let id = 987 // Int | A unique integer value identifying this AWS Account.
AWSAPI.getAWSAccountSNSTopics(id: id).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this AWS Account. |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func getAllAWSAccounts( name: String? = nil, id: Double? = nil, ordering: String? = nil, limit: Int? = nil, offset: Int? = nil) -> Promise<[AWSAccount]>
tasks:manage
(read) / system:admin-access
(write)// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let name = "name_example" // String | Filter the returned list by `name`. (optional)
let id = 987 // Double | Filter the returned list by `id`. (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let limit = 987 // Int | Number of results to return per page. (optional)
let offset = 987 // Int | The initial index from which to return the results. (optional)
AWSAPI.getAllAWSAccounts(name: name, id: id, ordering: ordering, limit: limit, offset: offset).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
name | String | Filter the returned list by `name`. | [optional] |
id | Double | Filter the returned list by `id`. | [optional] |
ordering | String | Which field to use when ordering the results. | [optional] |
limit | Int | Number of results to return per page. | [optional] |
offset | Int | The initial index from which to return the results. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func patchAWSAccount( id: Int, aWSAccountPartialUpdate: AWSAccountPartialUpdate) -> Promise<AWSAccount>
tasks:manage
(read) / system:admin-access
(write)// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let id = 987 // Int | A unique integer value identifying this AWS Account.
let aWSAccountPartialUpdate = AWSAccountPartialUpdate(name: "name_example", accessKeyId: "accessKeyId_example", secretAccessKey: "secretAccessKey_example", endpointUrl: "endpointUrl_example", defaultRegion: "defaultRegion_example") // AWSAccountPartialUpdate |
AWSAPI.patchAWSAccount(id: id, aWSAccountPartialUpdate: aWSAccountPartialUpdate).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this AWS Account. | |
aWSAccountPartialUpdate | AWSAccountPartialUpdate |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func testAWSAccountCredentials( testAWSCredentialsRequest: TestAWSCredentialsRequest) -> Promise<TestAWSCredentialsResponse>
tasks:manage
(read) / system:admin-access
(write)// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let testAWSCredentialsRequest = TestAWSCredentialsRequest(accessKeyId: "accessKeyId_example", secretAccessKey: "secretAccessKey_example") // TestAWSCredentialsRequest |
AWSAPI.testAWSAccountCredentials(testAWSCredentialsRequest: testAWSCredentialsRequest).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
testAWSCredentialsRequest | TestAWSCredentialsRequest |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
open class func updateAWSAccount( id: Int, aWSAccount: AWSAccount) -> Promise<AWSAccount>
tasks:manage
(read) / system:admin-access
(write)// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ElementsSDK
let id = 987 // Int | A unique integer value identifying this AWS Account.
let aWSAccount = AWSAccount(id: 123, name: "name_example", accessKeyId: "accessKeyId_example", secretAccessKey: "secretAccessKey_example", endpointUrl: "endpointUrl_example", defaultRegion: "defaultRegion_example") // AWSAccount |
AWSAPI.updateAWSAccount(id: id, aWSAccount: aWSAccount).then {
// when the promise is fulfilled
}.always {
// regardless of whether the promise is fulfilled, or rejected
}.catch { errorType in
// when the promise is rejected
}
Name | Type | Description | Notes |
---|---|---|---|
id | Int | A unique integer value identifying this AWS Account. | |
aWSAccount | AWSAccount |
[Back to top] [Back to API list] [Back to Model list] [Back to README]