View a markdown version of this page

GetTrustedAccessProgramOrganizationEnrollment - Amazon Bedrock

GetTrustedAccessProgramOrganizationEnrollment

Gets the current organization's stored enrollment setting for a trusted access program. The organization and payer account are derived from the authenticated context. Requires operation permission and management-account or Bedrock-specific delegated-administrator authority. The setting can differ from the caller's resolved status returned by GetTrustedAccessProgram. If no enrollment is stored, returns inherit without timestamps.

Request Syntax

GET /trusted-access-programs/programIdentifier/organization-enrollment HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

programIdentifier

The identifier of the trusted access program.

Length Constraints: Minimum length of 3. Maximum length of 115.

Pattern: ([a-z0-9]+-[a-z0-9-]+|arn:aws(-[^:]+)?:bedrock::aws:trusted-access-program/[a-z0-9]+-[a-z0-9-]+)

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "optIn": "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.

optIn

Stored preference at the addressed scope. A missing enrollment returns inherit without updatedAt.

Type: String

Valid Values: inherit | enabled | disabled

updatedAt

Last change to the stored enrollment. Present whenever a row exists, including an explicitly stored inherit setting.

Type: Timestamp

Errors

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

AccessDeniedException

The request is denied because of missing access permissions.

HTTP Status Code: 403

InternalServerException

An internal server error occurred. Retry your request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.

HTTP Status Code: 404

ThrottlingException

The number of requests exceeds the limit. Resubmit your request later.

HTTP Status Code: 429

ValidationException

Input validation failed. Check your request parameters and retry the request.

HTTP Status Code: 400

See Also

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