Skip to content
This repository was archived by the owner on Jan 12, 2021. It is now read-only.

ExternalAccountsAmazonApi.md

Latest commit

 

History

History
162 lines (115 loc) · 5.43 KB

ExternalAccountsAmazonApi.md

File metadata and controls

162 lines (115 loc) · 5.43 KB

ExternalAccountsAmazonApi

All URIs are relative to http://localhost/

Method HTTP request Description
create POST api/v2/external_accounts/amazon.json_api Create an Amazon External Account
show GET api/v2/external_accounts/{external_account_id}/amazon.json_api Show an Amazon External Account
update PATCH api/v2/external_accounts/{external_account_id}/amazon.json_api Update an Amazon External Account

create

ExternalAccountAmazonIam create(arn, externalId, name, teamId)

Create an Amazon External Account

The related external_account object will be returned with the response.

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ExternalAccountsAmazonApi;


ExternalAccountsAmazonApi apiInstance = new ExternalAccountsAmazonApi();
String arn = "arn_example"; // String | Amazon Resource Name for the IAM role
String externalId = "externalId_example"; // String | External Identifier set on the role
String name = "name_example"; // String | Name
Integer teamId = 56; // Integer | The ID of the team the external account belongs to
try {
    ExternalAccountAmazonIam result = apiInstance.create(arn, externalId, name, teamId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsAmazonApi#create");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
arn String Amazon Resource Name for the IAM role
externalId String External Identifier set on the role
name String Name
teamId Integer The ID of the team the external account belongs to

Return type

ExternalAccountAmazonIam

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

show

ExternalAccountAmazonIam show(externalAccountId, include)

Show an Amazon External Account

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ExternalAccountsAmazonApi;


ExternalAccountsAmazonApi apiInstance = new ExternalAccountsAmazonApi();
Integer externalAccountId = 56; // Integer | The ID of the external account to show an Amazon IAM credential for
String include = "include_example"; // String | Related objects that can be included in the response:  external_account See Including Objects for more information.
try {
    ExternalAccountAmazonIam result = apiInstance.show(externalAccountId, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsAmazonApi#show");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account to show an Amazon IAM credential for
include String Related objects that can be included in the response: external_account See Including Objects for more information. [optional]

Return type

ExternalAccountAmazonIam

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json

update

ExternalAccountAmazonIam update(externalAccountId, arn, externalId, name, teamId)

Update an Amazon External Account

The related external_account object will be returned with the response.

Example

// Import classes:
//import io.evident.EspSdk.ApiException;
//import io.evident.api.ExternalAccountsAmazonApi;


ExternalAccountsAmazonApi apiInstance = new ExternalAccountsAmazonApi();
Integer externalAccountId = 56; // Integer | The ID of the external account to update an Amazon IAM credential of
String arn = "arn_example"; // String | Amazon Resource Name for the IAM role
String externalId = "externalId_example"; // String | External Identifier set on the role
String name = "name_example"; // String | Name
Integer teamId = 56; // Integer | The ID of the team the external account belongs to
try {
    ExternalAccountAmazonIam result = apiInstance.update(externalAccountId, arn, externalId, name, teamId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ExternalAccountsAmazonApi#update");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
externalAccountId Integer The ID of the external account to update an Amazon IAM credential of
arn String Amazon Resource Name for the IAM role [optional]
externalId String External Identifier set on the role [optional]
name String Name [optional]
teamId Integer The ID of the team the external account belongs to [optional]

Return type

ExternalAccountAmazonIam

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.api+json
  • Accept: application/vnd.api+json