AWS.Tools.VerifiedPermissions.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.VerifiedPermissions</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.AVP.GetAVPBatchIsAuthorizedWithTokenCmdlet"> <summary> Makes a series of decisions about multiple authorization requests for one token. The principal in this request comes from an external identity source in the form of an identity or access token, formatted as a <a href="https://wikipedia.org/wiki/JSON_Web_Token">JSON web token (JWT)</a>. The information in the parameters can also define additional context that Verified Permissions can include in the evaluations. <para> The request is evaluated against all policies in the specified policy store that match the entities that you provide in the entities declaration and in the token. The result of the decisions is a series of <c>Allow</c> or <c>Deny</c> responses, along with the IDs of the policies that produced each decision. </para><para> The <c>entities</c> of a <c>BatchIsAuthorizedWithToken</c> API request can contain up to 100 resources and up to 99 user groups. The <c>requests</c> of a <c>BatchIsAuthorizedWithToken</c> API request can contain up to 30 requests. </para><note><para> The <c>BatchIsAuthorizedWithToken</c> operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission <c>verifiedpermissions:IsAuthorizedWithToken</c> in their IAM policies. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPBatchIsAuthorizedWithTokenCmdlet.AccessToken"> <summary> <para> <para>Specifies an access token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an <c>accessToken</c>, an <c>identityToken</c>, or both.</para><para>Must be an access token. Verified Permissions returns an error if the <c>token_use</c> claim in the submitted token isn't <c>access</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPBatchIsAuthorizedWithTokenCmdlet.Entities_EntityList"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPBatchIsAuthorizedWithTokenCmdlet.IdentityToken"> <summary> <para> <para>Specifies an identity (ID) token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an <c>accessToken</c>, an <c>identityToken</c>, or both.</para><para>Must be an ID token. Verified Permissions returns an error if the <c>token_use</c> claim in the submitted token isn't <c>id</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPBatchIsAuthorizedWithTokenCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPBatchIsAuthorizedWithTokenCmdlet.Request"> <summary> <para> <para>An array of up to 30 requests that you want Verified Permissions to evaluate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPBatchIsAuthorizedWithTokenCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.BatchIsAuthorizedWithTokenResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.BatchIsAuthorizedWithTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPBatchIsAuthorizedWithTokenCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyStoreId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.GetAVPIdentitySourceCmdlet"> <summary> Retrieves the details about the specified identity source. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPIdentitySourceCmdlet.IdentitySourceId"> <summary> <para> <para>Specifies the ID of the identity source you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPIdentitySourceCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store that contains the identity source you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPIdentitySourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.GetIdentitySourceResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.GetIdentitySourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.GetAVPIdentitySourceListCmdlet"> <summary> Returns a paginated list of all of the identity sources defined in the specified policy store. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPIdentitySourceListCmdlet.Filter"> <summary> <para> <para>Specifies characteristics of an identity source that you can use to limit the output to matching identity sources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPIdentitySourceListCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store that contains the identity sources that you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPIdentitySourceListCmdlet.MaxResult"> <summary> <para> <para>Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the <c>NextToken</c> response element is returned with a value (not null). Include the specified value as the <c>NextToken</c> request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check <c>NextToken</c> after every operation to ensure that you receive all of the results.</para><para>If you do not specify this parameter, the operation defaults to 10 identity sources per response. You can specify a maximum of 200 identity sources per response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPIdentitySourceListCmdlet.NextToken"> <summary> <para> <para>Specifies that you want to receive the next page of results. Valid only if you received a <c>NextToken</c> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <c>NextToken</c> response to request the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPIdentitySourceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IdentitySources'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.ListIdentitySourcesResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.ListIdentitySourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPIdentitySourceListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyStoreId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyCmdlet"> <summary> Retrieves information about the specified policy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyCmdlet.PolicyId"> <summary> <para> <para>Specifies the ID of the policy you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store that contains the policy that you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.GetPolicyResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.GetPolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyListCmdlet"> <summary> Returns a paginated list of all policies stored in the specified policy store. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyListCmdlet.Filter_Principal_Identifier_EntityId"> <summary> <para> <para>The identifier of an entity.</para><para><c>"entityId":"<i>identifier</i>"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyListCmdlet.Filter_Resource_Identifier_EntityId"> <summary> <para> <para>The identifier of an entity.</para><para><c>"entityId":"<i>identifier</i>"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyListCmdlet.Filter_Principal_Identifier_EntityType"> <summary> <para> <para>The type of an entity.</para><para>Example: <c>"entityType":"<i>typeName</i>"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyListCmdlet.Filter_Resource_Identifier_EntityType"> <summary> <para> <para>The type of an entity.</para><para>Example: <c>"entityType":"<i>typeName</i>"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyListCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store you want to list policies from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyListCmdlet.Filter_PolicyTemplateId"> <summary> <para> <para>Filters the output to only template-linked policies that were instantiated from the specified policy template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyListCmdlet.Filter_PolicyType"> <summary> <para> <para>Filters the output to only policies of the specified type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyListCmdlet.Principal_Unspecified"> <summary> <para> <para>Used to indicate that a principal or resource is not specified. This can be used to search for policies that are not associated with a specific principal or resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyListCmdlet.Resource_Unspecified"> <summary> <para> <para>Used to indicate that a principal or resource is not specified. This can be used to search for policies that are not associated with a specific principal or resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyListCmdlet.MaxResult"> <summary> <para> <para>Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the <c>NextToken</c> response element is returned with a value (not null). Include the specified value as the <c>NextToken</c> request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check <c>NextToken</c> after every operation to ensure that you receive all of the results.</para><para>If you do not specify this parameter, the operation defaults to 10 policies per response. You can specify a maximum of 50 policies per response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyListCmdlet.NextToken"> <summary> <para> <para>Specifies that you want to receive the next page of results. Valid only if you received a <c>NextToken</c> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <c>NextToken</c> response to request the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policies'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.ListPoliciesResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.ListPoliciesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyStoreId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyStoreCmdlet"> <summary> Retrieves details about a policy store. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyStoreCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store that you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyStoreCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.GetPolicyStoreResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.GetPolicyStoreResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyStoreCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyStoreId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyStoreListCmdlet"> <summary> Returns a paginated list of all policy stores in the calling Amazon Web Services account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyStoreListCmdlet.MaxResult"> <summary> <para> <para>Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the <c>NextToken</c> response element is returned with a value (not null). Include the specified value as the <c>NextToken</c> request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check <c>NextToken</c> after every operation to ensure that you receive all of the results.</para><para>If you do not specify this parameter, the operation defaults to 10 policy stores per response. You can specify a maximum of 50 policy stores per response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyStoreListCmdlet.NextToken"> <summary> <para> <para>Specifies that you want to receive the next page of results. Valid only if you received a <c>NextToken</c> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <c>NextToken</c> response to request the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyStoreListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PolicyStores'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.ListPolicyStoresResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.ListPolicyStoresResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyTemplateCmdlet"> <summary> Retrieve the details for the specified policy template in the specified policy store. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyTemplateCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store that contains the policy template that you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyTemplateCmdlet.PolicyTemplateId"> <summary> <para> <para>Specifies the ID of the policy template that you want information about.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.GetPolicyTemplateResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.GetPolicyTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyTemplateListCmdlet"> <summary> Returns a paginated list of all policy templates in the specified policy store. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyTemplateListCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store that contains the policy templates you want to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyTemplateListCmdlet.MaxResult"> <summary> <para> <para>Specifies the total number of results that you want included in each response. If additional items exist beyond the number you specify, the <c>NextToken</c> response element is returned with a value (not null). Include the specified value as the <c>NextToken</c> request parameter in the next call to the operation to get the next set of results. Note that the service might return fewer results than the maximum even when there are more results available. You should check <c>NextToken</c> after every operation to ensure that you receive all of the results.</para><para>If you do not specify this parameter, the operation defaults to 10 policy templates per response. You can specify a maximum of 50 policy templates per response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyTemplateListCmdlet.NextToken"> <summary> <para> <para>Specifies that you want to receive the next page of results. Valid only if you received a <c>NextToken</c> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <c>NextToken</c> response to request the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyTemplateListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PolicyTemplates'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.ListPolicyTemplatesResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.ListPolicyTemplatesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPPolicyTemplateListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyStoreId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.GetAVPSchemaCmdlet"> <summary> Retrieve the details for the specified schema in the specified policy store. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPSchemaCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store that contains the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.GetSchemaResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.GetSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.GetAVPSchemaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyStoreId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.NewAVPIdentitySourceCmdlet"> <summary> Creates a reference to an Amazon Cognito user pool as an external identity provider (IdP). <para> After you create an identity source, you can use the identities provided by the IdP as proxies for the principal in authorization queries that use the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a> operation. These identities take the form of tokens that contain claims about the user, such as IDs, attributes and group memberships. Amazon Cognito provides both identity tokens and access tokens, and Verified Permissions can use either or both. Any combination of identity and access tokens results in the same Cedar principal. Verified Permissions automatically translates the information about the identities into the standard Cedar attributes that can be evaluated by your policies. Because the Amazon Cognito identity and access tokens can contain different information, the tokens you choose to use determine which principal attributes are available to access when evaluating Cedar policies. </para><important><para> If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire. </para></important><note><para> To reference a user from this identity source in your Cedar policies, use the following syntax. </para><para><i>IdentityType::"<CognitoUserPoolIdentifier>|<CognitoClientId></i></para><para> Where <c>IdentityType</c> is the string that you provide to the <c>PrincipalEntityType</c> parameter for this operation. The <c>CognitoUserPoolId</c> and <c>CognitoClientId</c> are defined by the Amazon Cognito user pool. </para></note><note><para> Verified Permissions is <i><a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a></i>. It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPIdentitySourceCmdlet.CognitoUserPoolConfiguration_ClientId"> <summary> <para> <para>The unique application client IDs that are associated with the specified Amazon Cognito user pool.</para><para>Example: <c>"ClientIds": ["&ExampleCogClientId;"]</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPIdentitySourceCmdlet.GroupConfiguration_GroupEntityType"> <summary> <para> <para>The name of the schema entity type that's mapped to the user pool group. Defaults to <c>AWS::CognitoGroup</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPIdentitySourceCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store in which you want to store this identity source. Only policies and requests made using this policy store can reference identities from the identity provider configured in the new identity source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPIdentitySourceCmdlet.PrincipalEntityType"> <summary> <para> <para>Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPIdentitySourceCmdlet.CognitoUserPoolConfiguration_UserPoolArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the Amazon Cognito user pool that contains the identities to be authorized.</para><para>Example: <c>"UserPoolArn": "arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPIdentitySourceCmdlet.ClientToken"> <summary> <para> <para>Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value.</a>.</para><para>If you don't provide this value, then Amazon Web Services generates a random one for you.</para><para>If you retry the operation with the same <c>ClientToken</c>, but with different parameters, the retry fails with an <c>ConflictException</c> error.</para><para>Verified Permissions recognizes a <c>ClientToken</c> for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of <c>ClientToken</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPIdentitySourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.CreateIdentitySourceResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.CreateIdentitySourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPIdentitySourceCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyStoreId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPIdentitySourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyCmdlet"> <summary> Creates a Cedar policy and saves it in the specified policy store. You can create either a static policy or a policy linked to a policy template. <ul><li><para> To create a static policy, provide the Cedar policy text in the <c>StaticPolicy</c> section of the <c>PolicyDefinition</c>. </para></li><li><para> To create a policy that is dynamically linked to a policy template, specify the policy template ID and the principal and resource to associate with this policy in the <c>templateLinked</c> section of the <c>PolicyDefinition</c>. If the policy template is ever updated, any policies linked to the policy template automatically use the updated template. </para></li></ul><note><para> Creating a policy causes it to be validated against the schema in the policy store. If the policy doesn't pass validation, the operation fails and the policy isn't stored. </para></note><note><para> Verified Permissions is <i><a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a></i>. It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyCmdlet.Static_Description"> <summary> <para> <para>The description of the static policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyCmdlet.Principal_EntityId"> <summary> <para> <para>The identifier of an entity.</para><para><c>"entityId":"<i>identifier</i>"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyCmdlet.Resource_EntityId"> <summary> <para> <para>The identifier of an entity.</para><para><c>"entityId":"<i>identifier</i>"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyCmdlet.Principal_EntityType"> <summary> <para> <para>The type of an entity.</para><para>Example: <c>"entityType":"<i>typeName</i>"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyCmdlet.Resource_EntityType"> <summary> <para> <para>The type of an entity.</para><para>Example: <c>"entityType":"<i>typeName</i>"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the <c>PolicyStoreId</c> of the policy store you want to store the policy in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyCmdlet.TemplateLinked_PolicyTemplateId"> <summary> <para> <para>The unique identifier of the policy template used to create this policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyCmdlet.Static_Statement"> <summary> <para> <para>The policy content of the static policy, written in the Cedar policy language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyCmdlet.ClientToken"> <summary> <para> <para>Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value.</a>.</para><para>If you don't provide this value, then Amazon Web Services generates a random one for you.</para><para>If you retry the operation with the same <c>ClientToken</c>, but with different parameters, the retry fails with an <c>ConflictException</c> error.</para><para>Verified Permissions recognizes a <c>ClientToken</c> for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of <c>ClientToken</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.CreatePolicyResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.CreatePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyStoreId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyStoreCmdlet"> <summary> Creates a policy store. A policy store is a container for policy resources. <note><para> Although <a href="https://docs.cedarpolicy.com/schema/schema.html#namespace">Cedar supports multiple namespaces</a>, Verified Permissions currently supports only one namespace per policy store. </para></note><note><para> Verified Permissions is <i><a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a></i>. It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyStoreCmdlet.Description"> <summary> <para> <para>Descriptive text that you can provide to help with identification of the current policy store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyStoreCmdlet.ValidationSettings_Mode"> <summary> <para> <para>The validation mode currently configured for this policy store. The valid values are:</para><ul><li><para><b>OFF</b> – Neither Verified Permissions nor Cedar perform any validation on policies. No validation errors are reported by either service.</para></li><li><para><b>STRICT</b> – Requires a schema to be present in the policy store. Cedar performs validation on all submitted new or updated static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store them in the policy store.</para></li></ul><important><para>If <c>Mode=STRICT</c> and the policy store doesn't contain a schema, Verified Permissions rejects all static policies and policy templates because there is no schema to validate against. </para><para>To submit a static policy or policy template without a schema, you must turn off validation.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyStoreCmdlet.ClientToken"> <summary> <para> <para>Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value.</a>.</para><para>If you don't provide this value, then Amazon Web Services generates a random one for you.</para><para>If you retry the operation with the same <c>ClientToken</c>, but with different parameters, the retry fails with an <c>ConflictException</c> error.</para><para>Verified Permissions recognizes a <c>ClientToken</c> for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of <c>ClientToken</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyStoreCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.CreatePolicyStoreResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.CreatePolicyStoreResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyStoreCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ValidationSettings_Mode parameter. The -PassThru parameter is deprecated, use -Select '^ValidationSettings_Mode' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyStoreCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyTemplateCmdlet"> <summary> Creates a policy template. A template can use placeholders for the principal and resource. A template must be instantiated into a policy by associating it with specific principals and resources to use for the placeholders. That instantiated policy can then be considered in authorization decisions. The instantiated policy works identically to any other policy, except that it is dynamically linked to the template. If the template changes, then any policies that are linked to that template are immediately updated as well. <note><para> Verified Permissions is <i><a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a></i>. It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyTemplateCmdlet.Description"> <summary> <para> <para>Specifies a description for the policy template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyTemplateCmdlet.PolicyStoreId"> <summary> <para> <para>The ID of the policy store in which to create the policy template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyTemplateCmdlet.Statement"> <summary> <para> <para>Specifies the content that you want to use for the new policy template, written in the Cedar policy language.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyTemplateCmdlet.ClientToken"> <summary> <para> <para>Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value.</a>.</para><para>If you don't provide this value, then Amazon Web Services generates a random one for you.</para><para>If you retry the operation with the same <c>ClientToken</c>, but with different parameters, the retry fails with an <c>ConflictException</c> error.</para><para>Verified Permissions recognizes a <c>ClientToken</c> for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of <c>ClientToken</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.CreatePolicyTemplateResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.CreatePolicyTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.NewAVPPolicyTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPIdentitySourceCmdlet"> <summary> Deletes an identity source that references an identity provider (IdP) such as Amazon Cognito. After you delete the identity source, you can no longer use tokens for identities from that identity source to represent principals in authorization queries made using <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_IsAuthorizedWithToken.html">IsAuthorizedWithToken</a>. operations. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPIdentitySourceCmdlet.IdentitySourceId"> <summary> <para> <para>Specifies the ID of the identity source that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPIdentitySourceCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store that contains the identity source that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPIdentitySourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.DeleteIdentitySourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPIdentitySourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPPolicyCmdlet"> <summary> Deletes the specified policy from the policy store. <para> This operation is idempotent; if you specify a policy that doesn't exist, the request response returns a successful <c>HTTP 200</c> status code. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPPolicyCmdlet.PolicyId"> <summary> <para> <para>Specifies the ID of the policy that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPPolicyCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store that contains the policy that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.DeletePolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPPolicyStoreCmdlet"> <summary> Deletes the specified policy store. <para> This operation is idempotent. If you specify a policy store that does not exist, the request response will still return a successful HTTP 200 status code. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPPolicyStoreCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPPolicyStoreCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.DeletePolicyStoreResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPPolicyStoreCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyStoreId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPPolicyStoreCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPPolicyTemplateCmdlet"> <summary> Deletes the specified policy template from the policy store. <important><para> This operation also deletes any policies that were created from the specified policy template. Those policies are immediately removed from all future API responses, and are asynchronously deleted from the policy store. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPPolicyTemplateCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store that contains the policy template that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPPolicyTemplateCmdlet.PolicyTemplateId"> <summary> <para> <para>Specifies the ID of the policy template that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPPolicyTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.DeletePolicyTemplateResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.RemoveAVPPolicyTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.TestAVPAuthorizationCmdlet"> <summary> Makes an authorization decision about a service request described in the parameters. The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either <c>Allow</c> or <c>Deny</c>, along with a list of the policies that resulted in the decision. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPAuthorizationCmdlet.Action_ActionId"> <summary> <para> <para>The ID of an action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPAuthorizationCmdlet.Action_ActionType"> <summary> <para> <para>The type of an action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPAuthorizationCmdlet.Context_ContextMap"> <summary> <para> <para>An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.</para><para>Example: <c>"contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPAuthorizationCmdlet.Principal_EntityId"> <summary> <para> <para>The identifier of an entity.</para><para><c>"entityId":"<i>identifier</i>"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPAuthorizationCmdlet.Resource_EntityId"> <summary> <para> <para>The identifier of an entity.</para><para><c>"entityId":"<i>identifier</i>"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPAuthorizationCmdlet.Entities_EntityList"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPAuthorizationCmdlet.Principal_EntityType"> <summary> <para> <para>The type of an entity.</para><para>Example: <c>"entityType":"<i>typeName</i>"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPAuthorizationCmdlet.Resource_EntityType"> <summary> <para> <para>The type of an entity.</para><para>Example: <c>"entityType":"<i>typeName</i>"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPAuthorizationCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPAuthorizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.IsAuthorizedResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.IsAuthorizedResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPAuthorizationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyStoreId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.TestAVPBatchAuthorizationCmdlet"> <summary> Makes a series of decisions about multiple authorization requests for one principal or resource. Each request contains the equivalent content of an <c>IsAuthorized</c> request: principal, action, resource, and context. Either the <c>principal</c> or the <c>resource</c> parameter must be identical across all requests. For example, Verified Permissions won't evaluate a pair of requests where <c>bob</c> views <c>photo1</c> and <c>alice</c> views <c>photo2</c>. Authorization of <c>bob</c> to view <c>photo1</c> and <c>photo2</c>, or <c>bob</c> and <c>alice</c> to view <c>photo1</c>, are valid batches. <para> The request is evaluated against all policies in the specified policy store that match the entities that you declare. The result of the decisions is a series of <c>Allow</c> or <c>Deny</c> responses, along with the IDs of the policies that produced each decision. </para><para> The <c>entities</c> of a <c>BatchIsAuthorized</c> API request can contain up to 100 principals and up to 100 resources. The <c>requests</c> of a <c>BatchIsAuthorized</c> API request can contain up to 30 requests. </para><note><para> The <c>BatchIsAuthorized</c> operation doesn't have its own IAM permission. To authorize this operation for Amazon Web Services principals, include the permission <c>verifiedpermissions:IsAuthorized</c> in their IAM policies. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPBatchAuthorizationCmdlet.Entities_EntityList"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPBatchAuthorizationCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store. Policies in this policy store will be used to make the authorization decisions for the input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPBatchAuthorizationCmdlet.Request"> <summary> <para> <para>An array of up to 30 requests that you want Verified Permissions to evaluate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPBatchAuthorizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Results'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.BatchIsAuthorizedResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.BatchIsAuthorizedResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPBatchAuthorizationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyStoreId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.TestAVPTokenAuthorizationCmdlet"> <summary> Makes an authorization decision about a service request described in the parameters. The principal in this request comes from an external identity source in the form of an identity token formatted as a <a href="https://wikipedia.org/wiki/JSON_Web_Token">JSON web token (JWT)</a>. The information in the parameters can also define additional context that Verified Permissions can include in the evaluation. The request is evaluated against all matching policies in the specified policy store. The result of the decision is either <c>Allow</c> or <c>Deny</c>, along with a list of the policies that resulted in the decision. <para> At this time, Verified Permissions accepts tokens from only Amazon Cognito. </para><para> Verified Permissions validates each token that is specified in a request by checking its expiration date and its signature. </para><important><para> If you delete a Amazon Cognito user pool or user, tokens from that deleted pool or that deleted user continue to be usable until they expire. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPTokenAuthorizationCmdlet.AccessToken"> <summary> <para> <para>Specifies an access token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an <c>accessToken</c>, an <c>identityToken</c>, or both.</para><para>Must be an access token. Verified Permissions returns an error if the <c>token_use</c> claim in the submitted token isn't <c>access</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPTokenAuthorizationCmdlet.Action_ActionId"> <summary> <para> <para>The ID of an action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPTokenAuthorizationCmdlet.Action_ActionType"> <summary> <para> <para>The type of an action.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPTokenAuthorizationCmdlet.Context_ContextMap"> <summary> <para> <para>An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.</para><para>Example: <c>"contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPTokenAuthorizationCmdlet.Resource_EntityId"> <summary> <para> <para>The identifier of an entity.</para><para><c>"entityId":"<i>identifier</i>"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPTokenAuthorizationCmdlet.Entities_EntityList"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPTokenAuthorizationCmdlet.Resource_EntityType"> <summary> <para> <para>The type of an entity.</para><para>Example: <c>"entityType":"<i>typeName</i>"</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPTokenAuthorizationCmdlet.IdentityToken"> <summary> <para> <para>Specifies an identity token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an <c>accessToken</c>, an <c>identityToken</c>, or both.</para><para>Must be an ID token. Verified Permissions returns an error if the <c>token_use</c> claim in the submitted token isn't <c>id</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPTokenAuthorizationCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPTokenAuthorizationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.IsAuthorizedWithTokenResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.IsAuthorizedWithTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.TestAVPTokenAuthorizationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyStoreId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPIdentitySourceCmdlet"> <summary> Updates the specified identity source to use a new identity provider (IdP) source, or to change the mapping of identities from the IdP to a different principal entity type. <note><para> Verified Permissions is <i><a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a></i>. It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPIdentitySourceCmdlet.CognitoUserPoolConfiguration_ClientId"> <summary> <para> <para>The client ID of an app client that is configured for the specified Amazon Cognito user pool.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPIdentitySourceCmdlet.GroupConfiguration_GroupEntityType"> <summary> <para> <para>The name of the schema entity type that's mapped to the user pool group. Defaults to <c>AWS::CognitoGroup</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPIdentitySourceCmdlet.IdentitySourceId"> <summary> <para> <para>Specifies the ID of the identity source that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPIdentitySourceCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store that contains the identity source that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPIdentitySourceCmdlet.PrincipalEntityType"> <summary> <para> <para>Specifies the data type of principals generated for identities authenticated by the identity source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPIdentitySourceCmdlet.CognitoUserPoolConfiguration_UserPoolArn"> <summary> <para> <para>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Name (ARN)</a> of the Amazon Cognito user pool associated with this identity source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPIdentitySourceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.UpdateIdentitySourceResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.UpdateIdentitySourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPIdentitySourceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyCmdlet"> <summary> Modifies a Cedar static policy in the specified policy store. You can change only certain elements of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyInput.html#amazonverifiedpermissions-UpdatePolicy-request-UpdatePolicyDefinition">UpdatePolicyDefinition</a> parameter. You can directly update only static policies. To change a template-linked policy, you must update the template instead, using <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyTemplate.html">UpdatePolicyTemplate</a>. <note><ul><li><para> If policy validation is enabled in the policy store, then updating a static policy causes Verified Permissions to validate the policy against the schema in the policy store. If the updated static policy doesn't pass validation, the operation fails and the update isn't stored. </para></li><li><para> When you edit a static policy, you can change only certain elements of a static policy: </para><ul><li><para> The action referenced by the policy. </para></li><li><para> A condition clause, such as when and unless. </para></li></ul><para> You can't change these elements of a static policy: </para><ul><li><para> Changing a policy from a static policy to a template-linked policy. </para></li><li><para> Changing the effect of a static policy from permit or forbid. </para></li><li><para> The principal referenced by a static policy. </para></li><li><para> The resource referenced by a static policy. </para></li></ul></li><li><para> To update a template-linked policy, you must update the template instead. </para></li></ul></note><note><para> Verified Permissions is <i><a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a></i>. It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyCmdlet.Static_Description"> <summary> <para> <para>Specifies the description to be added to or replaced on the static policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyCmdlet.PolicyId"> <summary> <para> <para>Specifies the ID of the policy that you want to update. To find this value, you can use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicies.html">ListPolicies</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store that contains the policy that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyCmdlet.Static_Statement"> <summary> <para> <para>Specifies the Cedar policy language text to be added to or replaced on the static policy.</para><important><para>You can change only the following elements from the original content:</para><ul><li><para>The <c>action</c> referenced by the policy.</para></li><li><para>Any conditional clauses, such as <c>when</c> or <c>unless</c> clauses.</para></li></ul><para>You <b>can't</b> change the following elements:</para><ul><li><para>Changing from <c>StaticPolicy</c> to <c>TemplateLinkedPolicy</c>.</para></li><li><para>The effect (<c>permit</c> or <c>forbid</c>) of the policy.</para></li><li><para>The <c>principal</c> referenced by the policy.</para></li><li><para>The <c>resource</c> referenced by the policy.</para></li></ul></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.UpdatePolicyResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.UpdatePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyStoreCmdlet"> <summary> Modifies the validation setting for a policy store. <note><para> Verified Permissions is <i><a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a></i>. It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyStoreCmdlet.Description"> <summary> <para> <para>Descriptive text that you can provide to help with identification of the current policy store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyStoreCmdlet.ValidationSettings_Mode"> <summary> <para> <para>The validation mode currently configured for this policy store. The valid values are:</para><ul><li><para><b>OFF</b> – Neither Verified Permissions nor Cedar perform any validation on policies. No validation errors are reported by either service.</para></li><li><para><b>STRICT</b> – Requires a schema to be present in the policy store. Cedar performs validation on all submitted new or updated static policies and policy templates. Any that fail validation are rejected and Cedar doesn't store them in the policy store.</para></li></ul><important><para>If <c>Mode=STRICT</c> and the policy store doesn't contain a schema, Verified Permissions rejects all static policies and policy templates because there is no schema to validate against. </para><para>To submit a static policy or policy template without a schema, you must turn off validation.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyStoreCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store that you want to update</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyStoreCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.UpdatePolicyStoreResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.UpdatePolicyStoreResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyStoreCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyStoreId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyStoreCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyTemplateCmdlet"> <summary> Updates the specified policy template. You can update only the description and the some elements of the <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_UpdatePolicyTemplate.html#amazonverifiedpermissions-UpdatePolicyTemplate-request-policyBody">policyBody</a>. <important><para> Changes you make to the policy template content are immediately (within the constraints of eventual consistency) reflected in authorization decisions that involve all template-linked policies instantiated from this template. </para></important><note><para> Verified Permissions is <i><a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a></i>. It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyTemplateCmdlet.Description"> <summary> <para> <para>Specifies a new description to apply to the policy template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyTemplateCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store that contains the policy template that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyTemplateCmdlet.PolicyTemplateId"> <summary> <para> <para>Specifies the ID of the policy template that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyTemplateCmdlet.Statement"> <summary> <para> <para>Specifies new statement content written in Cedar policy language to replace the current body of the policy template.</para><para>You can change only the following elements of the policy body:</para><ul><li><para>The <c>action</c> referenced by the policy template.</para></li><li><para>Any conditional clauses, such as <c>when</c> or <c>unless</c> clauses.</para></li></ul><para>You <b>can't</b> change the following elements:</para><ul><li><para>The effect (<c>permit</c> or <c>forbid</c>) of the policy template.</para></li><li><para>The <c>principal</c> referenced by the policy template.</para></li><li><para>The <c>resource</c> referenced by the policy template.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.UpdatePolicyTemplateResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.UpdatePolicyTemplateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.UpdateAVPPolicyTemplateCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.AVP.WriteAVPSchemaCmdlet"> <summary> Creates or updates the policy schema in the specified policy store. The schema is used to validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema validate only policies and templates submitted after the schema change. Existing policies and templates are not re-evaluated against the changed schema. If you later update a policy, then it is evaluated against the new schema at that time. <note><para> Verified Permissions is <i><a href="https://wikipedia.org/wiki/Eventual_consistency">eventually consistent</a></i>. It can take a few seconds for a new or changed element to propagate through the service and be visible in the results of other Verified Permissions operations. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.WriteAVPSchemaCmdlet.Definition_CedarJson"> <summary> <para> <para>A JSON string representation of the schema supported by applications that use this policy store. For more information, see <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/userguide/schema.html">Policy store schema</a> in the <i>Amazon Verified Permissions User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.WriteAVPSchemaCmdlet.PolicyStoreId"> <summary> <para> <para>Specifies the ID of the policy store in which to place the schema.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.WriteAVPSchemaCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.VerifiedPermissions.Model.PutSchemaResponse). Specifying the name of a property of type Amazon.VerifiedPermissions.Model.PutSchemaResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.WriteAVPSchemaCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PolicyStoreId parameter. The -PassThru parameter is deprecated, use -Select '^PolicyStoreId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.AVP.WriteAVPSchemaCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |