DisableProfile - IAM Roles Anywhere

DisableProfile

Disables a profile. When disabled, temporary credential requests with this profile fail.

Required permissions: rolesanywhere:DisableProfile.

Request Syntax

POST /profile/profileId/disable HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

profileId

The unique identifier of the profile.

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "profile": { "createdAt": number, "createdBy": "string", "durationSeconds": number, "enabled": boolean, "managedPolicyArns": [ "string" ], "name": "string", "profileArn": "string", "profileId": "string", "requireInstanceProperties": boolean, "roleArns": [ "string" ], "sessionPolicy": "string", "updatedAt": number } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

profile

The state of the profile after a read or write operation.

Type: ProfileDetail object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: