Update an IAM role attached to an S3 Instant Access endpoint

Updates a user-defined IAM role that is attached to an S3 Instant Access endpoint if any changes are made to that role.

Path Parameters

• endpoint_id string required

  ID of the endpoint to update a role

• role_id string required

  ID of the currently enrolled role to be access the endpoint.

application/json

Request Body required

• updated_role_alias string

  The updated descriptive alias of the IAM role. The current alias will be retained if empty updated_role_alias is passed.

• updated_role_arn string

  The updated ARN of the IAM role to allow access to the endpoint. The role must be accessible from an AWS account registered with Clumio. The current ARN will be retained if empty updated_role_arn is passed.

Responses

• 200
• default

---

Success

application/api.clumio.restored-protection-group-instant-access-endpoints=v1+json

• Schema
• Example (from schema)

---

Schema

• _embedded object

  Embedded responses related to the resource.

  read-protection-group-s3-asset

  Embeds the associated protection group S3 asset

• _links object

  URLs to pages related to the resource.

  _self object

  The HATEOAS link to this resource.

  href string

  The URI for the referenced operation.

  templated boolean

  Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  type string

  The HTTP method to be used with the "href" link for the referenced operation.

  read-protection-group-instant-access-endpoint

  URL to the detailed information of the instant access endpoint

  read-protection-group-instant-access-endpoint-role-permission

  URL to the role permissions of the instant access endpoint

  read-protection-group-instant-access-endpoint-uri

  URL for getting URI of the instant access endpoint

  read-protection-group-s3-asset

  URL to the associated protection group S3 asset

{
  "_embedded": {},
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  }
}

Error

application/json

• Schema
• Example (from schema)

---

Schema

• errors object[]

  A list of errors encountered during runtime.

  error_code uint32

  error_message string

  The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

PUT /restores/protection-groups/instant-access-endpoints/:endpoint_id/roles/:role_id    

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

endpoint_id — path required

role_id — path required

Body required

{
  "updated_role_alias": "string",
  "updated_role_arn": "string"
}

curl -L -X PUT 'https://us-west-2.api.clumio.com/restores/protection-groups/instant-access-endpoints/:endpoint_id/roles/:role_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-group-instant-access-endpoints=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "updated_role_alias": "string",
  "updated_role_arn": "string"
}'

curl -L -X PUT 'https://us-west-2.api.clumio.com/restores/protection-groups/instant-access-endpoints/:endpoint_id/roles/:role_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-group-instant-access-endpoints=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "updated_role_alias": "string",
  "updated_role_arn": "string"
}'

curl -L -X PUT 'https://us-west-2.api.clumio.com/restores/protection-groups/instant-access-endpoints/:endpoint_id/roles/:role_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-group-instant-access-endpoints=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "updated_role_alias": "string",
  "updated_role_arn": "string"
}'

curl -L -X PUT 'https://us-west-2.api.clumio.com/restores/protection-groups/instant-access-endpoints/:endpoint_id/roles/:role_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-group-instant-access-endpoints=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "updated_role_alias": "string",
  "updated_role_arn": "string"
}'

curl -L -X PUT 'https://us-west-2.api.clumio.com/restores/protection-groups/instant-access-endpoints/:endpoint_id/roles/:role_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-group-instant-access-endpoints=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "updated_role_alias": "string",
  "updated_role_arn": "string"
}'

curl -L -X PUT 'https://us-west-2.api.clumio.com/restores/protection-groups/instant-access-endpoints/:endpoint_id/roles/:role_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-group-instant-access-endpoints=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "updated_role_alias": "string",
  "updated_role_arn": "string"
}'

curl -L -X PUT 'https://us-west-2.api.clumio.com/restores/protection-groups/instant-access-endpoints/:endpoint_id/roles/:role_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-group-instant-access-endpoints=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "updated_role_alias": "string",
  "updated_role_arn": "string"
}'