update_identity_source ¶

def update_identity_source(
    self,
    policy_store_id: "capo_verifiedpermissions.types.policy_store_id.PolicyStoreId",
    identity_source_id: "capo_verifiedpermissions.types.identity_source_id.IdentitySourceId",
    update_configuration: "capo_verifiedpermissions.types.update_configuration.UpdateConfiguration",
    *,
    config_overrides: Optional[VerifiedPermissionsClientConfig] = None,
    principal_entity_type: Optional[
        "capo_verifiedpermissions.types.principal_entity_type.PrincipalEntityType"
    ] = None,
) -> "capo_verifiedpermissions.types.update_identity_source_output.UpdateIdentitySourceOutput":
    """<p>Updates the specified identity source to use a new identity provider (IdP), or to change the mapping of identities from the IdP to a different principal entity type.</p> <note> <p>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.</p> </note>

    Args:
        policy_store_id: <p>Specifies the ID of the policy store that contains the identity source that you want to update.</p> <p>To specify a policy store, use its ID or alias name. When using an alias name, prefix it with <code>policy-store-alias/</code>. For example:</p> <ul> <li> <p>ID: <code>PSEXAMPLEabcdefg111111</code> </p> </li> <li> <p>Alias name: <code>policy-store-alias/example-policy-store</code> </p> </li> </ul> <p>To view aliases, use <a href="https://docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_ListPolicyStoreAliases.html">ListPolicyStoreAliases</a>.</p>
        identity_source_id: <p>Specifies the ID of the identity source that you want to update.</p>
        update_configuration: <p>Specifies the details required to communicate with the identity provider (IdP) associated with this identity source.</p>
        principal_entity_type: <p>Specifies the data type of principals generated for identities authenticated by the identity source.</p>

    Raises:
        capo_verifiedpermissions.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action.</p>
        capo_verifiedpermissions.errors.internal_server_exception.InternalServerException: <p>The request failed because of an internal error. Try your request again later</p>
        capo_verifiedpermissions.errors.throttling_exception.ThrottlingException: <p>The request failed because it exceeded a throttling quota.</p>
        capo_verifiedpermissions.errors.validation_exception.ValidationException: <p>The request failed because one or more input parameters don't satisfy their constraint requirements. The output is provided as a list of fields and a reason for each field that isn't valid.</p> <p>The possible reasons include the following:</p> <ul> <li> <p> <b>UnrecognizedEntityType</b> </p> <p>The policy includes an entity type that isn't found in the schema.</p> </li> <li> <p> <b>UnrecognizedActionId</b> </p> <p>The policy includes an action id that isn't found in the schema.</p> </li> <li> <p> <b>InvalidActionApplication</b> </p> <p>The policy includes an action that, according to the schema, doesn't support the specified principal and resource.</p> </li> <li> <p> <b>UnexpectedType</b> </p> <p>The policy included an operand that isn't a valid type for the specified operation.</p> </li> <li> <p> <b>IncompatibleTypes</b> </p> <p>The types of elements included in a <code>set</code>, or the types of expressions used in an <code>if...then...else</code> clause aren't compatible in this context.</p> </li> <li> <p> <b>MissingAttribute</b> </p> <p>The policy attempts to access a record or entity attribute that isn't specified in the schema. Test for the existence of the attribute first before attempting to access its value. For more information, see the <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the <i>Cedar Policy Language Guide</i>.</p> </li> <li> <p> <b>UnsafeOptionalAttributeAccess</b> </p> <p>The policy attempts to access a record or entity attribute that is optional and isn't guaranteed to be present. Test for the existence of the attribute first before attempting to access its value. For more information, see the <a href="https://docs.cedarpolicy.com/policies/syntax-operators.html#has-presence-of-attribute-test">has (presence of attribute test) operator</a> in the <i>Cedar Policy Language Guide</i>.</p> </li> <li> <p> <b>ImpossiblePolicy</b> </p> <p>Cedar has determined that a policy condition always evaluates to false. If the policy is always false, it can never apply to any query, and so it can never affect an authorization decision.</p> </li> <li> <p> <b>WrongNumberArguments</b> </p> <p>The policy references an extension type with the wrong number of arguments.</p> </li> <li> <p> <b>FunctionArgumentValidationError</b> </p> <p>Cedar couldn't parse the argument passed to an extension type. For example, a string that is to be parsed as an IPv4 address can contain only digits and the period character.</p> </li> </ul>
        capo_verifiedpermissions.errors.conflict_exception.ConflictException: <p>The request failed because another request to modify a resource occurred at the same time.</p>
        capo_verifiedpermissions.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request failed because it references a resource that doesn't exist.</p>
        capo_verifiedpermissions.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        UpdateIdentitySource
        The following example updates the configuration of the specified identity source with a new configuration.

        >>> client.update_identity_source(identity_source_id='ISEXAMPLEabcdefg111111', policy_store_id='C7v5xMplfFH3i3e4Jrzb1a', update_configuration={'cognitoUserPoolConfiguration': {'userPoolArn': 'arn:aws:cognito-idp:us-east-1:123456789012:userpool/us-east-1_1a2b3c4d5', 'clientIds': ['a1b2c3d4e5f6g7h8i9j0kalbmc']}})
    """

    def _handler(
        req: "OperationRequest[capo_verifiedpermissions.types.update_identity_source_input.UpdateIdentitySourceInput]",
    ) -> OperationResponse[
        "capo_verifiedpermissions.types.update_identity_source_output.UpdateIdentitySourceOutput"
    ]:
        import capo_verifiedpermissions._operations.verified_permissions.update_identity_source

        output, http_response = (
            capo_verifiedpermissions._operations.verified_permissions.update_identity_source.update_identity_source(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_verifiedpermissions.types.update_identity_source_input.UpdateIdentitySourceInput",
    ) -> dict[str, Any]:
        import capo_verifiedpermissions.types.update_identity_source_input

        return capo_verifiedpermissions.types.update_identity_source_input.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateIdentitySource", redact_input=_redact_input),
    )
    input_: capo_verifiedpermissions.types.update_identity_source_input.UpdateIdentitySourceInput = {
        "policy_store_id": policy_store_id,
        "identity_source_id": identity_source_id,
        "update_configuration": update_configuration,
    }
    if principal_entity_type is not None:
        input_["principal_entity_type"] = principal_entity_type

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output