commonMain.aws.sdk.kotlin.services.verifiedpermissions.model.EntitiesDefinition.kt Maven / Gradle / Ivy

Go to download
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.verifiedpermissions.model



/**
 * Contains the list of entities to be considered during an authorization request. This includes all principals, resources, and actions required to successfully evaluate the request.
 *
 * This data type is used as a field in the response parameter for the [IsAuthorized](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorized.html) and [IsAuthorizedWithToken](https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html) operations.
 */
public sealed class EntitiesDefinition {
    /**
     * An array of entities that are needed to successfully evaluate an authorization request. Each entity in this array must include an identifier for the entity, the attributes of the entity, and a list of any parent entities.
     */
    public data class EntityList(val value: List) : aws.sdk.kotlin.services.verifiedpermissions.model.EntitiesDefinition() {
    }

    public object SdkUnknown : aws.sdk.kotlin.services.verifiedpermissions.model.EntitiesDefinition() {
    }

    /**
     * Casts this [EntitiesDefinition] as a [EntityList] and retrieves its [List] value. Throws an exception if the [EntitiesDefinition] is not a
     * [EntityList].
     */
    public fun asEntityList(): List = (this as EntitiesDefinition.EntityList).value

    /**
     * Casts this [EntitiesDefinition] as a [EntityList] and retrieves its [List] value. Returns null if the [EntitiesDefinition] is not a [EntityList].
     */
    public fun asEntityListOrNull(): List? = (this as? EntitiesDefinition.EntityList)?.value
}