View a markdown version of this page

ðŸ”Ĩ āļ‚āđˆāļēāļ§āļ”āđˆāļ§āļ™: rolesanywhere/latest/APIReference/API EnableProfile.html - Kapook Update 2025

EnableProfile

Enables temporary credential requests for a profile.

Required permissions: rolesanywhere:EnableProfile.

Request Syntax

POST /profile/profileId/enable HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

profileId

The profile to act on. You can specify one of the following:

  • The profile ID.

  • The profile ARN.

  • The alias ARN of the profile.

An ARN must be for a profile in your account and Region.

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: ([a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}|arn:aws(-[^:]+)?:rolesanywhere(:.*){2}:(profile|alias/profile)/.*)

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "profile": { "acceptRoleSessionName": boolean, "aliasArn": "string", "aliasName": "string", "attributeMappings": [ { "certificateField": "string", "mappingRules": [ { "specifier": "string" } ] } ], "createdAt": "string", "createdBy": "string", "durationSeconds": number, "enabled": boolean, "managedPolicyArns": [ "string" ], "name": "string", "previousAliasName": "string", "profileArn": "string", "profileId": "string", "requireInstanceProperties": boolean, "roleArns": [ "string" ], "sessionPolicy": "string", "tipConfiguration": { "status": "string", "subjectSource": "string", "subjectType": "string" }, "updatedAt": "string" } }

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 Error Types.

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

ServiceUnavailableException

The request has failed due to a temporary failure of the service.

message

The exception message.

retryAfterSeconds

The recommended number of seconds after which the client should retry the request.

HTTP Status Code: 503

See Also

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